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.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +693 -93
- package/dist/web-amd/purecloud-platform-client-v2.js +693 -93
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +254 -94
- package/dist/web-cjs/purecloud-platform-client-v2.js +254 -94
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +362 -30
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +35 -1
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +151 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +2 -4
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenMonitoringApi.js +381 -0
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +37 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5,7 +5,7 @@ class LearningApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Learning service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 256.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -394,7 +394,6 @@ class LearningApi {
|
|
|
394
394
|
* Get all learning modules of an organization
|
|
395
395
|
*
|
|
396
396
|
* @param {Object} opts Optional parameters
|
|
397
|
-
* @param {Boolean} opts.isArchived Archive status (default to false)
|
|
398
397
|
* @param {Array.<String>} opts.types Specifies the module types. Informational, AssessedContent and Assessment are deprecated
|
|
399
398
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
400
399
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -402,7 +401,6 @@ class LearningApi {
|
|
|
402
401
|
* @param {Object} opts.sortBy Sort by (default to name)
|
|
403
402
|
* @param {String} opts.searchTerm Search Term (searchable by name)
|
|
404
403
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
405
|
-
* @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)
|
|
406
404
|
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
407
405
|
* @param {Array.<String>} opts.externalIds Specifies the module external IDs to filter by. Only one ID is allowed
|
|
408
406
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
@@ -415,7 +413,7 @@ class LearningApi {
|
|
|
415
413
|
'/api/v2/learning/modules',
|
|
416
414
|
'GET',
|
|
417
415
|
{ },
|
|
418
|
-
{ '
|
|
416
|
+
{ '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') },
|
|
419
417
|
{ },
|
|
420
418
|
{ },
|
|
421
419
|
null,
|
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 256.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1942,7 +1942,7 @@ class OutboundApi {
|
|
|
1942
1942
|
|
|
1943
1943
|
/**
|
|
1944
1944
|
* Query a list of contact lists.
|
|
1945
|
-
*
|
|
1945
|
+
* 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.
|
|
1946
1946
|
* @param {Object} opts Optional parameters
|
|
1947
1947
|
* @param {Boolean} opts.includeImportStatus Include import status (default to false)
|
|
1948
1948
|
* @param {Boolean} opts.includeSize Include size (default to false)
|
|
@@ -0,0 +1,381 @@
|
|
|
1
|
+
import ApiClient from '../ApiClient.js';
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class ScreenMonitoringApi {
|
|
5
|
+
/**
|
|
6
|
+
* ScreenMonitoring service.
|
|
7
|
+
* @module purecloud-platform-client-v2/api/ScreenMonitoringApi
|
|
8
|
+
* @version 256.0.0
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Constructs a new ScreenMonitoringApi.
|
|
13
|
+
* @alias module:purecloud-platform-client-v2/api/ScreenMonitoringApi
|
|
14
|
+
* @class
|
|
15
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
16
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
17
|
+
*/
|
|
18
|
+
constructor(apiClient) {
|
|
19
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Stop a conversation-level screen monitoring session.
|
|
25
|
+
*
|
|
26
|
+
* @param {String} conversationId Conversation ID
|
|
27
|
+
* @param {String} participantId Participant ID
|
|
28
|
+
* @param {String} screenMonitoringId Screen Monitoring ID
|
|
29
|
+
* @param {Object} opts Optional parameters
|
|
30
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
31
|
+
*/
|
|
32
|
+
deleteConversationParticipantScreenmonitorsSession(conversationId, participantId, screenMonitoringId, opts) {
|
|
33
|
+
opts = opts || {};
|
|
34
|
+
|
|
35
|
+
// verify the required parameter 'conversationId' is set
|
|
36
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
37
|
+
throw 'Missing the required parameter "conversationId" when calling deleteConversationParticipantScreenmonitorsSession';
|
|
38
|
+
}
|
|
39
|
+
// verify the required parameter 'participantId' is set
|
|
40
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
41
|
+
throw 'Missing the required parameter "participantId" when calling deleteConversationParticipantScreenmonitorsSession';
|
|
42
|
+
}
|
|
43
|
+
// verify the required parameter 'screenMonitoringId' is set
|
|
44
|
+
if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
|
|
45
|
+
throw 'Missing the required parameter "screenMonitoringId" when calling deleteConversationParticipantScreenmonitorsSession';
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
return this.apiClient.callApi(
|
|
49
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}',
|
|
50
|
+
'DELETE',
|
|
51
|
+
{ 'conversationId': conversationId,'participantId': participantId,'screenMonitoringId': screenMonitoringId },
|
|
52
|
+
{ },
|
|
53
|
+
{ },
|
|
54
|
+
{ },
|
|
55
|
+
null,
|
|
56
|
+
['PureCloud OAuth'],
|
|
57
|
+
['application/json'],
|
|
58
|
+
['application/json'],
|
|
59
|
+
opts['customHeaders']
|
|
60
|
+
);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Stop an agent-level screen monitoring session.
|
|
65
|
+
*
|
|
66
|
+
* @param {String} userId User ID
|
|
67
|
+
* @param {String} screenMonitoringId Screen Monitoring ID
|
|
68
|
+
* @param {Object} opts Optional parameters
|
|
69
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
70
|
+
*/
|
|
71
|
+
deleteUserScreenmonitorsSession(userId, screenMonitoringId, opts) {
|
|
72
|
+
opts = opts || {};
|
|
73
|
+
|
|
74
|
+
// verify the required parameter 'userId' is set
|
|
75
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
76
|
+
throw 'Missing the required parameter "userId" when calling deleteUserScreenmonitorsSession';
|
|
77
|
+
}
|
|
78
|
+
// verify the required parameter 'screenMonitoringId' is set
|
|
79
|
+
if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
|
|
80
|
+
throw 'Missing the required parameter "screenMonitoringId" when calling deleteUserScreenmonitorsSession';
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
return this.apiClient.callApi(
|
|
84
|
+
'/api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}',
|
|
85
|
+
'DELETE',
|
|
86
|
+
{ 'userId': userId,'screenMonitoringId': screenMonitoringId },
|
|
87
|
+
{ },
|
|
88
|
+
{ },
|
|
89
|
+
{ },
|
|
90
|
+
null,
|
|
91
|
+
['PureCloud OAuth'],
|
|
92
|
+
['application/json'],
|
|
93
|
+
['application/json'],
|
|
94
|
+
opts['customHeaders']
|
|
95
|
+
);
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
/**
|
|
99
|
+
* Get a conversation-level screen monitoring session object using the supplied screenMonitoringId.
|
|
100
|
+
*
|
|
101
|
+
* @param {String} conversationId Conversation ID
|
|
102
|
+
* @param {String} participantId Participant ID
|
|
103
|
+
* @param {String} screenMonitoringId Screen Monitoring ID
|
|
104
|
+
* @param {Object} opts Optional parameters
|
|
105
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106
|
+
*/
|
|
107
|
+
getConversationParticipantScreenmonitorsSession(conversationId, participantId, screenMonitoringId, opts) {
|
|
108
|
+
opts = opts || {};
|
|
109
|
+
|
|
110
|
+
// verify the required parameter 'conversationId' is set
|
|
111
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
112
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationParticipantScreenmonitorsSession';
|
|
113
|
+
}
|
|
114
|
+
// verify the required parameter 'participantId' is set
|
|
115
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
116
|
+
throw 'Missing the required parameter "participantId" when calling getConversationParticipantScreenmonitorsSession';
|
|
117
|
+
}
|
|
118
|
+
// verify the required parameter 'screenMonitoringId' is set
|
|
119
|
+
if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
|
|
120
|
+
throw 'Missing the required parameter "screenMonitoringId" when calling getConversationParticipantScreenmonitorsSession';
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
return this.apiClient.callApi(
|
|
124
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}',
|
|
125
|
+
'GET',
|
|
126
|
+
{ 'conversationId': conversationId,'participantId': participantId,'screenMonitoringId': screenMonitoringId },
|
|
127
|
+
{ },
|
|
128
|
+
{ },
|
|
129
|
+
{ },
|
|
130
|
+
null,
|
|
131
|
+
['PureCloud OAuth'],
|
|
132
|
+
['application/json'],
|
|
133
|
+
['application/json'],
|
|
134
|
+
opts['customHeaders']
|
|
135
|
+
);
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* Get the details of all screen monitoring sessions for the current organization.
|
|
140
|
+
*
|
|
141
|
+
* @param {Object} opts Optional parameters
|
|
142
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
143
|
+
*/
|
|
144
|
+
getScreenmonitorsSessionsDetails(opts) {
|
|
145
|
+
opts = opts || {};
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
return this.apiClient.callApi(
|
|
149
|
+
'/api/v2/screenmonitors/sessions/details',
|
|
150
|
+
'GET',
|
|
151
|
+
{ },
|
|
152
|
+
{ },
|
|
153
|
+
{ },
|
|
154
|
+
{ },
|
|
155
|
+
null,
|
|
156
|
+
['PureCloud OAuth'],
|
|
157
|
+
['application/json'],
|
|
158
|
+
['application/json'],
|
|
159
|
+
opts['customHeaders']
|
|
160
|
+
);
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* Get the Screen Monitor Settings for the Organization
|
|
165
|
+
*
|
|
166
|
+
* @param {Object} opts Optional parameters
|
|
167
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
168
|
+
*/
|
|
169
|
+
getScreenmonitorsSettings(opts) {
|
|
170
|
+
opts = opts || {};
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
return this.apiClient.callApi(
|
|
174
|
+
'/api/v2/screenmonitors/settings',
|
|
175
|
+
'GET',
|
|
176
|
+
{ },
|
|
177
|
+
{ },
|
|
178
|
+
{ },
|
|
179
|
+
{ },
|
|
180
|
+
null,
|
|
181
|
+
['PureCloud OAuth'],
|
|
182
|
+
['application/json'],
|
|
183
|
+
['application/json'],
|
|
184
|
+
opts['customHeaders']
|
|
185
|
+
);
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Get all screen monitoring sessions for the supplied userId.
|
|
190
|
+
*
|
|
191
|
+
* @param {String} userId User ID
|
|
192
|
+
* @param {Object} opts Optional parameters
|
|
193
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
194
|
+
*/
|
|
195
|
+
getScreenmonitorsUserSessions(userId, opts) {
|
|
196
|
+
opts = opts || {};
|
|
197
|
+
|
|
198
|
+
// verify the required parameter 'userId' is set
|
|
199
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
200
|
+
throw 'Missing the required parameter "userId" when calling getScreenmonitorsUserSessions';
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
return this.apiClient.callApi(
|
|
204
|
+
'/api/v2/screenmonitors/users/{userId}/sessions',
|
|
205
|
+
'GET',
|
|
206
|
+
{ 'userId': userId },
|
|
207
|
+
{ },
|
|
208
|
+
{ },
|
|
209
|
+
{ },
|
|
210
|
+
null,
|
|
211
|
+
['PureCloud OAuth'],
|
|
212
|
+
['application/json'],
|
|
213
|
+
['application/json'],
|
|
214
|
+
opts['customHeaders']
|
|
215
|
+
);
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
/**
|
|
219
|
+
* Get an agent-level screen monitoring session object using the supplied screenMonitoringId.
|
|
220
|
+
*
|
|
221
|
+
* @param {String} userId User ID
|
|
222
|
+
* @param {String} screenMonitoringId Screen Monitoring ID
|
|
223
|
+
* @param {Object} opts Optional parameters
|
|
224
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
225
|
+
*/
|
|
226
|
+
getUserScreenmonitorsSession(userId, screenMonitoringId, opts) {
|
|
227
|
+
opts = opts || {};
|
|
228
|
+
|
|
229
|
+
// verify the required parameter 'userId' is set
|
|
230
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
231
|
+
throw 'Missing the required parameter "userId" when calling getUserScreenmonitorsSession';
|
|
232
|
+
}
|
|
233
|
+
// verify the required parameter 'screenMonitoringId' is set
|
|
234
|
+
if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
|
|
235
|
+
throw 'Missing the required parameter "screenMonitoringId" when calling getUserScreenmonitorsSession';
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
return this.apiClient.callApi(
|
|
239
|
+
'/api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}',
|
|
240
|
+
'GET',
|
|
241
|
+
{ 'userId': userId,'screenMonitoringId': screenMonitoringId },
|
|
242
|
+
{ },
|
|
243
|
+
{ },
|
|
244
|
+
{ },
|
|
245
|
+
null,
|
|
246
|
+
['PureCloud OAuth'],
|
|
247
|
+
['application/json'],
|
|
248
|
+
['application/json'],
|
|
249
|
+
opts['customHeaders']
|
|
250
|
+
);
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* Start a conversation-level screen monitoring session.
|
|
255
|
+
*
|
|
256
|
+
* @param {String} conversationId Conversation ID
|
|
257
|
+
* @param {String} participantId Participant ID
|
|
258
|
+
* @param {Object} opts Optional parameters
|
|
259
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
260
|
+
*/
|
|
261
|
+
postConversationParticipantScreenmonitorsSessions(conversationId, participantId, opts) {
|
|
262
|
+
opts = opts || {};
|
|
263
|
+
|
|
264
|
+
// verify the required parameter 'conversationId' is set
|
|
265
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
266
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantScreenmonitorsSessions';
|
|
267
|
+
}
|
|
268
|
+
// verify the required parameter 'participantId' is set
|
|
269
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
270
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantScreenmonitorsSessions';
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
return this.apiClient.callApi(
|
|
274
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions',
|
|
275
|
+
'POST',
|
|
276
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
277
|
+
{ },
|
|
278
|
+
{ },
|
|
279
|
+
{ },
|
|
280
|
+
null,
|
|
281
|
+
['PureCloud OAuth'],
|
|
282
|
+
['application/json'],
|
|
283
|
+
['application/json'],
|
|
284
|
+
opts['customHeaders']
|
|
285
|
+
);
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* Get screen monitor session details for one or more users.
|
|
290
|
+
*
|
|
291
|
+
* @param {Array.<String>} body List of target user IDs
|
|
292
|
+
* @param {Object} opts Optional parameters
|
|
293
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
294
|
+
*/
|
|
295
|
+
postScreenmonitorsSessionsUsersDetails(body, opts) {
|
|
296
|
+
opts = opts || {};
|
|
297
|
+
|
|
298
|
+
// verify the required parameter 'body' is set
|
|
299
|
+
if (body === undefined || body === null) {
|
|
300
|
+
throw 'Missing the required parameter "body" when calling postScreenmonitorsSessionsUsersDetails';
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
return this.apiClient.callApi(
|
|
304
|
+
'/api/v2/screenmonitors/sessions/users/details',
|
|
305
|
+
'POST',
|
|
306
|
+
{ },
|
|
307
|
+
{ },
|
|
308
|
+
{ },
|
|
309
|
+
{ },
|
|
310
|
+
body,
|
|
311
|
+
['PureCloud OAuth'],
|
|
312
|
+
['application/json'],
|
|
313
|
+
['application/json'],
|
|
314
|
+
opts['customHeaders']
|
|
315
|
+
);
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* Start an agent-level screen monitoring session.
|
|
320
|
+
*
|
|
321
|
+
* @param {String} userId User ID
|
|
322
|
+
* @param {Object} opts Optional parameters
|
|
323
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
324
|
+
*/
|
|
325
|
+
postUserScreenmonitorsSessions(userId, opts) {
|
|
326
|
+
opts = opts || {};
|
|
327
|
+
|
|
328
|
+
// verify the required parameter 'userId' is set
|
|
329
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
330
|
+
throw 'Missing the required parameter "userId" when calling postUserScreenmonitorsSessions';
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
return this.apiClient.callApi(
|
|
334
|
+
'/api/v2/users/{userId}/screenmonitors/sessions',
|
|
335
|
+
'POST',
|
|
336
|
+
{ 'userId': userId },
|
|
337
|
+
{ },
|
|
338
|
+
{ },
|
|
339
|
+
{ },
|
|
340
|
+
null,
|
|
341
|
+
['PureCloud OAuth'],
|
|
342
|
+
['application/json'],
|
|
343
|
+
['application/json'],
|
|
344
|
+
opts['customHeaders']
|
|
345
|
+
);
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
/**
|
|
349
|
+
* Update the Screen Monitor Settings for the Organization
|
|
350
|
+
*
|
|
351
|
+
* @param {Object} body Screen Monitor settings
|
|
352
|
+
* @param {Object} opts Optional parameters
|
|
353
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
354
|
+
*/
|
|
355
|
+
putScreenmonitorsSettings(body, opts) {
|
|
356
|
+
opts = opts || {};
|
|
357
|
+
|
|
358
|
+
// verify the required parameter 'body' is set
|
|
359
|
+
if (body === undefined || body === null) {
|
|
360
|
+
throw 'Missing the required parameter "body" when calling putScreenmonitorsSettings';
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
return this.apiClient.callApi(
|
|
364
|
+
'/api/v2/screenmonitors/settings',
|
|
365
|
+
'PUT',
|
|
366
|
+
{ },
|
|
367
|
+
{ },
|
|
368
|
+
{ },
|
|
369
|
+
{ },
|
|
370
|
+
body,
|
|
371
|
+
['PureCloud OAuth'],
|
|
372
|
+
['application/json'],
|
|
373
|
+
['application/json'],
|
|
374
|
+
opts['customHeaders']
|
|
375
|
+
);
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
export default ScreenMonitoringApi;
|