purecloud-platform-client-v2 255.1.0 → 256.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 (98) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +693 -93
  3. package/dist/web-amd/purecloud-platform-client-v2.js +693 -93
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +254 -94
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +254 -94
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +362 -30
  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 +35 -1
  18. package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +151 -1
  37. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +3 -2
  47. package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/LearningApi.js +2 -4
  53. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  65. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/ScreenMonitoringApi.js +381 -0
  73. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  94. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  95. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  96. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  97. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +37 -1
  98. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -747,7 +747,7 @@ class Configuration {
747
747
 
748
748
  /**
749
749
  * @module purecloud-platform-client-v2/ApiClient
750
- * @version 255.1.0
750
+ * @version 256.0.0
751
751
  */
752
752
  class ApiClient {
753
753
  /**
@@ -2439,7 +2439,7 @@ class AIStudioApi {
2439
2439
  /**
2440
2440
  * AIStudio service.
2441
2441
  * @module purecloud-platform-client-v2/api/AIStudioApi
2442
- * @version 255.1.0
2442
+ * @version 256.0.0
2443
2443
  */
2444
2444
 
2445
2445
  /**
@@ -3154,7 +3154,7 @@ class AgentAssistantsApi {
3154
3154
  /**
3155
3155
  * AgentAssistants service.
3156
3156
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
3157
- * @version 255.1.0
3157
+ * @version 256.0.0
3158
3158
  */
3159
3159
 
3160
3160
  /**
@@ -3959,7 +3959,7 @@ class AgentCopilotApi {
3959
3959
  /**
3960
3960
  * AgentCopilot service.
3961
3961
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
3962
- * @version 255.1.0
3962
+ * @version 256.0.0
3963
3963
  */
3964
3964
 
3965
3965
  /**
@@ -4071,7 +4071,7 @@ class AgentUIApi {
4071
4071
  /**
4072
4072
  * AgentUI service.
4073
4073
  * @module purecloud-platform-client-v2/api/AgentUIApi
4074
- * @version 255.1.0
4074
+ * @version 256.0.0
4075
4075
  */
4076
4076
 
4077
4077
  /**
@@ -4222,7 +4222,7 @@ class AlertingApi {
4222
4222
  /**
4223
4223
  * Alerting service.
4224
4224
  * @module purecloud-platform-client-v2/api/AlertingApi
4225
- * @version 255.1.0
4225
+ * @version 256.0.0
4226
4226
  */
4227
4227
 
4228
4228
  /**
@@ -4683,7 +4683,7 @@ class AnalyticsApi {
4683
4683
  /**
4684
4684
  * Analytics service.
4685
4685
  * @module purecloud-platform-client-v2/api/AnalyticsApi
4686
- * @version 255.1.0
4686
+ * @version 256.0.0
4687
4687
  */
4688
4688
 
4689
4689
  /**
@@ -8908,7 +8908,7 @@ class ArchitectApi {
8908
8908
  /**
8909
8909
  * Architect service.
8910
8910
  * @module purecloud-platform-client-v2/api/ArchitectApi
8911
- * @version 255.1.0
8911
+ * @version 256.0.0
8912
8912
  */
8913
8913
 
8914
8914
  /**
@@ -11745,6 +11745,40 @@ class ArchitectApi {
11745
11745
  );
11746
11746
  }
11747
11747
 
11748
+ /**
11749
+ * Look up flows by ID
11750
+ * Returns only flows matching the specified ID(s). Returns an empty listing if no flows match the given IDs.
11751
+ * @param {Array.<String>} id Flow ID(s)
11752
+ * @param {Object} opts Optional parameters
11753
+ * @param {Number} opts.pageNumber Page number (default to 1)
11754
+ * @param {Number} opts.pageSize Page size (default to 25)
11755
+ * @param {String} opts.sortBy Sort by (default to id)
11756
+ * @param {String} opts.sortOrder Sort order (default to asc)
11757
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
11758
+ */
11759
+ getFlowsLookup(id, opts) {
11760
+ opts = opts || {};
11761
+
11762
+ // verify the required parameter 'id' is set
11763
+ if (id === undefined || id === null) {
11764
+ throw 'Missing the required parameter "id" when calling getFlowsLookup';
11765
+ }
11766
+
11767
+ return this.apiClient.callApi(
11768
+ '/api/v2/flows/lookup',
11769
+ 'GET',
11770
+ { },
11771
+ { 'id': this.apiClient.buildCollectionParam(id, 'multi'),'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
11772
+ { },
11773
+ { },
11774
+ null,
11775
+ ['PureCloud OAuth'],
11776
+ ['application/json'],
11777
+ ['application/json'],
11778
+ opts['customHeaders']
11779
+ );
11780
+ }
11781
+
11748
11782
  /**
11749
11783
  * Get a flow milestone
11750
11784
  * Returns a specified flow milestone
@@ -13831,7 +13865,7 @@ class AssistantCopilotVariationsApi {
13831
13865
  /**
13832
13866
  * AssistantCopilotVariations service.
13833
13867
  * @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
13834
- * @version 255.1.0
13868
+ * @version 256.0.0
13835
13869
  */
13836
13870
 
13837
13871
  /**
@@ -14027,7 +14061,7 @@ class AuditApi {
14027
14061
  /**
14028
14062
  * Audit service.
14029
14063
  * @module purecloud-platform-client-v2/api/AuditApi
14030
- * @version 255.1.0
14064
+ * @version 256.0.0
14031
14065
  */
14032
14066
 
14033
14067
  /**
@@ -14254,7 +14288,7 @@ class AuthorizationApi {
14254
14288
  /**
14255
14289
  * Authorization service.
14256
14290
  * @module purecloud-platform-client-v2/api/AuthorizationApi
14257
- * @version 255.1.0
14291
+ * @version 256.0.0
14258
14292
  */
14259
14293
 
14260
14294
  /**
@@ -16179,7 +16213,7 @@ class BackgroundAssistantApi {
16179
16213
  /**
16180
16214
  * BackgroundAssistant service.
16181
16215
  * @module purecloud-platform-client-v2/api/BackgroundAssistantApi
16182
- * @version 255.1.0
16216
+ * @version 256.0.0
16183
16217
  */
16184
16218
 
16185
16219
  /**
@@ -16253,7 +16287,7 @@ class BillingApi {
16253
16287
  /**
16254
16288
  * Billing service.
16255
16289
  * @module purecloud-platform-client-v2/api/BillingApi
16256
- * @version 255.1.0
16290
+ * @version 256.0.0
16257
16291
  */
16258
16292
 
16259
16293
  /**
@@ -16537,7 +16571,7 @@ class BusinessRulesApi {
16537
16571
  /**
16538
16572
  * BusinessRules service.
16539
16573
  * @module purecloud-platform-client-v2/api/BusinessRulesApi
16540
- * @version 255.1.0
16574
+ * @version 256.0.0
16541
16575
  */
16542
16576
 
16543
16577
  /**
@@ -17985,7 +18019,7 @@ class CarrierServicesApi {
17985
18019
  /**
17986
18020
  * CarrierServices service.
17987
18021
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
17988
- * @version 255.1.0
18022
+ * @version 256.0.0
17989
18023
  */
17990
18024
 
17991
18025
  /**
@@ -18062,7 +18096,7 @@ class CaseManagementApi {
18062
18096
  /**
18063
18097
  * CaseManagement service.
18064
18098
  * @module purecloud-platform-client-v2/api/CaseManagementApi
18065
- * @version 255.1.0
18099
+ * @version 256.0.0
18066
18100
  */
18067
18101
 
18068
18102
  /**
@@ -19437,7 +19471,7 @@ class ChatApi {
19437
19471
  /**
19438
19472
  * Chat service.
19439
19473
  * @module purecloud-platform-client-v2/api/ChatApi
19440
- * @version 255.1.0
19474
+ * @version 256.0.0
19441
19475
  */
19442
19476
 
19443
19477
  /**
@@ -20576,7 +20610,7 @@ class CoachingApi {
20576
20610
  /**
20577
20611
  * Coaching service.
20578
20612
  * @module purecloud-platform-client-v2/api/CoachingApi
20579
- * @version 255.1.0
20613
+ * @version 256.0.0
20580
20614
  */
20581
20615
 
20582
20616
  /**
@@ -21290,7 +21324,7 @@ class ContentManagementApi {
21290
21324
  /**
21291
21325
  * ContentManagement service.
21292
21326
  * @module purecloud-platform-client-v2/api/ContentManagementApi
21293
- * @version 255.1.0
21327
+ * @version 256.0.0
21294
21328
  */
21295
21329
 
21296
21330
  /**
@@ -22485,7 +22519,7 @@ class ConversationsApi {
22485
22519
  /**
22486
22520
  * Conversations service.
22487
22521
  * @module purecloud-platform-client-v2/api/ConversationsApi
22488
- * @version 255.1.0
22522
+ * @version 256.0.0
22489
22523
  */
22490
22524
 
22491
22525
  /**
@@ -33587,7 +33621,7 @@ class DataExtensionsApi {
33587
33621
  /**
33588
33622
  * DataExtensions service.
33589
33623
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
33590
- * @version 255.1.0
33624
+ * @version 256.0.0
33591
33625
  */
33592
33626
 
33593
33627
  /**
@@ -33688,7 +33722,7 @@ class DataPrivacyApi {
33688
33722
  /**
33689
33723
  * DataPrivacy service.
33690
33724
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
33691
- * @version 255.1.0
33725
+ * @version 256.0.0
33692
33726
  */
33693
33727
 
33694
33728
  /**
@@ -33885,7 +33919,7 @@ class DownloadsApi {
33885
33919
  /**
33886
33920
  * Downloads service.
33887
33921
  * @module purecloud-platform-client-v2/api/DownloadsApi
33888
- * @version 255.1.0
33922
+ * @version 256.0.0
33889
33923
  */
33890
33924
 
33891
33925
  /**
@@ -33939,7 +33973,7 @@ class EmailsApi {
33939
33973
  /**
33940
33974
  * Emails service.
33941
33975
  * @module purecloud-platform-client-v2/api/EmailsApi
33942
- * @version 255.1.0
33976
+ * @version 256.0.0
33943
33977
  */
33944
33978
 
33945
33979
  /**
@@ -34087,7 +34121,7 @@ class EmployeeEngagementApi {
34087
34121
  /**
34088
34122
  * EmployeeEngagement service.
34089
34123
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
34090
- * @version 255.1.0
34124
+ * @version 256.0.0
34091
34125
  */
34092
34126
 
34093
34127
  /**
@@ -34291,7 +34325,7 @@ class EventsApi {
34291
34325
  /**
34292
34326
  * Events service.
34293
34327
  * @module purecloud-platform-client-v2/api/EventsApi
34294
- * @version 255.1.0
34328
+ * @version 256.0.0
34295
34329
  */
34296
34330
 
34297
34331
  /**
@@ -34433,7 +34467,7 @@ class ExternalContactsApi {
34433
34467
  /**
34434
34468
  * ExternalContacts service.
34435
34469
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
34436
- * @version 255.1.0
34470
+ * @version 256.0.0
34437
34471
  */
34438
34472
 
34439
34473
  /**
@@ -36358,6 +36392,81 @@ class ExternalContactsApi {
36358
36392
  );
36359
36393
  }
36360
36394
 
36395
+ /**
36396
+ * Update a Contact Note
36397
+ *
36398
+ * @param {String} contactId ExternalContact Id
36399
+ * @param {String} noteId Note Id
36400
+ * @param {Object} body Note field to update
36401
+ * @param {Object} opts Optional parameters
36402
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
36403
+ */
36404
+ patchExternalcontactsContactNote(contactId, noteId, body, opts) {
36405
+ opts = opts || {};
36406
+
36407
+ // verify the required parameter 'contactId' is set
36408
+ if (contactId === undefined || contactId === null || contactId === '') {
36409
+ throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContactNote';
36410
+ }
36411
+ // verify the required parameter 'noteId' is set
36412
+ if (noteId === undefined || noteId === null || noteId === '') {
36413
+ throw 'Missing the required parameter "noteId" when calling patchExternalcontactsContactNote';
36414
+ }
36415
+ // verify the required parameter 'body' is set
36416
+ if (body === undefined || body === null) {
36417
+ throw 'Missing the required parameter "body" when calling patchExternalcontactsContactNote';
36418
+ }
36419
+
36420
+ return this.apiClient.callApi(
36421
+ '/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}',
36422
+ 'PATCH',
36423
+ { 'contactId': contactId,'noteId': noteId },
36424
+ { },
36425
+ { },
36426
+ { },
36427
+ body,
36428
+ ['PureCloud OAuth'],
36429
+ ['application/json'],
36430
+ ['application/json'],
36431
+ opts['customHeaders']
36432
+ );
36433
+ }
36434
+
36435
+ /**
36436
+ * Update specific fields of an external organization
36437
+ *
36438
+ * @param {String} externalOrganizationId External Organization ID
36439
+ * @param {Object} body External Organization fields to update
36440
+ * @param {Object} opts Optional parameters
36441
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
36442
+ */
36443
+ patchExternalcontactsOrganization(externalOrganizationId, body, opts) {
36444
+ opts = opts || {};
36445
+
36446
+ // verify the required parameter 'externalOrganizationId' is set
36447
+ if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
36448
+ throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganization';
36449
+ }
36450
+ // verify the required parameter 'body' is set
36451
+ if (body === undefined || body === null) {
36452
+ throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganization';
36453
+ }
36454
+
36455
+ return this.apiClient.callApi(
36456
+ '/api/v2/externalcontacts/organizations/{externalOrganizationId}',
36457
+ 'PATCH',
36458
+ { 'externalOrganizationId': externalOrganizationId },
36459
+ { },
36460
+ { },
36461
+ { },
36462
+ body,
36463
+ ['PureCloud OAuth'],
36464
+ ['application/json'],
36465
+ ['application/json'],
36466
+ opts['customHeaders']
36467
+ );
36468
+ }
36469
+
36361
36470
  /**
36362
36471
  * Claim or release identifiers for an external organization
36363
36472
  *
@@ -36393,6 +36502,81 @@ class ExternalContactsApi {
36393
36502
  );
36394
36503
  }
36395
36504
 
36505
+ /**
36506
+ * Update an External Organization Note
36507
+ *
36508
+ * @param {String} externalOrganizationId External Organization Id
36509
+ * @param {String} noteId Note Id
36510
+ * @param {Object} body Note field to update
36511
+ * @param {Object} opts Optional parameters
36512
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
36513
+ */
36514
+ patchExternalcontactsOrganizationNote(externalOrganizationId, noteId, body, opts) {
36515
+ opts = opts || {};
36516
+
36517
+ // verify the required parameter 'externalOrganizationId' is set
36518
+ if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
36519
+ throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationNote';
36520
+ }
36521
+ // verify the required parameter 'noteId' is set
36522
+ if (noteId === undefined || noteId === null || noteId === '') {
36523
+ throw 'Missing the required parameter "noteId" when calling patchExternalcontactsOrganizationNote';
36524
+ }
36525
+ // verify the required parameter 'body' is set
36526
+ if (body === undefined || body === null) {
36527
+ throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganizationNote';
36528
+ }
36529
+
36530
+ return this.apiClient.callApi(
36531
+ '/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}',
36532
+ 'PATCH',
36533
+ { 'externalOrganizationId': externalOrganizationId,'noteId': noteId },
36534
+ { },
36535
+ { },
36536
+ { },
36537
+ body,
36538
+ ['PureCloud OAuth'],
36539
+ ['application/json'],
36540
+ ['application/json'],
36541
+ opts['customHeaders']
36542
+ );
36543
+ }
36544
+
36545
+ /**
36546
+ * Update specific fields of a relationship
36547
+ *
36548
+ * @param {String} relationshipId Relationship Id
36549
+ * @param {Object} body Relationship fields to update
36550
+ * @param {Object} opts Optional parameters
36551
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
36552
+ */
36553
+ patchExternalcontactsRelationship(relationshipId, body, opts) {
36554
+ opts = opts || {};
36555
+
36556
+ // verify the required parameter 'relationshipId' is set
36557
+ if (relationshipId === undefined || relationshipId === null || relationshipId === '') {
36558
+ throw 'Missing the required parameter "relationshipId" when calling patchExternalcontactsRelationship';
36559
+ }
36560
+ // verify the required parameter 'body' is set
36561
+ if (body === undefined || body === null) {
36562
+ throw 'Missing the required parameter "body" when calling patchExternalcontactsRelationship';
36563
+ }
36564
+
36565
+ return this.apiClient.callApi(
36566
+ '/api/v2/externalcontacts/relationships/{relationshipId}',
36567
+ 'PATCH',
36568
+ { 'relationshipId': relationshipId },
36569
+ { },
36570
+ { },
36571
+ { },
36572
+ body,
36573
+ ['PureCloud OAuth'],
36574
+ ['application/json'],
36575
+ ['application/json'],
36576
+ opts['customHeaders']
36577
+ );
36578
+ }
36579
+
36396
36580
  /**
36397
36581
  * Bulk fetch contacts
36398
36582
  *
@@ -38204,7 +38388,7 @@ class FaxApi {
38204
38388
  /**
38205
38389
  * Fax service.
38206
38390
  * @module purecloud-platform-client-v2/api/FaxApi
38207
- * @version 255.1.0
38391
+ * @version 256.0.0
38208
38392
  */
38209
38393
 
38210
38394
  /**
@@ -38453,7 +38637,7 @@ class FlowsApi {
38453
38637
  /**
38454
38638
  * Flows service.
38455
38639
  * @module purecloud-platform-client-v2/api/FlowsApi
38456
- * @version 255.1.0
38640
+ * @version 256.0.0
38457
38641
  */
38458
38642
 
38459
38643
  /**
@@ -38687,7 +38871,7 @@ class GamificationApi {
38687
38871
  /**
38688
38872
  * Gamification service.
38689
38873
  * @module purecloud-platform-client-v2/api/GamificationApi
38690
- * @version 255.1.0
38874
+ * @version 256.0.0
38691
38875
  */
38692
38876
 
38693
38877
  /**
@@ -41539,7 +41723,7 @@ class GeneralDataProtectionRegulationApi {
41539
41723
  /**
41540
41724
  * GeneralDataProtectionRegulation service.
41541
41725
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
41542
- * @version 255.1.0
41726
+ * @version 256.0.0
41543
41727
  */
41544
41728
 
41545
41729
  /**
@@ -41683,7 +41867,7 @@ class GeolocationApi {
41683
41867
  /**
41684
41868
  * Geolocation service.
41685
41869
  * @module purecloud-platform-client-v2/api/GeolocationApi
41686
- * @version 255.1.0
41870
+ * @version 256.0.0
41687
41871
  */
41688
41872
 
41689
41873
  /**
@@ -41834,7 +42018,7 @@ class GreetingsApi {
41834
42018
  /**
41835
42019
  * Greetings service.
41836
42020
  * @module purecloud-platform-client-v2/api/GreetingsApi
41837
- * @version 255.1.0
42021
+ * @version 256.0.0
41838
42022
  */
41839
42023
 
41840
42024
  /**
@@ -42450,7 +42634,7 @@ class GroupsApi {
42450
42634
  /**
42451
42635
  * Groups service.
42452
42636
  * @module purecloud-platform-client-v2/api/GroupsApi
42453
- * @version 255.1.0
42637
+ * @version 256.0.0
42454
42638
  */
42455
42639
 
42456
42640
  /**
@@ -43041,7 +43225,7 @@ class IdentityProviderApi {
43041
43225
  /**
43042
43226
  * IdentityProvider service.
43043
43227
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
43044
- * @version 255.1.0
43228
+ * @version 256.0.0
43045
43229
  */
43046
43230
 
43047
43231
  /**
@@ -44092,7 +44276,7 @@ class InfrastructureAsCodeApi {
44092
44276
  /**
44093
44277
  * InfrastructureAsCode service.
44094
44278
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
44095
- * @version 255.1.0
44279
+ * @version 256.0.0
44096
44280
  */
44097
44281
 
44098
44282
  /**
@@ -44272,7 +44456,7 @@ class IntegrationsApi {
44272
44456
  /**
44273
44457
  * Integrations service.
44274
44458
  * @module purecloud-platform-client-v2/api/IntegrationsApi
44275
- * @version 255.1.0
44459
+ * @version 256.0.0
44276
44460
  */
44277
44461
 
44278
44462
  /**
@@ -44486,6 +44670,7 @@ class IntegrationsApi {
44486
44670
  * @param {Array.<String>} opts.ids Comma-separated list of integration IDs to filter by (max 100)
44487
44671
  * @param {String} opts.integrationType Filter integrations by integration type ID
44488
44672
  * @param {Object} opts.reportedState Filter integrations by reported state (case-insensitive)
44673
+ * @param {String} opts.credentialId Filter integrations by credential ID
44489
44674
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
44490
44675
  */
44491
44676
  getIntegrations(opts) {
@@ -44496,7 +44681,7 @@ class IntegrationsApi {
44496
44681
  '/api/v2/integrations',
44497
44682
  'GET',
44498
44683
  { },
44499
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'integrationType': opts['integrationType'],'reportedState': opts['reportedState'] },
44684
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'integrationType': opts['integrationType'],'reportedState': opts['reportedState'],'credentialId': opts['credentialId'] },
44500
44685
  { },
44501
44686
  { },
44502
44687
  null,
@@ -47244,7 +47429,7 @@ class IntentsApi {
47244
47429
  /**
47245
47430
  * Intents service.
47246
47431
  * @module purecloud-platform-client-v2/api/IntentsApi
47247
- * @version 255.1.0
47432
+ * @version 256.0.0
47248
47433
  */
47249
47434
 
47250
47435
  /**
@@ -47776,7 +47961,7 @@ class JourneyApi {
47776
47961
  /**
47777
47962
  * Journey service.
47778
47963
  * @module purecloud-platform-client-v2/api/JourneyApi
47779
- * @version 255.1.0
47964
+ * @version 256.0.0
47780
47965
  */
47781
47966
 
47782
47967
  /**
@@ -50752,7 +50937,7 @@ class KnowledgeApi {
50752
50937
  /**
50753
50938
  * Knowledge service.
50754
50939
  * @module purecloud-platform-client-v2/api/KnowledgeApi
50755
- * @version 255.1.0
50940
+ * @version 256.0.0
50756
50941
  */
50757
50942
 
50758
50943
  /**
@@ -55003,7 +55188,7 @@ class LanguageUnderstandingApi {
55003
55188
  /**
55004
55189
  * LanguageUnderstanding service.
55005
55190
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
55006
- * @version 255.1.0
55191
+ * @version 256.0.0
55007
55192
  */
55008
55193
 
55009
55194
  /**
@@ -56377,7 +56562,7 @@ class LanguagesApi {
56377
56562
  /**
56378
56563
  * Languages service.
56379
56564
  * @module purecloud-platform-client-v2/api/LanguagesApi
56380
- * @version 255.1.0
56565
+ * @version 256.0.0
56381
56566
  */
56382
56567
 
56383
56568
  /**
@@ -56636,7 +56821,7 @@ class LearningApi {
56636
56821
  /**
56637
56822
  * Learning service.
56638
56823
  * @module purecloud-platform-client-v2/api/LearningApi
56639
- * @version 255.1.0
56824
+ * @version 256.0.0
56640
56825
  */
56641
56826
 
56642
56827
  /**
@@ -57025,7 +57210,6 @@ class LearningApi {
57025
57210
  * Get all learning modules of an organization
57026
57211
  *
57027
57212
  * @param {Object} opts Optional parameters
57028
- * @param {Boolean} opts.isArchived Archive status (default to false)
57029
57213
  * @param {Array.<String>} opts.types Specifies the module types. Informational, AssessedContent and Assessment are deprecated
57030
57214
  * @param {Number} opts.pageSize Page size (default to 25)
57031
57215
  * @param {Number} opts.pageNumber Page number (default to 1)
@@ -57033,7 +57217,6 @@ class LearningApi {
57033
57217
  * @param {Object} opts.sortBy Sort by (default to name)
57034
57218
  * @param {String} opts.searchTerm Search Term (searchable by name)
57035
57219
  * @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
57036
- * @param {Object} opts.isPublished Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned (default to Any)
57037
57220
  * @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
57038
57221
  * @param {Array.<String>} opts.externalIds Specifies the module external IDs to filter by. Only one ID is allowed
57039
57222
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
@@ -57046,7 +57229,7 @@ class LearningApi {
57046
57229
  '/api/v2/learning/modules',
57047
57230
  'GET',
57048
57231
  { },
57049
- { 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'externalIds': this.apiClient.buildCollectionParam(opts['externalIds'], 'multi') },
57232
+ { 'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'externalIds': this.apiClient.buildCollectionParam(opts['externalIds'], 'multi') },
57050
57233
  { },
57051
57234
  { },
57052
57235
  null,
@@ -57884,7 +58067,7 @@ class LicenseApi {
57884
58067
  /**
57885
58068
  * License service.
57886
58069
  * @module purecloud-platform-client-v2/api/LicenseApi
57887
- * @version 255.1.0
58070
+ * @version 256.0.0
57888
58071
  */
57889
58072
 
57890
58073
  /**
@@ -58182,7 +58365,7 @@ class LocationsApi {
58182
58365
  /**
58183
58366
  * Locations service.
58184
58367
  * @module purecloud-platform-client-v2/api/LocationsApi
58185
- * @version 255.1.0
58368
+ * @version 256.0.0
58186
58369
  */
58187
58370
 
58188
58371
  /**
@@ -58449,7 +58632,7 @@ class LogCaptureApi {
58449
58632
  /**
58450
58633
  * LogCapture service.
58451
58634
  * @module purecloud-platform-client-v2/api/LogCaptureApi
58452
- * @version 255.1.0
58635
+ * @version 256.0.0
58453
58636
  */
58454
58637
 
58455
58638
  /**
@@ -58671,7 +58854,7 @@ class MessagingApi {
58671
58854
  /**
58672
58855
  * Messaging service.
58673
58856
  * @module purecloud-platform-client-v2/api/MessagingApi
58674
- * @version 255.1.0
58857
+ * @version 256.0.0
58675
58858
  */
58676
58859
 
58677
58860
  /**
@@ -59089,7 +59272,7 @@ class MobileDevicesApi {
59089
59272
  /**
59090
59273
  * MobileDevices service.
59091
59274
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
59092
- * @version 255.1.0
59275
+ * @version 256.0.0
59093
59276
  */
59094
59277
 
59095
59278
  /**
@@ -59259,7 +59442,7 @@ class NotificationsApi {
59259
59442
  /**
59260
59443
  * Notifications service.
59261
59444
  * @module purecloud-platform-client-v2/api/NotificationsApi
59262
- * @version 255.1.0
59445
+ * @version 256.0.0
59263
59446
  */
59264
59447
 
59265
59448
  /**
@@ -59520,7 +59703,7 @@ class OAuthApi {
59520
59703
  /**
59521
59704
  * OAuth service.
59522
59705
  * @module purecloud-platform-client-v2/api/OAuthApi
59523
- * @version 255.1.0
59706
+ * @version 256.0.0
59524
59707
  */
59525
59708
 
59526
59709
  /**
@@ -59936,7 +60119,7 @@ class ObjectsApi {
59936
60119
  /**
59937
60120
  * Objects service.
59938
60121
  * @module purecloud-platform-client-v2/api/ObjectsApi
59939
- * @version 255.1.0
60122
+ * @version 256.0.0
59940
60123
  */
59941
60124
 
59942
60125
  /**
@@ -60300,7 +60483,7 @@ class OperationalEventsApi {
60300
60483
  /**
60301
60484
  * OperationalEvents service.
60302
60485
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
60303
- * @version 255.1.0
60486
+ * @version 256.0.0
60304
60487
  */
60305
60488
 
60306
60489
  /**
@@ -60431,7 +60614,7 @@ class OrganizationApi {
60431
60614
  /**
60432
60615
  * Organization service.
60433
60616
  * @module purecloud-platform-client-v2/api/OrganizationApi
60434
- * @version 255.1.0
60617
+ * @version 256.0.0
60435
60618
  */
60436
60619
 
60437
60620
  /**
@@ -60992,7 +61175,7 @@ class OrganizationAuthorizationApi {
60992
61175
  /**
60993
61176
  * OrganizationAuthorization service.
60994
61177
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
60995
- * @version 255.1.0
61178
+ * @version 256.0.0
60996
61179
  */
60997
61180
 
60998
61181
  /**
@@ -62596,7 +62779,7 @@ class OutboundApi {
62596
62779
  /**
62597
62780
  * Outbound service.
62598
62781
  * @module purecloud-platform-client-v2/api/OutboundApi
62599
- * @version 255.1.0
62782
+ * @version 256.0.0
62600
62783
  */
62601
62784
 
62602
62785
  /**
@@ -64533,7 +64716,7 @@ class OutboundApi {
64533
64716
 
64534
64717
  /**
64535
64718
  * Query a list of contact lists.
64536
- *
64719
+ * Any ContactList field can be used as a query parameter to filter results. Multiple values can be specified for a field, and filter type prefixes can be used inline. Example: dateCreated=greaterthan:2025-01-01T00:00:00.000Z&dateCreated=lessthan:2027-01-01T00:00:00.000Z. See https://developer.genesys.cloud/routing/outbound/filter-type for available filter types.
64537
64720
  * @param {Object} opts Optional parameters
64538
64721
  * @param {Boolean} opts.includeImportStatus Include import status (default to false)
64539
64722
  * @param {Boolean} opts.includeSize Include size (default to false)
@@ -68183,7 +68366,7 @@ class PresenceApi {
68183
68366
  /**
68184
68367
  * Presence service.
68185
68368
  * @module purecloud-platform-client-v2/api/PresenceApi
68186
- * @version 255.1.0
68369
+ * @version 256.0.0
68187
68370
  */
68188
68371
 
68189
68372
  /**
@@ -69041,7 +69224,7 @@ class ProcessAutomationApi {
69041
69224
  /**
69042
69225
  * ProcessAutomation service.
69043
69226
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
69044
- * @version 255.1.0
69227
+ * @version 256.0.0
69045
69228
  */
69046
69229
 
69047
69230
  /**
@@ -69462,7 +69645,7 @@ class QualityApi {
69462
69645
  /**
69463
69646
  * Quality service.
69464
69647
  * @module purecloud-platform-client-v2/api/QualityApi
69465
- * @version 255.1.0
69648
+ * @version 256.0.0
69466
69649
  */
69467
69650
 
69468
69651
  /**
@@ -71812,7 +71995,7 @@ class RecordingApi {
71812
71995
  /**
71813
71996
  * Recording service.
71814
71997
  * @module purecloud-platform-client-v2/api/RecordingApi
71815
- * @version 255.1.0
71998
+ * @version 256.0.0
71816
71999
  */
71817
72000
 
71818
72001
  /**
@@ -73660,7 +73843,7 @@ class ResponseManagementApi {
73660
73843
  /**
73661
73844
  * ResponseManagement service.
73662
73845
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
73663
- * @version 255.1.0
73846
+ * @version 256.0.0
73664
73847
  */
73665
73848
 
73666
73849
  /**
@@ -74304,7 +74487,7 @@ class RoutingApi {
74304
74487
  /**
74305
74488
  * Routing service.
74306
74489
  * @module purecloud-platform-client-v2/api/RoutingApi
74307
- * @version 255.1.0
74490
+ * @version 256.0.0
74308
74491
  */
74309
74492
 
74310
74493
  /**
@@ -79866,7 +80049,7 @@ class SCIMApi {
79866
80049
  /**
79867
80050
  * SCIM service.
79868
80051
  * @module purecloud-platform-client-v2/api/SCIMApi
79869
- * @version 255.1.0
80052
+ * @version 256.0.0
79870
80053
  */
79871
80054
 
79872
80055
  /**
@@ -80823,11 +81006,387 @@ class SCIMApi {
80823
81006
 
80824
81007
  }
80825
81008
 
81009
+ class ScreenMonitoringApi {
81010
+ /**
81011
+ * ScreenMonitoring service.
81012
+ * @module purecloud-platform-client-v2/api/ScreenMonitoringApi
81013
+ * @version 256.0.0
81014
+ */
81015
+
81016
+ /**
81017
+ * Constructs a new ScreenMonitoringApi.
81018
+ * @alias module:purecloud-platform-client-v2/api/ScreenMonitoringApi
81019
+ * @class
81020
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
81021
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
81022
+ */
81023
+ constructor(apiClient) {
81024
+ this.apiClient = apiClient || ApiClient.instance;
81025
+ }
81026
+
81027
+
81028
+ /**
81029
+ * Stop a conversation-level screen monitoring session.
81030
+ *
81031
+ * @param {String} conversationId Conversation ID
81032
+ * @param {String} participantId Participant ID
81033
+ * @param {String} screenMonitoringId Screen Monitoring ID
81034
+ * @param {Object} opts Optional parameters
81035
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81036
+ */
81037
+ deleteConversationParticipantScreenmonitorsSession(conversationId, participantId, screenMonitoringId, opts) {
81038
+ opts = opts || {};
81039
+
81040
+ // verify the required parameter 'conversationId' is set
81041
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
81042
+ throw 'Missing the required parameter "conversationId" when calling deleteConversationParticipantScreenmonitorsSession';
81043
+ }
81044
+ // verify the required parameter 'participantId' is set
81045
+ if (participantId === undefined || participantId === null || participantId === '') {
81046
+ throw 'Missing the required parameter "participantId" when calling deleteConversationParticipantScreenmonitorsSession';
81047
+ }
81048
+ // verify the required parameter 'screenMonitoringId' is set
81049
+ if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
81050
+ throw 'Missing the required parameter "screenMonitoringId" when calling deleteConversationParticipantScreenmonitorsSession';
81051
+ }
81052
+
81053
+ return this.apiClient.callApi(
81054
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}',
81055
+ 'DELETE',
81056
+ { 'conversationId': conversationId,'participantId': participantId,'screenMonitoringId': screenMonitoringId },
81057
+ { },
81058
+ { },
81059
+ { },
81060
+ null,
81061
+ ['PureCloud OAuth'],
81062
+ ['application/json'],
81063
+ ['application/json'],
81064
+ opts['customHeaders']
81065
+ );
81066
+ }
81067
+
81068
+ /**
81069
+ * Stop an agent-level screen monitoring session.
81070
+ *
81071
+ * @param {String} userId User ID
81072
+ * @param {String} screenMonitoringId Screen Monitoring ID
81073
+ * @param {Object} opts Optional parameters
81074
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81075
+ */
81076
+ deleteUserScreenmonitorsSession(userId, screenMonitoringId, opts) {
81077
+ opts = opts || {};
81078
+
81079
+ // verify the required parameter 'userId' is set
81080
+ if (userId === undefined || userId === null || userId === '') {
81081
+ throw 'Missing the required parameter "userId" when calling deleteUserScreenmonitorsSession';
81082
+ }
81083
+ // verify the required parameter 'screenMonitoringId' is set
81084
+ if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
81085
+ throw 'Missing the required parameter "screenMonitoringId" when calling deleteUserScreenmonitorsSession';
81086
+ }
81087
+
81088
+ return this.apiClient.callApi(
81089
+ '/api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}',
81090
+ 'DELETE',
81091
+ { 'userId': userId,'screenMonitoringId': screenMonitoringId },
81092
+ { },
81093
+ { },
81094
+ { },
81095
+ null,
81096
+ ['PureCloud OAuth'],
81097
+ ['application/json'],
81098
+ ['application/json'],
81099
+ opts['customHeaders']
81100
+ );
81101
+ }
81102
+
81103
+ /**
81104
+ * Get a conversation-level screen monitoring session object using the supplied screenMonitoringId.
81105
+ *
81106
+ * @param {String} conversationId Conversation ID
81107
+ * @param {String} participantId Participant ID
81108
+ * @param {String} screenMonitoringId Screen Monitoring ID
81109
+ * @param {Object} opts Optional parameters
81110
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81111
+ */
81112
+ getConversationParticipantScreenmonitorsSession(conversationId, participantId, screenMonitoringId, opts) {
81113
+ opts = opts || {};
81114
+
81115
+ // verify the required parameter 'conversationId' is set
81116
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
81117
+ throw 'Missing the required parameter "conversationId" when calling getConversationParticipantScreenmonitorsSession';
81118
+ }
81119
+ // verify the required parameter 'participantId' is set
81120
+ if (participantId === undefined || participantId === null || participantId === '') {
81121
+ throw 'Missing the required parameter "participantId" when calling getConversationParticipantScreenmonitorsSession';
81122
+ }
81123
+ // verify the required parameter 'screenMonitoringId' is set
81124
+ if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
81125
+ throw 'Missing the required parameter "screenMonitoringId" when calling getConversationParticipantScreenmonitorsSession';
81126
+ }
81127
+
81128
+ return this.apiClient.callApi(
81129
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}',
81130
+ 'GET',
81131
+ { 'conversationId': conversationId,'participantId': participantId,'screenMonitoringId': screenMonitoringId },
81132
+ { },
81133
+ { },
81134
+ { },
81135
+ null,
81136
+ ['PureCloud OAuth'],
81137
+ ['application/json'],
81138
+ ['application/json'],
81139
+ opts['customHeaders']
81140
+ );
81141
+ }
81142
+
81143
+ /**
81144
+ * Get the details of all screen monitoring sessions for the current organization.
81145
+ *
81146
+ * @param {Object} opts Optional parameters
81147
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81148
+ */
81149
+ getScreenmonitorsSessionsDetails(opts) {
81150
+ opts = opts || {};
81151
+
81152
+
81153
+ return this.apiClient.callApi(
81154
+ '/api/v2/screenmonitors/sessions/details',
81155
+ 'GET',
81156
+ { },
81157
+ { },
81158
+ { },
81159
+ { },
81160
+ null,
81161
+ ['PureCloud OAuth'],
81162
+ ['application/json'],
81163
+ ['application/json'],
81164
+ opts['customHeaders']
81165
+ );
81166
+ }
81167
+
81168
+ /**
81169
+ * Get the Screen Monitor Settings for the Organization
81170
+ *
81171
+ * @param {Object} opts Optional parameters
81172
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81173
+ */
81174
+ getScreenmonitorsSettings(opts) {
81175
+ opts = opts || {};
81176
+
81177
+
81178
+ return this.apiClient.callApi(
81179
+ '/api/v2/screenmonitors/settings',
81180
+ 'GET',
81181
+ { },
81182
+ { },
81183
+ { },
81184
+ { },
81185
+ null,
81186
+ ['PureCloud OAuth'],
81187
+ ['application/json'],
81188
+ ['application/json'],
81189
+ opts['customHeaders']
81190
+ );
81191
+ }
81192
+
81193
+ /**
81194
+ * Get all screen monitoring sessions for the supplied userId.
81195
+ *
81196
+ * @param {String} userId User ID
81197
+ * @param {Object} opts Optional parameters
81198
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81199
+ */
81200
+ getScreenmonitorsUserSessions(userId, opts) {
81201
+ opts = opts || {};
81202
+
81203
+ // verify the required parameter 'userId' is set
81204
+ if (userId === undefined || userId === null || userId === '') {
81205
+ throw 'Missing the required parameter "userId" when calling getScreenmonitorsUserSessions';
81206
+ }
81207
+
81208
+ return this.apiClient.callApi(
81209
+ '/api/v2/screenmonitors/users/{userId}/sessions',
81210
+ 'GET',
81211
+ { 'userId': userId },
81212
+ { },
81213
+ { },
81214
+ { },
81215
+ null,
81216
+ ['PureCloud OAuth'],
81217
+ ['application/json'],
81218
+ ['application/json'],
81219
+ opts['customHeaders']
81220
+ );
81221
+ }
81222
+
81223
+ /**
81224
+ * Get an agent-level screen monitoring session object using the supplied screenMonitoringId.
81225
+ *
81226
+ * @param {String} userId User ID
81227
+ * @param {String} screenMonitoringId Screen Monitoring ID
81228
+ * @param {Object} opts Optional parameters
81229
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81230
+ */
81231
+ getUserScreenmonitorsSession(userId, screenMonitoringId, opts) {
81232
+ opts = opts || {};
81233
+
81234
+ // verify the required parameter 'userId' is set
81235
+ if (userId === undefined || userId === null || userId === '') {
81236
+ throw 'Missing the required parameter "userId" when calling getUserScreenmonitorsSession';
81237
+ }
81238
+ // verify the required parameter 'screenMonitoringId' is set
81239
+ if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
81240
+ throw 'Missing the required parameter "screenMonitoringId" when calling getUserScreenmonitorsSession';
81241
+ }
81242
+
81243
+ return this.apiClient.callApi(
81244
+ '/api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}',
81245
+ 'GET',
81246
+ { 'userId': userId,'screenMonitoringId': screenMonitoringId },
81247
+ { },
81248
+ { },
81249
+ { },
81250
+ null,
81251
+ ['PureCloud OAuth'],
81252
+ ['application/json'],
81253
+ ['application/json'],
81254
+ opts['customHeaders']
81255
+ );
81256
+ }
81257
+
81258
+ /**
81259
+ * Start a conversation-level screen monitoring session.
81260
+ *
81261
+ * @param {String} conversationId Conversation ID
81262
+ * @param {String} participantId Participant ID
81263
+ * @param {Object} opts Optional parameters
81264
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81265
+ */
81266
+ postConversationParticipantScreenmonitorsSessions(conversationId, participantId, opts) {
81267
+ opts = opts || {};
81268
+
81269
+ // verify the required parameter 'conversationId' is set
81270
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
81271
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantScreenmonitorsSessions';
81272
+ }
81273
+ // verify the required parameter 'participantId' is set
81274
+ if (participantId === undefined || participantId === null || participantId === '') {
81275
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantScreenmonitorsSessions';
81276
+ }
81277
+
81278
+ return this.apiClient.callApi(
81279
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions',
81280
+ 'POST',
81281
+ { 'conversationId': conversationId,'participantId': participantId },
81282
+ { },
81283
+ { },
81284
+ { },
81285
+ null,
81286
+ ['PureCloud OAuth'],
81287
+ ['application/json'],
81288
+ ['application/json'],
81289
+ opts['customHeaders']
81290
+ );
81291
+ }
81292
+
81293
+ /**
81294
+ * Get screen monitor session details for one or more users.
81295
+ *
81296
+ * @param {Array.<String>} body List of target user IDs
81297
+ * @param {Object} opts Optional parameters
81298
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81299
+ */
81300
+ postScreenmonitorsSessionsUsersDetails(body, opts) {
81301
+ opts = opts || {};
81302
+
81303
+ // verify the required parameter 'body' is set
81304
+ if (body === undefined || body === null) {
81305
+ throw 'Missing the required parameter "body" when calling postScreenmonitorsSessionsUsersDetails';
81306
+ }
81307
+
81308
+ return this.apiClient.callApi(
81309
+ '/api/v2/screenmonitors/sessions/users/details',
81310
+ 'POST',
81311
+ { },
81312
+ { },
81313
+ { },
81314
+ { },
81315
+ body,
81316
+ ['PureCloud OAuth'],
81317
+ ['application/json'],
81318
+ ['application/json'],
81319
+ opts['customHeaders']
81320
+ );
81321
+ }
81322
+
81323
+ /**
81324
+ * Start an agent-level screen monitoring session.
81325
+ *
81326
+ * @param {String} userId User ID
81327
+ * @param {Object} opts Optional parameters
81328
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81329
+ */
81330
+ postUserScreenmonitorsSessions(userId, opts) {
81331
+ opts = opts || {};
81332
+
81333
+ // verify the required parameter 'userId' is set
81334
+ if (userId === undefined || userId === null || userId === '') {
81335
+ throw 'Missing the required parameter "userId" when calling postUserScreenmonitorsSessions';
81336
+ }
81337
+
81338
+ return this.apiClient.callApi(
81339
+ '/api/v2/users/{userId}/screenmonitors/sessions',
81340
+ 'POST',
81341
+ { 'userId': userId },
81342
+ { },
81343
+ { },
81344
+ { },
81345
+ null,
81346
+ ['PureCloud OAuth'],
81347
+ ['application/json'],
81348
+ ['application/json'],
81349
+ opts['customHeaders']
81350
+ );
81351
+ }
81352
+
81353
+ /**
81354
+ * Update the Screen Monitor Settings for the Organization
81355
+ *
81356
+ * @param {Object} body Screen Monitor settings
81357
+ * @param {Object} opts Optional parameters
81358
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
81359
+ */
81360
+ putScreenmonitorsSettings(body, opts) {
81361
+ opts = opts || {};
81362
+
81363
+ // verify the required parameter 'body' is set
81364
+ if (body === undefined || body === null) {
81365
+ throw 'Missing the required parameter "body" when calling putScreenmonitorsSettings';
81366
+ }
81367
+
81368
+ return this.apiClient.callApi(
81369
+ '/api/v2/screenmonitors/settings',
81370
+ 'PUT',
81371
+ { },
81372
+ { },
81373
+ { },
81374
+ { },
81375
+ body,
81376
+ ['PureCloud OAuth'],
81377
+ ['application/json'],
81378
+ ['application/json'],
81379
+ opts['customHeaders']
81380
+ );
81381
+ }
81382
+
81383
+ }
81384
+
80826
81385
  class ScriptsApi {
80827
81386
  /**
80828
81387
  * Scripts service.
80829
81388
  * @module purecloud-platform-client-v2/api/ScriptsApi
80830
- * @version 255.1.0
81389
+ * @version 256.0.0
80831
81390
  */
80832
81391
 
80833
81392
  /**
@@ -81336,7 +81895,7 @@ class SearchApi {
81336
81895
  /**
81337
81896
  * Search service.
81338
81897
  * @module purecloud-platform-client-v2/api/SearchApi
81339
- * @version 255.1.0
81898
+ * @version 256.0.0
81340
81899
  */
81341
81900
 
81342
81901
  /**
@@ -82152,7 +82711,7 @@ class SettingsApi {
82152
82711
  /**
82153
82712
  * Settings service.
82154
82713
  * @module purecloud-platform-client-v2/api/SettingsApi
82155
- * @version 255.1.0
82714
+ * @version 256.0.0
82156
82715
  */
82157
82716
 
82158
82717
  /**
@@ -82561,7 +83120,7 @@ class SocialMediaApi {
82561
83120
  /**
82562
83121
  * SocialMedia service.
82563
83122
  * @module purecloud-platform-client-v2/api/SocialMediaApi
82564
- * @version 255.1.0
83123
+ * @version 256.0.0
82565
83124
  */
82566
83125
 
82567
83126
  /**
@@ -84546,7 +85105,7 @@ class SpeechTextAnalyticsApi {
84546
85105
  /**
84547
85106
  * SpeechTextAnalytics service.
84548
85107
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
84549
- * @version 255.1.0
85108
+ * @version 256.0.0
84550
85109
  */
84551
85110
 
84552
85111
  /**
@@ -86498,7 +87057,7 @@ class StationsApi {
86498
87057
  /**
86499
87058
  * Stations service.
86500
87059
  * @module purecloud-platform-client-v2/api/StationsApi
86501
- * @version 255.1.0
87060
+ * @version 256.0.0
86502
87061
  */
86503
87062
 
86504
87063
  /**
@@ -86612,7 +87171,7 @@ class SuggestApi {
86612
87171
  /**
86613
87172
  * Suggest service.
86614
87173
  * @module purecloud-platform-client-v2/api/SuggestApi
86615
- * @version 255.1.0
87174
+ * @version 256.0.0
86616
87175
  */
86617
87176
 
86618
87177
  /**
@@ -86759,7 +87318,7 @@ class TaskManagementApi {
86759
87318
  /**
86760
87319
  * TaskManagement service.
86761
87320
  * @module purecloud-platform-client-v2/api/TaskManagementApi
86762
- * @version 255.1.0
87321
+ * @version 256.0.0
86763
87322
  */
86764
87323
 
86765
87324
  /**
@@ -89255,7 +89814,7 @@ class TeamsApi {
89255
89814
  /**
89256
89815
  * Teams service.
89257
89816
  * @module purecloud-platform-client-v2/api/TeamsApi
89258
- * @version 255.1.0
89817
+ * @version 256.0.0
89259
89818
  */
89260
89819
 
89261
89820
  /**
@@ -89598,7 +90157,7 @@ class TelephonyApi {
89598
90157
  /**
89599
90158
  * Telephony service.
89600
90159
  * @module purecloud-platform-client-v2/api/TelephonyApi
89601
- * @version 255.1.0
90160
+ * @version 256.0.0
89602
90161
  */
89603
90162
 
89604
90163
  /**
@@ -90272,7 +90831,7 @@ class TelephonyProvidersEdgeApi {
90272
90831
  /**
90273
90832
  * TelephonyProvidersEdge service.
90274
90833
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
90275
- * @version 255.1.0
90834
+ * @version 256.0.0
90276
90835
  */
90277
90836
 
90278
90837
  /**
@@ -94250,7 +94809,7 @@ class TextbotsApi {
94250
94809
  /**
94251
94810
  * Textbots service.
94252
94811
  * @module purecloud-platform-client-v2/api/TextbotsApi
94253
- * @version 255.1.0
94812
+ * @version 256.0.0
94254
94813
  */
94255
94814
 
94256
94815
  /**
@@ -94396,7 +94955,7 @@ class TokensApi {
94396
94955
  /**
94397
94956
  * Tokens service.
94398
94957
  * @module purecloud-platform-client-v2/api/TokensApi
94399
- * @version 255.1.0
94958
+ * @version 256.0.0
94400
94959
  */
94401
94960
 
94402
94961
  /**
@@ -94574,7 +95133,7 @@ class UploadsApi {
94574
95133
  /**
94575
95134
  * Uploads service.
94576
95135
  * @module purecloud-platform-client-v2/api/UploadsApi
94577
- * @version 255.1.0
95136
+ * @version 256.0.0
94578
95137
  */
94579
95138
 
94580
95139
  /**
@@ -94945,7 +95504,7 @@ class UsageApi {
94945
95504
  /**
94946
95505
  * Usage service.
94947
95506
  * @module purecloud-platform-client-v2/api/UsageApi
94948
- * @version 255.1.0
95507
+ * @version 256.0.0
94949
95508
  */
94950
95509
 
94951
95510
  /**
@@ -95323,7 +95882,7 @@ class UserRecordingsApi {
95323
95882
  /**
95324
95883
  * UserRecordings service.
95325
95884
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
95326
- * @version 255.1.0
95885
+ * @version 256.0.0
95327
95886
  */
95328
95887
 
95329
95888
  /**
@@ -95525,7 +96084,7 @@ class UsersApi {
95525
96084
  /**
95526
96085
  * Users service.
95527
96086
  * @module purecloud-platform-client-v2/api/UsersApi
95528
- * @version 255.1.0
96087
+ * @version 256.0.0
95529
96088
  */
95530
96089
 
95531
96090
  /**
@@ -99540,7 +100099,7 @@ class UsersRulesApi {
99540
100099
  /**
99541
100100
  * UsersRules service.
99542
100101
  * @module purecloud-platform-client-v2/api/UsersRulesApi
99543
- * @version 255.1.0
100102
+ * @version 256.0.0
99544
100103
  */
99545
100104
 
99546
100105
  /**
@@ -99857,7 +100416,7 @@ class UtilitiesApi {
99857
100416
  /**
99858
100417
  * Utilities service.
99859
100418
  * @module purecloud-platform-client-v2/api/UtilitiesApi
99860
- * @version 255.1.0
100419
+ * @version 256.0.0
99861
100420
  */
99862
100421
 
99863
100422
  /**
@@ -99985,7 +100544,7 @@ class VoicemailApi {
99985
100544
  /**
99986
100545
  * Voicemail service.
99987
100546
  * @module purecloud-platform-client-v2/api/VoicemailApi
99988
- * @version 255.1.0
100547
+ * @version 256.0.0
99989
100548
  */
99990
100549
 
99991
100550
  /**
@@ -100815,7 +101374,7 @@ class WebChatApi {
100815
101374
  /**
100816
101375
  * WebChat service.
100817
101376
  * @module purecloud-platform-client-v2/api/WebChatApi
100818
- * @version 255.1.0
101377
+ * @version 256.0.0
100819
101378
  */
100820
101379
 
100821
101380
  /**
@@ -101467,7 +102026,7 @@ class WebDeploymentsApi {
101467
102026
  /**
101468
102027
  * WebDeployments service.
101469
102028
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
101470
- * @version 255.1.0
102029
+ * @version 256.0.0
101471
102030
  */
101472
102031
 
101473
102032
  /**
@@ -102145,7 +102704,7 @@ class WebMessagingApi {
102145
102704
  /**
102146
102705
  * WebMessaging service.
102147
102706
  * @module purecloud-platform-client-v2/api/WebMessagingApi
102148
- * @version 255.1.0
102707
+ * @version 256.0.0
102149
102708
  */
102150
102709
 
102151
102710
  /**
@@ -102308,7 +102867,7 @@ class WidgetsApi {
102308
102867
  /**
102309
102868
  * Widgets service.
102310
102869
  * @module purecloud-platform-client-v2/api/WidgetsApi
102311
- * @version 255.1.0
102870
+ * @version 256.0.0
102312
102871
  */
102313
102872
 
102314
102873
  /**
@@ -102484,7 +103043,7 @@ class WorkforceManagementApi {
102484
103043
  /**
102485
103044
  * WorkforceManagement service.
102486
103045
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
102487
- * @version 255.1.0
103046
+ * @version 256.0.0
102488
103047
  */
102489
103048
 
102490
103049
  /**
@@ -104075,6 +104634,42 @@ class WorkforceManagementApi {
104075
104634
  );
104076
104635
  }
104077
104636
 
104637
+ /**
104638
+ * Get a capacity plan's forecast inputs
104639
+ *
104640
+ * @param {String} businessUnitId The ID of the business unit
104641
+ * @param {String} capacityPlanId The ID of the capacity plan
104642
+ * @param {Object} opts Optional parameters
104643
+ * @param {Object} opts.granularity Granularity to access capacity plan forecast data, defaults to weekly
104644
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
104645
+ */
104646
+ getWorkforcemanagementBusinessunitCapacityplanForecast(businessUnitId, capacityPlanId, opts) {
104647
+ opts = opts || {};
104648
+
104649
+ // verify the required parameter 'businessUnitId' is set
104650
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
104651
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanForecast';
104652
+ }
104653
+ // verify the required parameter 'capacityPlanId' is set
104654
+ if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
104655
+ throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplanForecast';
104656
+ }
104657
+
104658
+ return this.apiClient.callApi(
104659
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/forecast',
104660
+ 'GET',
104661
+ { 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
104662
+ { 'granularity': opts['granularity'] },
104663
+ { },
104664
+ { },
104665
+ null,
104666
+ ['PureCloud OAuth'],
104667
+ ['application/json'],
104668
+ ['application/json'],
104669
+ opts['customHeaders']
104670
+ );
104671
+ }
104672
+
104078
104673
  /**
104079
104674
  * Get a capacity plan's staffing group allocations
104080
104675
  *
@@ -113915,7 +114510,7 @@ class WorkforceManagementApi {
113915
114510
  * </pre>
113916
114511
  * </p>
113917
114512
  * @module purecloud-platform-client-v2/index
113918
- * @version 255.1.0
114513
+ * @version 256.0.0
113919
114514
  */
113920
114515
  class platformClient {
113921
114516
  constructor() {
@@ -114234,6 +114829,11 @@ class platformClient {
114234
114829
  * @property {module:purecloud-platform-client-v2/api/SCIMApi}
114235
114830
  */
114236
114831
  this.SCIMApi = SCIMApi;
114832
+ /**
114833
+ * The ScreenMonitoringApi service constructor.
114834
+ * @property {module:purecloud-platform-client-v2/api/ScreenMonitoringApi}
114835
+ */
114836
+ this.ScreenMonitoringApi = ScreenMonitoringApi;
114237
114837
  /**
114238
114838
  * The ScriptsApi service constructor.
114239
114839
  * @property {module:purecloud-platform-client-v2/api/ScriptsApi}