purecloud-platform-client-v2 236.0.0 → 237.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 (94) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +454 -86
  3. package/dist/web-amd/purecloud-platform-client-v2.js +454 -86
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +188 -87
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +188 -87
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +538 -337
  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/AIStudioApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -3
  27. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LearningApi.js +27 -1
  49. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +294 -0
  87. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +51 -1
  94. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
745
745
 
746
746
  /**
747
747
  * @module purecloud-platform-client-v2/ApiClient
748
- * @version 236.0.0
748
+ * @version 237.0.0
749
749
  */
750
750
  class ApiClient {
751
751
  /**
@@ -2358,7 +2358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2358
2358
  /**
2359
2359
  * AIStudio service.
2360
2360
  * @module purecloud-platform-client-v2/api/AIStudioApi
2361
- * @version 236.0.0
2361
+ * @version 237.0.0
2362
2362
  */
2363
2363
 
2364
2364
  /**
@@ -2930,7 +2930,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2930
2930
  /**
2931
2931
  * AgentAssistants service.
2932
2932
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
2933
- * @version 236.0.0
2933
+ * @version 237.0.0
2934
2934
  */
2935
2935
 
2936
2936
  /**
@@ -3416,7 +3416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3416
3416
  /**
3417
3417
  * AgentCopilot service.
3418
3418
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
3419
- * @version 236.0.0
3419
+ * @version 237.0.0
3420
3420
  */
3421
3421
 
3422
3422
  /**
@@ -3516,7 +3516,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3516
3516
  /**
3517
3517
  * AgentUI service.
3518
3518
  * @module purecloud-platform-client-v2/api/AgentUIApi
3519
- * @version 236.0.0
3519
+ * @version 237.0.0
3520
3520
  */
3521
3521
 
3522
3522
  /**
@@ -3647,7 +3647,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3647
3647
  /**
3648
3648
  * Alerting service.
3649
3649
  * @module purecloud-platform-client-v2/api/AlertingApi
3650
- * @version 236.0.0
3650
+ * @version 237.0.0
3651
3651
  */
3652
3652
 
3653
3653
  /**
@@ -4048,7 +4048,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4048
4048
  /**
4049
4049
  * Analytics service.
4050
4050
  * @module purecloud-platform-client-v2/api/AnalyticsApi
4051
- * @version 236.0.0
4051
+ * @version 237.0.0
4052
4052
  */
4053
4053
 
4054
4054
  /**
@@ -7316,7 +7316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7316
7316
  /**
7317
7317
  * Architect service.
7318
7318
  * @module purecloud-platform-client-v2/api/ArchitectApi
7319
- * @version 236.0.0
7319
+ * @version 237.0.0
7320
7320
  */
7321
7321
 
7322
7322
  /**
@@ -11611,7 +11611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11611
11611
  /**
11612
11612
  * Audit service.
11613
11613
  * @module purecloud-platform-client-v2/api/AuditApi
11614
- * @version 236.0.0
11614
+ * @version 237.0.0
11615
11615
  */
11616
11616
 
11617
11617
  /**
@@ -11812,7 +11812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11812
11812
  /**
11813
11813
  * Authorization service.
11814
11814
  * @module purecloud-platform-client-v2/api/AuthorizationApi
11815
- * @version 236.0.0
11815
+ * @version 237.0.0
11816
11816
  */
11817
11817
 
11818
11818
  /**
@@ -13527,7 +13527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13527
13527
  /**
13528
13528
  * Billing service.
13529
13529
  * @module purecloud-platform-client-v2/api/BillingApi
13530
- * @version 236.0.0
13530
+ * @version 237.0.0
13531
13531
  */
13532
13532
 
13533
13533
  /**
@@ -13783,7 +13783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13783
13783
  /**
13784
13784
  * BusinessRules service.
13785
13785
  * @module purecloud-platform-client-v2/api/BusinessRulesApi
13786
- * @version 236.0.0
13786
+ * @version 237.0.0
13787
13787
  */
13788
13788
 
13789
13789
  /**
@@ -14670,7 +14670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14670
14670
  /**
14671
14671
  * CarrierServices service.
14672
14672
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
14673
- * @version 236.0.0
14673
+ * @version 237.0.0
14674
14674
  */
14675
14675
 
14676
14676
  /**
@@ -14740,7 +14740,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14740
14740
  /**
14741
14741
  * Chat service.
14742
14742
  * @module purecloud-platform-client-v2/api/ChatApi
14743
- * @version 236.0.0
14743
+ * @version 237.0.0
14744
14744
  */
14745
14745
 
14746
14746
  /**
@@ -15721,7 +15721,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15721
15721
  /**
15722
15722
  * Coaching service.
15723
15723
  * @module purecloud-platform-client-v2/api/CoachingApi
15724
- * @version 236.0.0
15724
+ * @version 237.0.0
15725
15725
  */
15726
15726
 
15727
15727
  /**
@@ -16348,7 +16348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16348
16348
  /**
16349
16349
  * ContentManagement service.
16350
16350
  * @module purecloud-platform-client-v2/api/ContentManagementApi
16351
- * @version 236.0.0
16351
+ * @version 237.0.0
16352
16352
  */
16353
16353
 
16354
16354
  /**
@@ -17429,7 +17429,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17429
17429
  /**
17430
17430
  * Conversations service.
17431
17431
  * @module purecloud-platform-client-v2/api/ConversationsApi
17432
- * @version 236.0.0
17432
+ * @version 237.0.0
17433
17433
  */
17434
17434
 
17435
17435
  /**
@@ -20785,7 +20785,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20785
20785
  * Gets a record for a given meetingId
20786
20786
  *
20787
20787
  * @param {String} meetingId meetingId
20788
- * getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
20789
20788
  */
20790
20789
  getConversationsVideosMeeting(meetingId) {
20791
20790
  // verify the required parameter 'meetingId' is set
@@ -25310,7 +25309,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25310
25309
  * Generate a meetingId for a given conferenceId
25311
25310
  *
25312
25311
  * @param {Object} body MeetingIdRequest
25313
- * postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25314
25312
  */
25315
25313
  postConversationsVideosMeetings(body) {
25316
25314
  // verify the required parameter 'body' is set
@@ -26056,7 +26054,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26056
26054
  /**
26057
26055
  * DataExtensions service.
26058
26056
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
26059
- * @version 236.0.0
26057
+ * @version 237.0.0
26060
26058
  */
26061
26059
 
26062
26060
  /**
@@ -26142,7 +26140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26142
26140
  /**
26143
26141
  * DataPrivacy service.
26144
26142
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
26145
- * @version 236.0.0
26143
+ * @version 237.0.0
26146
26144
  */
26147
26145
 
26148
26146
  /**
@@ -26312,7 +26310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26312
26310
  /**
26313
26311
  * Downloads service.
26314
26312
  * @module purecloud-platform-client-v2/api/DownloadsApi
26315
- * @version 236.0.0
26313
+ * @version 237.0.0
26316
26314
  */
26317
26315
 
26318
26316
  /**
@@ -26364,7 +26362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26364
26362
  /**
26365
26363
  * Emails service.
26366
26364
  * @module purecloud-platform-client-v2/api/EmailsApi
26367
- * @version 236.0.0
26365
+ * @version 237.0.0
26368
26366
  */
26369
26367
 
26370
26368
  /**
@@ -26493,7 +26491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26493
26491
  /**
26494
26492
  * EmployeeEngagement service.
26495
26493
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
26496
- * @version 236.0.0
26494
+ * @version 237.0.0
26497
26495
  */
26498
26496
 
26499
26497
  /**
@@ -26644,7 +26642,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26644
26642
  /**
26645
26643
  * Events service.
26646
26644
  * @module purecloud-platform-client-v2/api/EventsApi
26647
- * @version 236.0.0
26645
+ * @version 237.0.0
26648
26646
  */
26649
26647
 
26650
26648
  /**
@@ -26740,7 +26738,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26740
26738
  /**
26741
26739
  * ExternalContacts service.
26742
26740
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
26743
- * @version 236.0.0
26741
+ * @version 237.0.0
26744
26742
  */
26745
26743
 
26746
26744
  /**
@@ -29987,7 +29985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29987
29985
  /**
29988
29986
  * Fax service.
29989
29987
  * @module purecloud-platform-client-v2/api/FaxApi
29990
- * @version 236.0.0
29988
+ * @version 237.0.0
29991
29989
  */
29992
29990
 
29993
29991
  /**
@@ -30202,7 +30200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30202
30200
  /**
30203
30201
  * Flows service.
30204
30202
  * @module purecloud-platform-client-v2/api/FlowsApi
30205
- * @version 236.0.0
30203
+ * @version 237.0.0
30206
30204
  */
30207
30205
 
30208
30206
  /**
@@ -30411,7 +30409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30411
30409
  /**
30412
30410
  * Gamification service.
30413
30411
  * @module purecloud-platform-client-v2/api/GamificationApi
30414
- * @version 236.0.0
30412
+ * @version 237.0.0
30415
30413
  */
30416
30414
 
30417
30415
  /**
@@ -32969,7 +32967,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32969
32967
  /**
32970
32968
  * GeneralDataProtectionRegulation service.
32971
32969
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
32972
- * @version 236.0.0
32970
+ * @version 237.0.0
32973
32971
  */
32974
32972
 
32975
32973
  /**
@@ -33099,7 +33097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33099
33097
  /**
33100
33098
  * Geolocation service.
33101
33099
  * @module purecloud-platform-client-v2/api/GeolocationApi
33102
- * @version 236.0.0
33100
+ * @version 237.0.0
33103
33101
  */
33104
33102
 
33105
33103
  /**
@@ -33230,7 +33228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33230
33228
  /**
33231
33229
  * Greetings service.
33232
33230
  * @module purecloud-platform-client-v2/api/GreetingsApi
33233
- * @version 236.0.0
33231
+ * @version 237.0.0
33234
33232
  */
33235
33233
 
33236
33234
  /**
@@ -33772,7 +33770,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33772
33770
  /**
33773
33771
  * Groups service.
33774
33772
  * @module purecloud-platform-client-v2/api/GroupsApi
33775
- * @version 236.0.0
33773
+ * @version 237.0.0
33776
33774
  */
33777
33775
 
33778
33776
  /**
@@ -34291,7 +34289,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34291
34289
  /**
34292
34290
  * IdentityProvider service.
34293
34291
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
34294
- * @version 236.0.0
34292
+ * @version 237.0.0
34295
34293
  */
34296
34294
 
34297
34295
  /**
@@ -35152,7 +35150,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35152
35150
  /**
35153
35151
  * InfrastructureAsCode service.
35154
35152
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
35155
- * @version 236.0.0
35153
+ * @version 237.0.0
35156
35154
  */
35157
35155
 
35158
35156
  /**
@@ -35319,7 +35317,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35319
35317
  /**
35320
35318
  * Integrations service.
35321
35319
  * @module purecloud-platform-client-v2/api/IntegrationsApi
35322
- * @version 236.0.0
35320
+ * @version 237.0.0
35323
35321
  */
35324
35322
 
35325
35323
  /**
@@ -37967,7 +37965,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37967
37965
  /**
37968
37966
  * Journey service.
37969
37967
  * @module purecloud-platform-client-v2/api/JourneyApi
37970
- * @version 236.0.0
37968
+ * @version 237.0.0
37971
37969
  */
37972
37970
 
37973
37971
  /**
@@ -40064,7 +40062,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40064
40062
  /**
40065
40063
  * Knowledge service.
40066
40064
  * @module purecloud-platform-client-v2/api/KnowledgeApi
40067
- * @version 236.0.0
40065
+ * @version 237.0.0
40068
40066
  */
40069
40067
 
40070
40068
  /**
@@ -43147,7 +43145,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43147
43145
  /**
43148
43146
  * LanguageUnderstanding service.
43149
43147
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
43150
- * @version 236.0.0
43148
+ * @version 237.0.0
43151
43149
  */
43152
43150
 
43153
43151
  /**
@@ -44366,7 +44364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44366
44364
  /**
44367
44365
  * Languages service.
44368
44366
  * @module purecloud-platform-client-v2/api/LanguagesApi
44369
- * @version 236.0.0
44367
+ * @version 237.0.0
44370
44368
  */
44371
44369
 
44372
44370
  /**
@@ -44588,7 +44586,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44588
44586
  /**
44589
44587
  * Learning service.
44590
44588
  * @module purecloud-platform-client-v2/api/LearningApi
44591
- * @version 236.0.0
44589
+ * @version 237.0.0
44592
44590
  */
44593
44591
 
44594
44592
  /**
@@ -45437,6 +45435,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45437
45435
  );
45438
45436
  }
45439
45437
 
45438
+ /**
45439
+ * Migrate a legacy learning module rule to a users rule.
45440
+ *
45441
+ * @param {String} moduleId The ID of the learning module
45442
+ * postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
45443
+ */
45444
+ postLearningModuleRuleMigrate(moduleId) {
45445
+ // verify the required parameter 'moduleId' is set
45446
+ if (moduleId === undefined || moduleId === null || moduleId === '') {
45447
+ throw 'Missing the required parameter "moduleId" when calling postLearningModuleRuleMigrate';
45448
+ }
45449
+
45450
+ return this.apiClient.callApi(
45451
+ '/api/v2/learning/modules/{moduleId}/rule/migrate',
45452
+ 'POST',
45453
+ { 'moduleId': moduleId },
45454
+ { },
45455
+ { },
45456
+ { },
45457
+ null,
45458
+ ['PureCloud OAuth'],
45459
+ ['application/json'],
45460
+ ['application/json']
45461
+ );
45462
+ }
45463
+
45440
45464
  /**
45441
45465
  * Create a new learning module
45442
45466
  * This will create a new unpublished learning module with the specified fields.
@@ -45671,7 +45695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45671
45695
  /**
45672
45696
  * License service.
45673
45697
  * @module purecloud-platform-client-v2/api/LicenseApi
45674
- * @version 236.0.0
45698
+ * @version 237.0.0
45675
45699
  */
45676
45700
 
45677
45701
  /**
@@ -45909,7 +45933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45909
45933
  /**
45910
45934
  * Locations service.
45911
45935
  * @module purecloud-platform-client-v2/api/LocationsApi
45912
- * @version 236.0.0
45936
+ * @version 237.0.0
45913
45937
  */
45914
45938
 
45915
45939
  /**
@@ -46145,7 +46169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46145
46169
  /**
46146
46170
  * LogCapture service.
46147
46171
  * @module purecloud-platform-client-v2/api/LogCaptureApi
46148
- * @version 236.0.0
46172
+ * @version 237.0.0
46149
46173
  */
46150
46174
 
46151
46175
  /**
@@ -46344,7 +46368,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46344
46368
  /**
46345
46369
  * Messaging service.
46346
46370
  * @module purecloud-platform-client-v2/api/MessagingApi
46347
- * @version 236.0.0
46371
+ * @version 237.0.0
46348
46372
  */
46349
46373
 
46350
46374
  /**
@@ -46703,7 +46727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46703
46727
  /**
46704
46728
  * MobileDevices service.
46705
46729
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
46706
- * @version 236.0.0
46730
+ * @version 237.0.0
46707
46731
  */
46708
46732
 
46709
46733
  /**
@@ -46854,7 +46878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46854
46878
  /**
46855
46879
  * Notifications service.
46856
46880
  * @module purecloud-platform-client-v2/api/NotificationsApi
46857
- * @version 236.0.0
46881
+ * @version 237.0.0
46858
46882
  */
46859
46883
 
46860
46884
  /**
@@ -47087,7 +47111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47087
47111
  /**
47088
47112
  * OAuth service.
47089
47113
  * @module purecloud-platform-client-v2/api/OAuthApi
47090
- * @version 236.0.0
47114
+ * @version 237.0.0
47091
47115
  */
47092
47116
 
47093
47117
  /**
@@ -47453,7 +47477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47453
47477
  /**
47454
47478
  * Objects service.
47455
47479
  * @module purecloud-platform-client-v2/api/ObjectsApi
47456
- * @version 236.0.0
47480
+ * @version 237.0.0
47457
47481
  */
47458
47482
 
47459
47483
  /**
@@ -47777,7 +47801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47777
47801
  /**
47778
47802
  * OperationalEvents service.
47779
47803
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
47780
- * @version 236.0.0
47804
+ * @version 237.0.0
47781
47805
  */
47782
47806
 
47783
47807
  /**
@@ -47894,7 +47918,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47894
47918
  /**
47895
47919
  * Organization service.
47896
47920
  * @module purecloud-platform-client-v2/api/OrganizationApi
47897
- * @version 236.0.0
47921
+ * @version 237.0.0
47898
47922
  */
47899
47923
 
47900
47924
  /**
@@ -48369,7 +48393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48369
48393
  /**
48370
48394
  * OrganizationAuthorization service.
48371
48395
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
48372
- * @version 236.0.0
48396
+ * @version 237.0.0
48373
48397
  */
48374
48398
 
48375
48399
  /**
@@ -49763,7 +49787,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49763
49787
  /**
49764
49788
  * Outbound service.
49765
49789
  * @module purecloud-platform-client-v2/api/OutboundApi
49766
- * @version 236.0.0
49790
+ * @version 237.0.0
49767
49791
  */
49768
49792
 
49769
49793
  /**
@@ -54510,7 +54534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54510
54534
  /**
54511
54535
  * Presence service.
54512
54536
  * @module purecloud-platform-client-v2/api/PresenceApi
54513
- * @version 236.0.0
54537
+ * @version 237.0.0
54514
54538
  */
54515
54539
 
54516
54540
  /**
@@ -55254,7 +55278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55254
55278
  /**
55255
55279
  * ProcessAutomation service.
55256
55280
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
55257
- * @version 236.0.0
55281
+ * @version 237.0.0
55258
55282
  */
55259
55283
 
55260
55284
  /**
@@ -55493,7 +55517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55493
55517
  /**
55494
55518
  * Quality service.
55495
55519
  * @module purecloud-platform-client-v2/api/QualityApi
55496
- * @version 236.0.0
55520
+ * @version 237.0.0
55497
55521
  */
55498
55522
 
55499
55523
  /**
@@ -57332,7 +57356,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57332
57356
  /**
57333
57357
  * Recording service.
57334
57358
  * @module purecloud-platform-client-v2/api/RecordingApi
57335
- * @version 236.0.0
57359
+ * @version 237.0.0
57336
57360
  */
57337
57361
 
57338
57362
  /**
@@ -58937,7 +58961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58937
58961
  /**
58938
58962
  * ResponseManagement service.
58939
58963
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
58940
- * @version 236.0.0
58964
+ * @version 237.0.0
58941
58965
  */
58942
58966
 
58943
58967
  /**
@@ -59447,7 +59471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59447
59471
  /**
59448
59472
  * Routing service.
59449
59473
  * @module purecloud-platform-client-v2/api/RoutingApi
59450
- * @version 236.0.0
59474
+ * @version 237.0.0
59451
59475
  */
59452
59476
 
59453
59477
  /**
@@ -63930,7 +63954,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63930
63954
  /**
63931
63955
  * SCIM service.
63932
63956
  * @module purecloud-platform-client-v2/api/SCIMApi
63933
- * @version 236.0.0
63957
+ * @version 237.0.0
63934
63958
  */
63935
63959
 
63936
63960
  /**
@@ -64807,7 +64831,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64807
64831
  /**
64808
64832
  * ScreenRecording service.
64809
64833
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
64810
- * @version 236.0.0
64834
+ * @version 237.0.0
64811
64835
  */
64812
64836
 
64813
64837
  /**
@@ -64852,7 +64876,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64852
64876
  /**
64853
64877
  * Scripts service.
64854
64878
  * @module purecloud-platform-client-v2/api/ScriptsApi
64855
- * @version 236.0.0
64879
+ * @version 237.0.0
64856
64880
  */
64857
64881
 
64858
64882
  /**
@@ -65328,7 +65352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65328
65352
  /**
65329
65353
  * Search service.
65330
65354
  * @module purecloud-platform-client-v2/api/SearchApi
65331
- * @version 236.0.0
65355
+ * @version 237.0.0
65332
65356
  */
65333
65357
 
65334
65358
  /**
@@ -66016,7 +66040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66016
66040
  /**
66017
66041
  * Settings service.
66018
66042
  * @module purecloud-platform-client-v2/api/SettingsApi
66019
- * @version 236.0.0
66043
+ * @version 237.0.0
66020
66044
  */
66021
66045
 
66022
66046
  /**
@@ -66364,7 +66388,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66364
66388
  /**
66365
66389
  * SocialMedia service.
66366
66390
  * @module purecloud-platform-client-v2/api/SocialMediaApi
66367
- * @version 236.0.0
66391
+ * @version 237.0.0
66368
66392
  */
66369
66393
 
66370
66394
  /**
@@ -67959,7 +67983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67959
67983
  /**
67960
67984
  * SpeechTextAnalytics service.
67961
67985
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
67962
- * @version 236.0.0
67986
+ * @version 237.0.0
67963
67987
  */
67964
67988
 
67965
67989
  /**
@@ -69606,7 +69630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69606
69630
  /**
69607
69631
  * Stations service.
69608
69632
  * @module purecloud-platform-client-v2/api/StationsApi
69609
- * @version 236.0.0
69633
+ * @version 237.0.0
69610
69634
  */
69611
69635
 
69612
69636
  /**
@@ -69708,7 +69732,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69708
69732
  /**
69709
69733
  * Suggest service.
69710
69734
  * @module purecloud-platform-client-v2/api/SuggestApi
69711
- * @version 236.0.0
69735
+ * @version 237.0.0
69712
69736
  */
69713
69737
 
69714
69738
  /**
@@ -69847,7 +69871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69847
69871
  /**
69848
69872
  * TaskManagement service.
69849
69873
  * @module purecloud-platform-client-v2/api/TaskManagementApi
69850
- * @version 236.0.0
69874
+ * @version 237.0.0
69851
69875
  */
69852
69876
 
69853
69877
  /**
@@ -72009,7 +72033,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72009
72033
  /**
72010
72034
  * Teams service.
72011
72035
  * @module purecloud-platform-client-v2/api/TeamsApi
72012
- * @version 236.0.0
72036
+ * @version 237.0.0
72013
72037
  */
72014
72038
 
72015
72039
  /**
@@ -72314,7 +72338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72314
72338
  /**
72315
72339
  * Telephony service.
72316
72340
  * @module purecloud-platform-client-v2/api/TelephonyApi
72317
- * @version 236.0.0
72341
+ * @version 237.0.0
72318
72342
  */
72319
72343
 
72320
72344
  /**
@@ -72600,7 +72624,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72600
72624
  /**
72601
72625
  * TelephonyProvidersEdge service.
72602
72626
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
72603
- * @version 236.0.0
72627
+ * @version 237.0.0
72604
72628
  */
72605
72629
 
72606
72630
  /**
@@ -76093,7 +76117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76093
76117
  /**
76094
76118
  * Textbots service.
76095
76119
  * @module purecloud-platform-client-v2/api/TextbotsApi
76096
- * @version 236.0.0
76120
+ * @version 237.0.0
76097
76121
  */
76098
76122
 
76099
76123
  /**
@@ -76222,7 +76246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76222
76246
  /**
76223
76247
  * Tokens service.
76224
76248
  * @module purecloud-platform-client-v2/api/TokensApi
76225
- * @version 236.0.0
76249
+ * @version 237.0.0
76226
76250
  */
76227
76251
 
76228
76252
  /**
@@ -76376,7 +76400,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76376
76400
  /**
76377
76401
  * Uploads service.
76378
76402
  * @module purecloud-platform-client-v2/api/UploadsApi
76379
- * @version 236.0.0
76403
+ * @version 237.0.0
76380
76404
  */
76381
76405
 
76382
76406
  /**
@@ -76667,7 +76691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76667
76691
  /**
76668
76692
  * Usage service.
76669
76693
  * @module purecloud-platform-client-v2/api/UsageApi
76670
- * @version 236.0.0
76694
+ * @version 237.0.0
76671
76695
  */
76672
76696
 
76673
76697
  /**
@@ -77002,7 +77026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
77002
77026
  /**
77003
77027
  * UserRecordings service.
77004
77028
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
77005
- * @version 236.0.0
77029
+ * @version 237.0.0
77006
77030
  */
77007
77031
 
77008
77032
  /**
@@ -77186,7 +77210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
77186
77210
  /**
77187
77211
  * Users service.
77188
77212
  * @module purecloud-platform-client-v2/api/UsersApi
77189
- * @version 236.0.0
77213
+ * @version 237.0.0
77190
77214
  */
77191
77215
 
77192
77216
  /**
@@ -80191,11 +80215,300 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
80191
80215
 
80192
80216
  }
80193
80217
 
80218
+ class UsersRulesApi {
80219
+ /**
80220
+ * UsersRules service.
80221
+ * @module purecloud-platform-client-v2/api/UsersRulesApi
80222
+ * @version 237.0.0
80223
+ */
80224
+
80225
+ /**
80226
+ * Constructs a new UsersRulesApi.
80227
+ * @alias module:purecloud-platform-client-v2/api/UsersRulesApi
80228
+ * @class
80229
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
80230
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
80231
+ */
80232
+ constructor(apiClient) {
80233
+ this.apiClient = apiClient || ApiClient.instance;
80234
+ }
80235
+
80236
+
80237
+ /**
80238
+ * Delete an existing users rule
80239
+ *
80240
+ * @param {String} ruleId The id of the rule
80241
+ * deleteUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80242
+ */
80243
+ deleteUsersRule(ruleId) {
80244
+ // verify the required parameter 'ruleId' is set
80245
+ if (ruleId === undefined || ruleId === null || ruleId === '') {
80246
+ throw 'Missing the required parameter "ruleId" when calling deleteUsersRule';
80247
+ }
80248
+
80249
+ return this.apiClient.callApi(
80250
+ '/api/v2/users/rules/{ruleId}',
80251
+ 'DELETE',
80252
+ { 'ruleId': ruleId },
80253
+ { },
80254
+ { },
80255
+ { },
80256
+ null,
80257
+ ['PureCloud OAuth'],
80258
+ ['application/json'],
80259
+ ['application/json']
80260
+ );
80261
+ }
80262
+
80263
+ /**
80264
+ * Get a users rule
80265
+ *
80266
+ * @param {String} ruleId The ID of the rule to retrieve
80267
+ * getUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80268
+ */
80269
+ getUsersRule(ruleId) {
80270
+ // verify the required parameter 'ruleId' is set
80271
+ if (ruleId === undefined || ruleId === null || ruleId === '') {
80272
+ throw 'Missing the required parameter "ruleId" when calling getUsersRule';
80273
+ }
80274
+
80275
+ return this.apiClient.callApi(
80276
+ '/api/v2/users/rules/{ruleId}',
80277
+ 'GET',
80278
+ { 'ruleId': ruleId },
80279
+ { },
80280
+ { },
80281
+ { },
80282
+ null,
80283
+ ['PureCloud OAuth'],
80284
+ ['application/json'],
80285
+ ['application/json']
80286
+ );
80287
+ }
80288
+
80289
+ /**
80290
+ * Get dependent of a users rule
80291
+ *
80292
+ * @param {String} ruleId The ID of the rule for which to retrieve dependents
80293
+ * @param {Object} ruleType The type of the dependent
80294
+ * @param {String} typeId The type ID of the dependent
80295
+ * getUsersRuleDependentTypeId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80296
+ */
80297
+ getUsersRuleDependentTypeId(ruleId, ruleType, typeId) {
80298
+ // verify the required parameter 'ruleId' is set
80299
+ if (ruleId === undefined || ruleId === null || ruleId === '') {
80300
+ throw 'Missing the required parameter "ruleId" when calling getUsersRuleDependentTypeId';
80301
+ }
80302
+ // verify the required parameter 'ruleType' is set
80303
+ if (ruleType === undefined || ruleType === null || ruleType === '') {
80304
+ throw 'Missing the required parameter "ruleType" when calling getUsersRuleDependentTypeId';
80305
+ }
80306
+ // verify the required parameter 'typeId' is set
80307
+ if (typeId === undefined || typeId === null || typeId === '') {
80308
+ throw 'Missing the required parameter "typeId" when calling getUsersRuleDependentTypeId';
80309
+ }
80310
+
80311
+ return this.apiClient.callApi(
80312
+ '/api/v2/users/rules/{ruleId}/dependents/{ruleType}/{typeId}',
80313
+ 'GET',
80314
+ { 'ruleId': ruleId,'ruleType': ruleType,'typeId': typeId },
80315
+ { },
80316
+ { },
80317
+ { },
80318
+ null,
80319
+ ['PureCloud OAuth'],
80320
+ ['application/json'],
80321
+ ['application/json']
80322
+ );
80323
+ }
80324
+
80325
+ /**
80326
+ * Get dependents for a users rule
80327
+ *
80328
+ * @param {String} ruleId The ID of the rule for which to retrieve dependents
80329
+ * @param {Object} opts Optional parameters
80330
+ * @param {Number} opts.pageSize Number of results per page (default to 25)
80331
+ * @param {Number} opts.pageNumber Page number (default to 1)
80332
+ * @param {Object} opts.sortOrder Sort order for dependents (by last run date, then created date) (default to descending)
80333
+ * getUsersRuleDependents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80334
+ */
80335
+ getUsersRuleDependents(ruleId, opts) {
80336
+ opts = opts || {};
80337
+
80338
+ // verify the required parameter 'ruleId' is set
80339
+ if (ruleId === undefined || ruleId === null || ruleId === '') {
80340
+ throw 'Missing the required parameter "ruleId" when calling getUsersRuleDependents';
80341
+ }
80342
+
80343
+ return this.apiClient.callApi(
80344
+ '/api/v2/users/rules/{ruleId}/dependents',
80345
+ 'GET',
80346
+ { 'ruleId': ruleId },
80347
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
80348
+ { },
80349
+ { },
80350
+ null,
80351
+ ['PureCloud OAuth'],
80352
+ ['application/json'],
80353
+ ['application/json']
80354
+ );
80355
+ }
80356
+
80357
+ /**
80358
+ * Get the list of users rules
80359
+ *
80360
+ * @param {Array.<String>} types The types of the rule
80361
+ * @param {Object} opts Optional parameters
80362
+ * @param {Number} opts.pageNumber Page number (default to 1)
80363
+ * @param {Number} opts.pageSize Number of results per page (default to 25)
80364
+ * @param {Array.<String>} opts.expand Fields to expand in response
80365
+ * @param {String} opts.searchTerm a search term for finding a rule by name
80366
+ * @param {Object} opts.sortOrder sort rules by name, ascending, descending (default to ascending)
80367
+ * getUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80368
+ */
80369
+ getUsersRules(types, opts) {
80370
+ opts = opts || {};
80371
+
80372
+ // verify the required parameter 'types' is set
80373
+ if (types === undefined || types === null) {
80374
+ throw 'Missing the required parameter "types" when calling getUsersRules';
80375
+ }
80376
+
80377
+ return this.apiClient.callApi(
80378
+ '/api/v2/users/rules',
80379
+ 'GET',
80380
+ { },
80381
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'types': this.apiClient.buildCollectionParam(types, 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'searchTerm': opts['searchTerm'],'sortOrder': opts['sortOrder'] },
80382
+ { },
80383
+ { },
80384
+ null,
80385
+ ['PureCloud OAuth'],
80386
+ ['application/json'],
80387
+ ['application/json']
80388
+ );
80389
+ }
80390
+
80391
+ /**
80392
+ * Get the settings for a specific users rule type
80393
+ *
80394
+ * @param {Object} ruleType The type of the rule
80395
+ * getUsersRulesSetting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80396
+ */
80397
+ getUsersRulesSetting(ruleType) {
80398
+ // verify the required parameter 'ruleType' is set
80399
+ if (ruleType === undefined || ruleType === null || ruleType === '') {
80400
+ throw 'Missing the required parameter "ruleType" when calling getUsersRulesSetting';
80401
+ }
80402
+
80403
+ return this.apiClient.callApi(
80404
+ '/api/v2/users/rules/settings/{ruleType}',
80405
+ 'GET',
80406
+ { 'ruleType': ruleType },
80407
+ { },
80408
+ { },
80409
+ { },
80410
+ null,
80411
+ ['PureCloud OAuth'],
80412
+ ['application/json'],
80413
+ ['application/json']
80414
+ );
80415
+ }
80416
+
80417
+ /**
80418
+ * Update an existing users rule
80419
+ * This will update an existing users rule with the specified fields.
80420
+ * @param {String} ruleId The ID of the rule to update
80421
+ * @param {Object} body updateRuleRequest
80422
+ * patchUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80423
+ */
80424
+ patchUsersRule(ruleId, body) {
80425
+ // verify the required parameter 'ruleId' is set
80426
+ if (ruleId === undefined || ruleId === null || ruleId === '') {
80427
+ throw 'Missing the required parameter "ruleId" when calling patchUsersRule';
80428
+ }
80429
+ // verify the required parameter 'body' is set
80430
+ if (body === undefined || body === null) {
80431
+ throw 'Missing the required parameter "body" when calling patchUsersRule';
80432
+ }
80433
+
80434
+ return this.apiClient.callApi(
80435
+ '/api/v2/users/rules/{ruleId}',
80436
+ 'PATCH',
80437
+ { 'ruleId': ruleId },
80438
+ { },
80439
+ { },
80440
+ { },
80441
+ body,
80442
+ ['PureCloud OAuth'],
80443
+ ['application/json'],
80444
+ ['application/json']
80445
+ );
80446
+ }
80447
+
80448
+ /**
80449
+ * Create a new rule
80450
+ * This will create a new rule with the specified fields.
80451
+ * @param {Object} body usersRulesCreateRuleRequest
80452
+ * postUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80453
+ */
80454
+ postUsersRules(body) {
80455
+ // verify the required parameter 'body' is set
80456
+ if (body === undefined || body === null) {
80457
+ throw 'Missing the required parameter "body" when calling postUsersRules';
80458
+ }
80459
+
80460
+ return this.apiClient.callApi(
80461
+ '/api/v2/users/rules',
80462
+ 'POST',
80463
+ { },
80464
+ { },
80465
+ { },
80466
+ { },
80467
+ body,
80468
+ ['PureCloud OAuth'],
80469
+ ['application/json'],
80470
+ ['application/json']
80471
+ );
80472
+ }
80473
+
80474
+ /**
80475
+ * Query the result of a users rule
80476
+ * This will query the result of a rule.
80477
+ * @param {Object} body usersRulesQueryRuleRequest
80478
+ * @param {Object} opts Optional parameters
80479
+ * @param {Number} opts.pageNumber Page number (default to 1)
80480
+ * @param {Number} opts.pageSize Number of results per page (default to 25)
80481
+ * postUsersRulesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
80482
+ */
80483
+ postUsersRulesQuery(body, opts) {
80484
+ opts = opts || {};
80485
+
80486
+ // verify the required parameter 'body' is set
80487
+ if (body === undefined || body === null) {
80488
+ throw 'Missing the required parameter "body" when calling postUsersRulesQuery';
80489
+ }
80490
+
80491
+ return this.apiClient.callApi(
80492
+ '/api/v2/users/rules/query',
80493
+ 'POST',
80494
+ { },
80495
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
80496
+ { },
80497
+ { },
80498
+ body,
80499
+ ['PureCloud OAuth'],
80500
+ ['application/json'],
80501
+ ['application/json']
80502
+ );
80503
+ }
80504
+
80505
+ }
80506
+
80194
80507
  class UtilitiesApi {
80195
80508
  /**
80196
80509
  * Utilities service.
80197
80510
  * @module purecloud-platform-client-v2/api/UtilitiesApi
80198
- * @version 236.0.0
80511
+ * @version 237.0.0
80199
80512
  */
80200
80513
 
80201
80514
  /**
@@ -80306,7 +80619,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
80306
80619
  /**
80307
80620
  * Voicemail service.
80308
80621
  * @module purecloud-platform-client-v2/api/VoicemailApi
80309
- * @version 236.0.0
80622
+ * @version 237.0.0
80310
80623
  */
80311
80624
 
80312
80625
  /**
@@ -81028,7 +81341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
81028
81341
  /**
81029
81342
  * WebChat service.
81030
81343
  * @module purecloud-platform-client-v2/api/WebChatApi
81031
- * @version 236.0.0
81344
+ * @version 237.0.0
81032
81345
  */
81033
81346
 
81034
81347
  /**
@@ -81591,7 +81904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
81591
81904
  /**
81592
81905
  * WebDeployments service.
81593
81906
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
81594
- * @version 236.0.0
81907
+ * @version 237.0.0
81595
81908
  */
81596
81909
 
81597
81910
  /**
@@ -82173,7 +82486,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82173
82486
  /**
82174
82487
  * WebMessaging service.
82175
82488
  * @module purecloud-platform-client-v2/api/WebMessagingApi
82176
- * @version 236.0.0
82489
+ * @version 237.0.0
82177
82490
  */
82178
82491
 
82179
82492
  /**
@@ -82319,7 +82632,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82319
82632
  /**
82320
82633
  * Widgets service.
82321
82634
  * @module purecloud-platform-client-v2/api/WidgetsApi
82322
- * @version 236.0.0
82635
+ * @version 237.0.0
82323
82636
  */
82324
82637
 
82325
82638
  /**
@@ -82470,7 +82783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82470
82783
  /**
82471
82784
  * WorkforceManagement service.
82472
82785
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
82473
- * @version 236.0.0
82786
+ * @version 237.0.0
82474
82787
  */
82475
82788
 
82476
82789
  /**
@@ -83234,6 +83547,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
83234
83547
  );
83235
83548
  }
83236
83549
 
83550
+ /**
83551
+ * Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status
83552
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
83553
+ * @param {String} jobId ID of the job to get
83554
+ */
83555
+ getWorkforcemanagementAgentsMeAdherenceHistoricalJob(jobId) {
83556
+ // verify the required parameter 'jobId' is set
83557
+ if (jobId === undefined || jobId === null || jobId === '') {
83558
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAgentsMeAdherenceHistoricalJob';
83559
+ }
83560
+
83561
+ return this.apiClient.callApi(
83562
+ '/api/v2/workforcemanagement/agents/me/adherence/historical/jobs/{jobId}',
83563
+ 'GET',
83564
+ { 'jobId': jobId },
83565
+ { },
83566
+ { },
83567
+ { },
83568
+ null,
83569
+ ['PureCloud OAuth'],
83570
+ ['application/json'],
83571
+ ['application/json']
83572
+ );
83573
+ }
83574
+
83237
83575
  /**
83238
83576
  * Get the management unit to which the currently logged in agent belongs
83239
83577
  *
@@ -87582,6 +87920,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
87582
87920
  );
87583
87921
  }
87584
87922
 
87923
+ /**
87924
+ * Request an agent historical adherence report
87925
+ * The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities
87926
+ * @param {Object} opts Optional parameters
87927
+ * @param {Array.<String>} opts.expand Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities.
87928
+ * @param {Object} opts.body body
87929
+ */
87930
+ postWorkforcemanagementAgentsMeAdherenceHistoricalJobs(opts) {
87931
+ opts = opts || {};
87932
+
87933
+
87934
+ return this.apiClient.callApi(
87935
+ '/api/v2/workforcemanagement/agents/me/adherence/historical/jobs',
87936
+ 'POST',
87937
+ { },
87938
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
87939
+ { },
87940
+ { },
87941
+ opts['body'],
87942
+ ['PureCloud OAuth'],
87943
+ ['application/json'],
87944
+ ['application/json']
87945
+ );
87946
+ }
87947
+
87585
87948
  /**
87586
87949
  * Get agent possible work shifts for requested time frame
87587
87950
  *
@@ -90471,7 +90834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
90471
90834
  * </pre>
90472
90835
  * </p>
90473
90836
  * @module purecloud-platform-client-v2/index
90474
- * @version 236.0.0
90837
+ * @version 237.0.0
90475
90838
  */
90476
90839
  class platformClient {
90477
90840
  constructor() {
@@ -90860,6 +91223,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
90860
91223
  * @property {module:purecloud-platform-client-v2/api/UsersApi}
90861
91224
  */
90862
91225
  this.UsersApi = UsersApi;
91226
+ /**
91227
+ * The UsersRulesApi service constructor.
91228
+ * @property {module:purecloud-platform-client-v2/api/UsersRulesApi}
91229
+ */
91230
+ this.UsersRulesApi = UsersRulesApi;
90863
91231
  /**
90864
91232
  * The UtilitiesApi service constructor.
90865
91233
  * @property {module:purecloud-platform-client-v2/api/UtilitiesApi}