purecloud-platform-client-v2 235.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 +492 -88
  3. package/dist/web-amd/purecloud-platform-client-v2.js +492 -88
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +201 -89
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +201 -89
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +889 -596
  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 +2 -2
  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 +37 -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 +2 -2
  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 235.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 235.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 235.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 235.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 235.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 235.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 235.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 235.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 235.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 235.0.0
11815
+ * @version 237.0.0
11816
11816
  */
11817
11817
 
11818
11818
  /**
@@ -12109,7 +12109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12109
12109
  * @param {Object} opts Optional parameters
12110
12110
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
12111
12111
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
12112
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
12112
+ * @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
12113
12113
  * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
12114
12114
  * @param {String} opts.name Optionally request specific divisions by division name
12115
12115
  */
@@ -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 235.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 235.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 235.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 235.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 235.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 235.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 235.0.0
17432
+ * @version 237.0.0
17433
17433
  */
17434
17434
 
17435
17435
  /**
@@ -19510,6 +19510,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19510
19510
  );
19511
19511
  }
19512
19512
 
19513
+ /**
19514
+ * Get message media list by status
19515
+ *
19516
+ * @param {String} conversationId conversationId
19517
+ * @param {String} communicationId communicationId
19518
+ * @param {Object} opts Optional parameters
19519
+ * @param {Object} opts.status The status on which to filter the response.
19520
+ * @param {Number} opts.pageNumber Page number (default to 1)
19521
+ * @param {Number} opts.pageSize Page size (default to 25)
19522
+ */
19523
+ getConversationsMessageCommunicationMessagesMedia(conversationId, communicationId, opts) {
19524
+ opts = opts || {};
19525
+
19526
+ // verify the required parameter 'conversationId' is set
19527
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
19528
+ throw 'Missing the required parameter "conversationId" when calling getConversationsMessageCommunicationMessagesMedia';
19529
+ }
19530
+ // verify the required parameter 'communicationId' is set
19531
+ if (communicationId === undefined || communicationId === null || communicationId === '') {
19532
+ throw 'Missing the required parameter "communicationId" when calling getConversationsMessageCommunicationMessagesMedia';
19533
+ }
19534
+
19535
+ return this.apiClient.callApi(
19536
+ '/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media',
19537
+ 'GET',
19538
+ { 'conversationId': conversationId,'communicationId': communicationId },
19539
+ { 'status': opts['status'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
19540
+ { },
19541
+ { },
19542
+ null,
19543
+ ['PureCloud OAuth'],
19544
+ ['application/json'],
19545
+ ['application/json']
19546
+ );
19547
+ }
19548
+
19513
19549
  /**
19514
19550
  * Get media
19515
19551
  * See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
@@ -20749,7 +20785,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20749
20785
  * Gets a record for a given meetingId
20750
20786
  *
20751
20787
  * @param {String} meetingId meetingId
20752
- * getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
20753
20788
  */
20754
20789
  getConversationsVideosMeeting(meetingId) {
20755
20790
  // verify the required parameter 'meetingId' is set
@@ -25274,7 +25309,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25274
25309
  * Generate a meetingId for a given conferenceId
25275
25310
  *
25276
25311
  * @param {Object} body MeetingIdRequest
25277
- * postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25278
25312
  */
25279
25313
  postConversationsVideosMeetings(body) {
25280
25314
  // verify the required parameter 'body' is set
@@ -26020,7 +26054,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26020
26054
  /**
26021
26055
  * DataExtensions service.
26022
26056
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
26023
- * @version 235.0.0
26057
+ * @version 237.0.0
26024
26058
  */
26025
26059
 
26026
26060
  /**
@@ -26106,7 +26140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26106
26140
  /**
26107
26141
  * DataPrivacy service.
26108
26142
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
26109
- * @version 235.0.0
26143
+ * @version 237.0.0
26110
26144
  */
26111
26145
 
26112
26146
  /**
@@ -26276,7 +26310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26276
26310
  /**
26277
26311
  * Downloads service.
26278
26312
  * @module purecloud-platform-client-v2/api/DownloadsApi
26279
- * @version 235.0.0
26313
+ * @version 237.0.0
26280
26314
  */
26281
26315
 
26282
26316
  /**
@@ -26328,7 +26362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26328
26362
  /**
26329
26363
  * Emails service.
26330
26364
  * @module purecloud-platform-client-v2/api/EmailsApi
26331
- * @version 235.0.0
26365
+ * @version 237.0.0
26332
26366
  */
26333
26367
 
26334
26368
  /**
@@ -26457,7 +26491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26457
26491
  /**
26458
26492
  * EmployeeEngagement service.
26459
26493
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
26460
- * @version 235.0.0
26494
+ * @version 237.0.0
26461
26495
  */
26462
26496
 
26463
26497
  /**
@@ -26608,7 +26642,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26608
26642
  /**
26609
26643
  * Events service.
26610
26644
  * @module purecloud-platform-client-v2/api/EventsApi
26611
- * @version 235.0.0
26645
+ * @version 237.0.0
26612
26646
  */
26613
26647
 
26614
26648
  /**
@@ -26704,7 +26738,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26704
26738
  /**
26705
26739
  * ExternalContacts service.
26706
26740
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
26707
- * @version 235.0.0
26741
+ * @version 237.0.0
26708
26742
  */
26709
26743
 
26710
26744
  /**
@@ -29951,7 +29985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29951
29985
  /**
29952
29986
  * Fax service.
29953
29987
  * @module purecloud-platform-client-v2/api/FaxApi
29954
- * @version 235.0.0
29988
+ * @version 237.0.0
29955
29989
  */
29956
29990
 
29957
29991
  /**
@@ -30166,7 +30200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30166
30200
  /**
30167
30201
  * Flows service.
30168
30202
  * @module purecloud-platform-client-v2/api/FlowsApi
30169
- * @version 235.0.0
30203
+ * @version 237.0.0
30170
30204
  */
30171
30205
 
30172
30206
  /**
@@ -30375,7 +30409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30375
30409
  /**
30376
30410
  * Gamification service.
30377
30411
  * @module purecloud-platform-client-v2/api/GamificationApi
30378
- * @version 235.0.0
30412
+ * @version 237.0.0
30379
30413
  */
30380
30414
 
30381
30415
  /**
@@ -32933,7 +32967,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32933
32967
  /**
32934
32968
  * GeneralDataProtectionRegulation service.
32935
32969
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
32936
- * @version 235.0.0
32970
+ * @version 237.0.0
32937
32971
  */
32938
32972
 
32939
32973
  /**
@@ -33063,7 +33097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33063
33097
  /**
33064
33098
  * Geolocation service.
33065
33099
  * @module purecloud-platform-client-v2/api/GeolocationApi
33066
- * @version 235.0.0
33100
+ * @version 237.0.0
33067
33101
  */
33068
33102
 
33069
33103
  /**
@@ -33194,7 +33228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33194
33228
  /**
33195
33229
  * Greetings service.
33196
33230
  * @module purecloud-platform-client-v2/api/GreetingsApi
33197
- * @version 235.0.0
33231
+ * @version 237.0.0
33198
33232
  */
33199
33233
 
33200
33234
  /**
@@ -33736,7 +33770,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33736
33770
  /**
33737
33771
  * Groups service.
33738
33772
  * @module purecloud-platform-client-v2/api/GroupsApi
33739
- * @version 235.0.0
33773
+ * @version 237.0.0
33740
33774
  */
33741
33775
 
33742
33776
  /**
@@ -34255,7 +34289,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34255
34289
  /**
34256
34290
  * IdentityProvider service.
34257
34291
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
34258
- * @version 235.0.0
34292
+ * @version 237.0.0
34259
34293
  */
34260
34294
 
34261
34295
  /**
@@ -35116,7 +35150,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35116
35150
  /**
35117
35151
  * InfrastructureAsCode service.
35118
35152
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
35119
- * @version 235.0.0
35153
+ * @version 237.0.0
35120
35154
  */
35121
35155
 
35122
35156
  /**
@@ -35283,7 +35317,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35283
35317
  /**
35284
35318
  * Integrations service.
35285
35319
  * @module purecloud-platform-client-v2/api/IntegrationsApi
35286
- * @version 235.0.0
35320
+ * @version 237.0.0
35287
35321
  */
35288
35322
 
35289
35323
  /**
@@ -37931,7 +37965,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37931
37965
  /**
37932
37966
  * Journey service.
37933
37967
  * @module purecloud-platform-client-v2/api/JourneyApi
37934
- * @version 235.0.0
37968
+ * @version 237.0.0
37935
37969
  */
37936
37970
 
37937
37971
  /**
@@ -40028,7 +40062,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40028
40062
  /**
40029
40063
  * Knowledge service.
40030
40064
  * @module purecloud-platform-client-v2/api/KnowledgeApi
40031
- * @version 235.0.0
40065
+ * @version 237.0.0
40032
40066
  */
40033
40067
 
40034
40068
  /**
@@ -43111,7 +43145,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43111
43145
  /**
43112
43146
  * LanguageUnderstanding service.
43113
43147
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
43114
- * @version 235.0.0
43148
+ * @version 237.0.0
43115
43149
  */
43116
43150
 
43117
43151
  /**
@@ -44330,7 +44364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44330
44364
  /**
44331
44365
  * Languages service.
44332
44366
  * @module purecloud-platform-client-v2/api/LanguagesApi
44333
- * @version 235.0.0
44367
+ * @version 237.0.0
44334
44368
  */
44335
44369
 
44336
44370
  /**
@@ -44552,7 +44586,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44552
44586
  /**
44553
44587
  * Learning service.
44554
44588
  * @module purecloud-platform-client-v2/api/LearningApi
44555
- * @version 235.0.0
44589
+ * @version 237.0.0
44556
44590
  */
44557
44591
 
44558
44592
  /**
@@ -45401,6 +45435,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45401
45435
  );
45402
45436
  }
45403
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
+
45404
45464
  /**
45405
45465
  * Create a new learning module
45406
45466
  * This will create a new unpublished learning module with the specified fields.
@@ -45635,7 +45695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45635
45695
  /**
45636
45696
  * License service.
45637
45697
  * @module purecloud-platform-client-v2/api/LicenseApi
45638
- * @version 235.0.0
45698
+ * @version 237.0.0
45639
45699
  */
45640
45700
 
45641
45701
  /**
@@ -45873,7 +45933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45873
45933
  /**
45874
45934
  * Locations service.
45875
45935
  * @module purecloud-platform-client-v2/api/LocationsApi
45876
- * @version 235.0.0
45936
+ * @version 237.0.0
45877
45937
  */
45878
45938
 
45879
45939
  /**
@@ -46109,7 +46169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46109
46169
  /**
46110
46170
  * LogCapture service.
46111
46171
  * @module purecloud-platform-client-v2/api/LogCaptureApi
46112
- * @version 235.0.0
46172
+ * @version 237.0.0
46113
46173
  */
46114
46174
 
46115
46175
  /**
@@ -46308,7 +46368,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46308
46368
  /**
46309
46369
  * Messaging service.
46310
46370
  * @module purecloud-platform-client-v2/api/MessagingApi
46311
- * @version 235.0.0
46371
+ * @version 237.0.0
46312
46372
  */
46313
46373
 
46314
46374
  /**
@@ -46667,7 +46727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46667
46727
  /**
46668
46728
  * MobileDevices service.
46669
46729
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
46670
- * @version 235.0.0
46730
+ * @version 237.0.0
46671
46731
  */
46672
46732
 
46673
46733
  /**
@@ -46818,7 +46878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46818
46878
  /**
46819
46879
  * Notifications service.
46820
46880
  * @module purecloud-platform-client-v2/api/NotificationsApi
46821
- * @version 235.0.0
46881
+ * @version 237.0.0
46822
46882
  */
46823
46883
 
46824
46884
  /**
@@ -47051,7 +47111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47051
47111
  /**
47052
47112
  * OAuth service.
47053
47113
  * @module purecloud-platform-client-v2/api/OAuthApi
47054
- * @version 235.0.0
47114
+ * @version 237.0.0
47055
47115
  */
47056
47116
 
47057
47117
  /**
@@ -47417,7 +47477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47417
47477
  /**
47418
47478
  * Objects service.
47419
47479
  * @module purecloud-platform-client-v2/api/ObjectsApi
47420
- * @version 235.0.0
47480
+ * @version 237.0.0
47421
47481
  */
47422
47482
 
47423
47483
  /**
@@ -47593,7 +47653,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47593
47653
  * @param {Object} opts Optional parameters
47594
47654
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
47595
47655
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
47596
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
47656
+ * @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
47597
47657
  * @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
47598
47658
  * @param {String} opts.name Optionally request specific divisions by division name
47599
47659
  */
@@ -47741,7 +47801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47741
47801
  /**
47742
47802
  * OperationalEvents service.
47743
47803
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
47744
- * @version 235.0.0
47804
+ * @version 237.0.0
47745
47805
  */
47746
47806
 
47747
47807
  /**
@@ -47858,7 +47918,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47858
47918
  /**
47859
47919
  * Organization service.
47860
47920
  * @module purecloud-platform-client-v2/api/OrganizationApi
47861
- * @version 235.0.0
47921
+ * @version 237.0.0
47862
47922
  */
47863
47923
 
47864
47924
  /**
@@ -48333,7 +48393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48333
48393
  /**
48334
48394
  * OrganizationAuthorization service.
48335
48395
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
48336
- * @version 235.0.0
48396
+ * @version 237.0.0
48337
48397
  */
48338
48398
 
48339
48399
  /**
@@ -49727,7 +49787,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49727
49787
  /**
49728
49788
  * Outbound service.
49729
49789
  * @module purecloud-platform-client-v2/api/OutboundApi
49730
- * @version 235.0.0
49790
+ * @version 237.0.0
49731
49791
  */
49732
49792
 
49733
49793
  /**
@@ -54474,7 +54534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54474
54534
  /**
54475
54535
  * Presence service.
54476
54536
  * @module purecloud-platform-client-v2/api/PresenceApi
54477
- * @version 235.0.0
54537
+ * @version 237.0.0
54478
54538
  */
54479
54539
 
54480
54540
  /**
@@ -55218,7 +55278,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55218
55278
  /**
55219
55279
  * ProcessAutomation service.
55220
55280
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
55221
- * @version 235.0.0
55281
+ * @version 237.0.0
55222
55282
  */
55223
55283
 
55224
55284
  /**
@@ -55457,7 +55517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55457
55517
  /**
55458
55518
  * Quality service.
55459
55519
  * @module purecloud-platform-client-v2/api/QualityApi
55460
- * @version 235.0.0
55520
+ * @version 237.0.0
55461
55521
  */
55462
55522
 
55463
55523
  /**
@@ -57296,7 +57356,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57296
57356
  /**
57297
57357
  * Recording service.
57298
57358
  * @module purecloud-platform-client-v2/api/RecordingApi
57299
- * @version 235.0.0
57359
+ * @version 237.0.0
57300
57360
  */
57301
57361
 
57302
57362
  /**
@@ -58901,7 +58961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58901
58961
  /**
58902
58962
  * ResponseManagement service.
58903
58963
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
58904
- * @version 235.0.0
58964
+ * @version 237.0.0
58905
58965
  */
58906
58966
 
58907
58967
  /**
@@ -59411,7 +59471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59411
59471
  /**
59412
59472
  * Routing service.
59413
59473
  * @module purecloud-platform-client-v2/api/RoutingApi
59414
- * @version 235.0.0
59474
+ * @version 237.0.0
59415
59475
  */
59416
59476
 
59417
59477
  /**
@@ -63894,7 +63954,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63894
63954
  /**
63895
63955
  * SCIM service.
63896
63956
  * @module purecloud-platform-client-v2/api/SCIMApi
63897
- * @version 235.0.0
63957
+ * @version 237.0.0
63898
63958
  */
63899
63959
 
63900
63960
  /**
@@ -64771,7 +64831,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64771
64831
  /**
64772
64832
  * ScreenRecording service.
64773
64833
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
64774
- * @version 235.0.0
64834
+ * @version 237.0.0
64775
64835
  */
64776
64836
 
64777
64837
  /**
@@ -64816,7 +64876,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64816
64876
  /**
64817
64877
  * Scripts service.
64818
64878
  * @module purecloud-platform-client-v2/api/ScriptsApi
64819
- * @version 235.0.0
64879
+ * @version 237.0.0
64820
64880
  */
64821
64881
 
64822
64882
  /**
@@ -65292,7 +65352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65292
65352
  /**
65293
65353
  * Search service.
65294
65354
  * @module purecloud-platform-client-v2/api/SearchApi
65295
- * @version 235.0.0
65355
+ * @version 237.0.0
65296
65356
  */
65297
65357
 
65298
65358
  /**
@@ -65980,7 +66040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65980
66040
  /**
65981
66041
  * Settings service.
65982
66042
  * @module purecloud-platform-client-v2/api/SettingsApi
65983
- * @version 235.0.0
66043
+ * @version 237.0.0
65984
66044
  */
65985
66045
 
65986
66046
  /**
@@ -66328,7 +66388,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66328
66388
  /**
66329
66389
  * SocialMedia service.
66330
66390
  * @module purecloud-platform-client-v2/api/SocialMediaApi
66331
- * @version 235.0.0
66391
+ * @version 237.0.0
66332
66392
  */
66333
66393
 
66334
66394
  /**
@@ -67923,7 +67983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67923
67983
  /**
67924
67984
  * SpeechTextAnalytics service.
67925
67985
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
67926
- * @version 235.0.0
67986
+ * @version 237.0.0
67927
67987
  */
67928
67988
 
67929
67989
  /**
@@ -69570,7 +69630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69570
69630
  /**
69571
69631
  * Stations service.
69572
69632
  * @module purecloud-platform-client-v2/api/StationsApi
69573
- * @version 235.0.0
69633
+ * @version 237.0.0
69574
69634
  */
69575
69635
 
69576
69636
  /**
@@ -69672,7 +69732,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69672
69732
  /**
69673
69733
  * Suggest service.
69674
69734
  * @module purecloud-platform-client-v2/api/SuggestApi
69675
- * @version 235.0.0
69735
+ * @version 237.0.0
69676
69736
  */
69677
69737
 
69678
69738
  /**
@@ -69811,7 +69871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69811
69871
  /**
69812
69872
  * TaskManagement service.
69813
69873
  * @module purecloud-platform-client-v2/api/TaskManagementApi
69814
- * @version 235.0.0
69874
+ * @version 237.0.0
69815
69875
  */
69816
69876
 
69817
69877
  /**
@@ -71973,7 +72033,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71973
72033
  /**
71974
72034
  * Teams service.
71975
72035
  * @module purecloud-platform-client-v2/api/TeamsApi
71976
- * @version 235.0.0
72036
+ * @version 237.0.0
71977
72037
  */
71978
72038
 
71979
72039
  /**
@@ -72278,7 +72338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72278
72338
  /**
72279
72339
  * Telephony service.
72280
72340
  * @module purecloud-platform-client-v2/api/TelephonyApi
72281
- * @version 235.0.0
72341
+ * @version 237.0.0
72282
72342
  */
72283
72343
 
72284
72344
  /**
@@ -72564,7 +72624,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72564
72624
  /**
72565
72625
  * TelephonyProvidersEdge service.
72566
72626
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
72567
- * @version 235.0.0
72627
+ * @version 237.0.0
72568
72628
  */
72569
72629
 
72570
72630
  /**
@@ -76057,7 +76117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76057
76117
  /**
76058
76118
  * Textbots service.
76059
76119
  * @module purecloud-platform-client-v2/api/TextbotsApi
76060
- * @version 235.0.0
76120
+ * @version 237.0.0
76061
76121
  */
76062
76122
 
76063
76123
  /**
@@ -76186,7 +76246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76186
76246
  /**
76187
76247
  * Tokens service.
76188
76248
  * @module purecloud-platform-client-v2/api/TokensApi
76189
- * @version 235.0.0
76249
+ * @version 237.0.0
76190
76250
  */
76191
76251
 
76192
76252
  /**
@@ -76340,7 +76400,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76340
76400
  /**
76341
76401
  * Uploads service.
76342
76402
  * @module purecloud-platform-client-v2/api/UploadsApi
76343
- * @version 235.0.0
76403
+ * @version 237.0.0
76344
76404
  */
76345
76405
 
76346
76406
  /**
@@ -76631,7 +76691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76631
76691
  /**
76632
76692
  * Usage service.
76633
76693
  * @module purecloud-platform-client-v2/api/UsageApi
76634
- * @version 235.0.0
76694
+ * @version 237.0.0
76635
76695
  */
76636
76696
 
76637
76697
  /**
@@ -76966,7 +77026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76966
77026
  /**
76967
77027
  * UserRecordings service.
76968
77028
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
76969
- * @version 235.0.0
77029
+ * @version 237.0.0
76970
77030
  */
76971
77031
 
76972
77032
  /**
@@ -77150,7 +77210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
77150
77210
  /**
77151
77211
  * Users service.
77152
77212
  * @module purecloud-platform-client-v2/api/UsersApi
77153
- * @version 235.0.0
77213
+ * @version 237.0.0
77154
77214
  */
77155
77215
 
77156
77216
  /**
@@ -80155,11 +80215,300 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
80155
80215
 
80156
80216
  }
80157
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
+
80158
80507
  class UtilitiesApi {
80159
80508
  /**
80160
80509
  * Utilities service.
80161
80510
  * @module purecloud-platform-client-v2/api/UtilitiesApi
80162
- * @version 235.0.0
80511
+ * @version 237.0.0
80163
80512
  */
80164
80513
 
80165
80514
  /**
@@ -80270,7 +80619,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
80270
80619
  /**
80271
80620
  * Voicemail service.
80272
80621
  * @module purecloud-platform-client-v2/api/VoicemailApi
80273
- * @version 235.0.0
80622
+ * @version 237.0.0
80274
80623
  */
80275
80624
 
80276
80625
  /**
@@ -80992,7 +81341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
80992
81341
  /**
80993
81342
  * WebChat service.
80994
81343
  * @module purecloud-platform-client-v2/api/WebChatApi
80995
- * @version 235.0.0
81344
+ * @version 237.0.0
80996
81345
  */
80997
81346
 
80998
81347
  /**
@@ -81555,7 +81904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
81555
81904
  /**
81556
81905
  * WebDeployments service.
81557
81906
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
81558
- * @version 235.0.0
81907
+ * @version 237.0.0
81559
81908
  */
81560
81909
 
81561
81910
  /**
@@ -82137,7 +82486,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82137
82486
  /**
82138
82487
  * WebMessaging service.
82139
82488
  * @module purecloud-platform-client-v2/api/WebMessagingApi
82140
- * @version 235.0.0
82489
+ * @version 237.0.0
82141
82490
  */
82142
82491
 
82143
82492
  /**
@@ -82283,7 +82632,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82283
82632
  /**
82284
82633
  * Widgets service.
82285
82634
  * @module purecloud-platform-client-v2/api/WidgetsApi
82286
- * @version 235.0.0
82635
+ * @version 237.0.0
82287
82636
  */
82288
82637
 
82289
82638
  /**
@@ -82434,7 +82783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82434
82783
  /**
82435
82784
  * WorkforceManagement service.
82436
82785
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
82437
- * @version 235.0.0
82786
+ * @version 237.0.0
82438
82787
  */
82439
82788
 
82440
82789
  /**
@@ -83198,6 +83547,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
83198
83547
  );
83199
83548
  }
83200
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
+
83201
83575
  /**
83202
83576
  * Get the management unit to which the currently logged in agent belongs
83203
83577
  *
@@ -87546,6 +87920,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
87546
87920
  );
87547
87921
  }
87548
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
+
87549
87948
  /**
87550
87949
  * Get agent possible work shifts for requested time frame
87551
87950
  *
@@ -90435,7 +90834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
90435
90834
  * </pre>
90436
90835
  * </p>
90437
90836
  * @module purecloud-platform-client-v2/index
90438
- * @version 235.0.0
90837
+ * @version 237.0.0
90439
90838
  */
90440
90839
  class platformClient {
90441
90840
  constructor() {
@@ -90824,6 +91223,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
90824
91223
  * @property {module:purecloud-platform-client-v2/api/UsersApi}
90825
91224
  */
90826
91225
  this.UsersApi = UsersApi;
91226
+ /**
91227
+ * The UsersRulesApi service constructor.
91228
+ * @property {module:purecloud-platform-client-v2/api/UsersRulesApi}
91229
+ */
91230
+ this.UsersRulesApi = UsersRulesApi;
90827
91231
  /**
90828
91232
  * The UtilitiesApi service constructor.
90829
91233
  * @property {module:purecloud-platform-client-v2/api/UtilitiesApi}