purecloud-platform-client-v2 249.0.0 → 250.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 +34 -3
- package/dist/node/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +10600 -2242
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
- package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
- package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
- package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
- package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
- package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
- package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
- package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class RecordingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Recording service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -26,8 +26,12 @@ class RecordingApi {
|
|
|
26
26
|
* @param {String} conversationId Conversation ID
|
|
27
27
|
* @param {String} recordingId Recording ID
|
|
28
28
|
* @param {String} annotationId Annotation ID
|
|
29
|
+
* @param {Object} opts Optional parameters
|
|
30
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29
31
|
*/
|
|
30
|
-
deleteConversationRecordingAnnotation(conversationId, recordingId, annotationId) {
|
|
32
|
+
deleteConversationRecordingAnnotation(conversationId, recordingId, annotationId, opts) {
|
|
33
|
+
opts = opts || {};
|
|
34
|
+
|
|
31
35
|
// verify the required parameter 'conversationId' is set
|
|
32
36
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
33
37
|
throw 'Missing the required parameter "conversationId" when calling deleteConversationRecordingAnnotation';
|
|
@@ -51,7 +55,8 @@ class RecordingApi {
|
|
|
51
55
|
null,
|
|
52
56
|
['PureCloud OAuth'],
|
|
53
57
|
['application/json'],
|
|
54
|
-
['application/json']
|
|
58
|
+
['application/json'],
|
|
59
|
+
opts['customHeaders']
|
|
55
60
|
);
|
|
56
61
|
}
|
|
57
62
|
|
|
@@ -59,8 +64,12 @@ class RecordingApi {
|
|
|
59
64
|
* Deletes a single orphan recording
|
|
60
65
|
*
|
|
61
66
|
* @param {String} orphanId Orphan ID
|
|
67
|
+
* @param {Object} opts Optional parameters
|
|
68
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
62
69
|
*/
|
|
63
|
-
deleteOrphanrecording(orphanId) {
|
|
70
|
+
deleteOrphanrecording(orphanId, opts) {
|
|
71
|
+
opts = opts || {};
|
|
72
|
+
|
|
64
73
|
// verify the required parameter 'orphanId' is set
|
|
65
74
|
if (orphanId === undefined || orphanId === null || orphanId === '') {
|
|
66
75
|
throw 'Missing the required parameter "orphanId" when calling deleteOrphanrecording';
|
|
@@ -76,7 +85,8 @@ class RecordingApi {
|
|
|
76
85
|
null,
|
|
77
86
|
['PureCloud OAuth'],
|
|
78
87
|
['application/json'],
|
|
79
|
-
['application/json']
|
|
88
|
+
['application/json'],
|
|
89
|
+
opts['customHeaders']
|
|
80
90
|
);
|
|
81
91
|
}
|
|
82
92
|
|
|
@@ -84,8 +94,12 @@ class RecordingApi {
|
|
|
84
94
|
* Delete media retention policies
|
|
85
95
|
* Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
|
|
86
96
|
* @param {String} ids
|
|
97
|
+
* @param {Object} opts Optional parameters
|
|
98
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
87
99
|
*/
|
|
88
|
-
deleteRecordingCrossplatformMediaretentionpolicies(ids) {
|
|
100
|
+
deleteRecordingCrossplatformMediaretentionpolicies(ids, opts) {
|
|
101
|
+
opts = opts || {};
|
|
102
|
+
|
|
89
103
|
// verify the required parameter 'ids' is set
|
|
90
104
|
if (ids === undefined || ids === null) {
|
|
91
105
|
throw 'Missing the required parameter "ids" when calling deleteRecordingCrossplatformMediaretentionpolicies';
|
|
@@ -101,7 +115,8 @@ class RecordingApi {
|
|
|
101
115
|
null,
|
|
102
116
|
['PureCloud OAuth'],
|
|
103
117
|
['application/json'],
|
|
104
|
-
['application/json']
|
|
118
|
+
['application/json'],
|
|
119
|
+
opts['customHeaders']
|
|
105
120
|
);
|
|
106
121
|
}
|
|
107
122
|
|
|
@@ -109,8 +124,12 @@ class RecordingApi {
|
|
|
109
124
|
* Delete a media retention policy
|
|
110
125
|
*
|
|
111
126
|
* @param {String} policyId Policy ID
|
|
127
|
+
* @param {Object} opts Optional parameters
|
|
128
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
112
129
|
*/
|
|
113
|
-
deleteRecordingCrossplatformMediaretentionpolicy(policyId) {
|
|
130
|
+
deleteRecordingCrossplatformMediaretentionpolicy(policyId, opts) {
|
|
131
|
+
opts = opts || {};
|
|
132
|
+
|
|
114
133
|
// verify the required parameter 'policyId' is set
|
|
115
134
|
if (policyId === undefined || policyId === null || policyId === '') {
|
|
116
135
|
throw 'Missing the required parameter "policyId" when calling deleteRecordingCrossplatformMediaretentionpolicy';
|
|
@@ -126,7 +145,8 @@ class RecordingApi {
|
|
|
126
145
|
null,
|
|
127
146
|
['PureCloud OAuth'],
|
|
128
147
|
['application/json'],
|
|
129
|
-
['application/json']
|
|
148
|
+
['application/json'],
|
|
149
|
+
opts['customHeaders']
|
|
130
150
|
);
|
|
131
151
|
}
|
|
132
152
|
|
|
@@ -134,8 +154,12 @@ class RecordingApi {
|
|
|
134
154
|
* Delete the recording bulk job
|
|
135
155
|
*
|
|
136
156
|
* @param {String} jobId jobId
|
|
157
|
+
* @param {Object} opts Optional parameters
|
|
158
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
137
159
|
*/
|
|
138
|
-
deleteRecordingJob(jobId) {
|
|
160
|
+
deleteRecordingJob(jobId, opts) {
|
|
161
|
+
opts = opts || {};
|
|
162
|
+
|
|
139
163
|
// verify the required parameter 'jobId' is set
|
|
140
164
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
141
165
|
throw 'Missing the required parameter "jobId" when calling deleteRecordingJob';
|
|
@@ -151,7 +175,8 @@ class RecordingApi {
|
|
|
151
175
|
null,
|
|
152
176
|
['PureCloud OAuth'],
|
|
153
177
|
['application/json'],
|
|
154
|
-
['application/json']
|
|
178
|
+
['application/json'],
|
|
179
|
+
opts['customHeaders']
|
|
155
180
|
);
|
|
156
181
|
}
|
|
157
182
|
|
|
@@ -159,8 +184,12 @@ class RecordingApi {
|
|
|
159
184
|
* Delete media retention policies
|
|
160
185
|
* Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
|
|
161
186
|
* @param {String} ids
|
|
187
|
+
* @param {Object} opts Optional parameters
|
|
188
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
162
189
|
*/
|
|
163
|
-
deleteRecordingMediaretentionpolicies(ids) {
|
|
190
|
+
deleteRecordingMediaretentionpolicies(ids, opts) {
|
|
191
|
+
opts = opts || {};
|
|
192
|
+
|
|
164
193
|
// verify the required parameter 'ids' is set
|
|
165
194
|
if (ids === undefined || ids === null) {
|
|
166
195
|
throw 'Missing the required parameter "ids" when calling deleteRecordingMediaretentionpolicies';
|
|
@@ -176,7 +205,8 @@ class RecordingApi {
|
|
|
176
205
|
null,
|
|
177
206
|
['PureCloud OAuth'],
|
|
178
207
|
['application/json'],
|
|
179
|
-
['application/json']
|
|
208
|
+
['application/json'],
|
|
209
|
+
opts['customHeaders']
|
|
180
210
|
);
|
|
181
211
|
}
|
|
182
212
|
|
|
@@ -184,8 +214,12 @@ class RecordingApi {
|
|
|
184
214
|
* Delete a media retention policy
|
|
185
215
|
*
|
|
186
216
|
* @param {String} policyId Policy ID
|
|
217
|
+
* @param {Object} opts Optional parameters
|
|
218
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
187
219
|
*/
|
|
188
|
-
deleteRecordingMediaretentionpolicy(policyId) {
|
|
220
|
+
deleteRecordingMediaretentionpolicy(policyId, opts) {
|
|
221
|
+
opts = opts || {};
|
|
222
|
+
|
|
189
223
|
// verify the required parameter 'policyId' is set
|
|
190
224
|
if (policyId === undefined || policyId === null || policyId === '') {
|
|
191
225
|
throw 'Missing the required parameter "policyId" when calling deleteRecordingMediaretentionpolicy';
|
|
@@ -201,13 +235,14 @@ class RecordingApi {
|
|
|
201
235
|
null,
|
|
202
236
|
['PureCloud OAuth'],
|
|
203
237
|
['application/json'],
|
|
204
|
-
['application/json']
|
|
238
|
+
['application/json'],
|
|
239
|
+
opts['customHeaders']
|
|
205
240
|
);
|
|
206
241
|
}
|
|
207
242
|
|
|
208
243
|
/**
|
|
209
244
|
* Gets a specific recording.
|
|
210
|
-
*
|
|
245
|
+
* Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.
|
|
211
246
|
* @param {String} conversationId Conversation ID
|
|
212
247
|
* @param {String} recordingId Recording ID
|
|
213
248
|
* @param {Object} opts Optional parameters
|
|
@@ -219,6 +254,7 @@ class RecordingApi {
|
|
|
219
254
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
220
255
|
* @param {String} opts.locale The locale for the requested file when downloading or for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
221
256
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
257
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
222
258
|
*/
|
|
223
259
|
getConversationRecording(conversationId, recordingId, opts) {
|
|
224
260
|
opts = opts || {};
|
|
@@ -242,7 +278,8 @@ class RecordingApi {
|
|
|
242
278
|
null,
|
|
243
279
|
['PureCloud OAuth'],
|
|
244
280
|
['application/json'],
|
|
245
|
-
['application/json']
|
|
281
|
+
['application/json'],
|
|
282
|
+
opts['customHeaders']
|
|
246
283
|
);
|
|
247
284
|
}
|
|
248
285
|
|
|
@@ -252,8 +289,12 @@ class RecordingApi {
|
|
|
252
289
|
* @param {String} conversationId Conversation ID
|
|
253
290
|
* @param {String} recordingId Recording ID
|
|
254
291
|
* @param {String} annotationId Annotation ID
|
|
292
|
+
* @param {Object} opts Optional parameters
|
|
293
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
255
294
|
*/
|
|
256
|
-
getConversationRecordingAnnotation(conversationId, recordingId, annotationId) {
|
|
295
|
+
getConversationRecordingAnnotation(conversationId, recordingId, annotationId, opts) {
|
|
296
|
+
opts = opts || {};
|
|
297
|
+
|
|
257
298
|
// verify the required parameter 'conversationId' is set
|
|
258
299
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
259
300
|
throw 'Missing the required parameter "conversationId" when calling getConversationRecordingAnnotation';
|
|
@@ -277,7 +318,8 @@ class RecordingApi {
|
|
|
277
318
|
null,
|
|
278
319
|
['PureCloud OAuth'],
|
|
279
320
|
['application/json'],
|
|
280
|
-
['application/json']
|
|
321
|
+
['application/json'],
|
|
322
|
+
opts['customHeaders']
|
|
281
323
|
);
|
|
282
324
|
}
|
|
283
325
|
|
|
@@ -286,8 +328,12 @@ class RecordingApi {
|
|
|
286
328
|
*
|
|
287
329
|
* @param {String} conversationId Conversation ID
|
|
288
330
|
* @param {String} recordingId Recording ID
|
|
331
|
+
* @param {Object} opts Optional parameters
|
|
332
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
289
333
|
*/
|
|
290
|
-
getConversationRecordingAnnotations(conversationId, recordingId) {
|
|
334
|
+
getConversationRecordingAnnotations(conversationId, recordingId, opts) {
|
|
335
|
+
opts = opts || {};
|
|
336
|
+
|
|
291
337
|
// verify the required parameter 'conversationId' is set
|
|
292
338
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
293
339
|
throw 'Missing the required parameter "conversationId" when calling getConversationRecordingAnnotations';
|
|
@@ -307,7 +353,8 @@ class RecordingApi {
|
|
|
307
353
|
null,
|
|
308
354
|
['PureCloud OAuth'],
|
|
309
355
|
['application/json'],
|
|
310
|
-
['application/json']
|
|
356
|
+
['application/json'],
|
|
357
|
+
opts['customHeaders']
|
|
311
358
|
);
|
|
312
359
|
}
|
|
313
360
|
|
|
@@ -315,8 +362,12 @@ class RecordingApi {
|
|
|
315
362
|
* Get recording metadata for a conversation. Does not return playable media nor system annotations. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.
|
|
316
363
|
*
|
|
317
364
|
* @param {String} conversationId Conversation ID
|
|
365
|
+
* @param {Object} opts Optional parameters
|
|
366
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
318
367
|
*/
|
|
319
|
-
getConversationRecordingmetadata(conversationId) {
|
|
368
|
+
getConversationRecordingmetadata(conversationId, opts) {
|
|
369
|
+
opts = opts || {};
|
|
370
|
+
|
|
320
371
|
// verify the required parameter 'conversationId' is set
|
|
321
372
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
322
373
|
throw 'Missing the required parameter "conversationId" when calling getConversationRecordingmetadata';
|
|
@@ -332,17 +383,22 @@ class RecordingApi {
|
|
|
332
383
|
null,
|
|
333
384
|
['PureCloud OAuth'],
|
|
334
385
|
['application/json'],
|
|
335
|
-
['application/json']
|
|
386
|
+
['application/json'],
|
|
387
|
+
opts['customHeaders']
|
|
336
388
|
);
|
|
337
389
|
}
|
|
338
390
|
|
|
339
391
|
/**
|
|
340
|
-
* Get metadata for a specific recording. Does not return playable media.
|
|
392
|
+
* Get metadata for a specific recording. Does not return playable media. Bookmark annotations will be excluded if either recording:recording:view or recording:annotation:view permission is missing.
|
|
341
393
|
*
|
|
342
394
|
* @param {String} conversationId Conversation ID
|
|
343
395
|
* @param {String} recordingId Recording ID
|
|
396
|
+
* @param {Object} opts Optional parameters
|
|
397
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
344
398
|
*/
|
|
345
|
-
getConversationRecordingmetadataRecordingId(conversationId, recordingId) {
|
|
399
|
+
getConversationRecordingmetadataRecordingId(conversationId, recordingId, opts) {
|
|
400
|
+
opts = opts || {};
|
|
401
|
+
|
|
346
402
|
// verify the required parameter 'conversationId' is set
|
|
347
403
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
348
404
|
throw 'Missing the required parameter "conversationId" when calling getConversationRecordingmetadataRecordingId';
|
|
@@ -362,13 +418,14 @@ class RecordingApi {
|
|
|
362
418
|
null,
|
|
363
419
|
['PureCloud OAuth'],
|
|
364
420
|
['application/json'],
|
|
365
|
-
['application/json']
|
|
421
|
+
['application/json'],
|
|
422
|
+
opts['customHeaders']
|
|
366
423
|
);
|
|
367
424
|
}
|
|
368
425
|
|
|
369
426
|
/**
|
|
370
427
|
* Get all of a Conversation's Recordings.
|
|
371
|
-
*
|
|
428
|
+
* Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted.
|
|
372
429
|
* @param {String} conversationId Conversation ID
|
|
373
430
|
* @param {Object} opts Optional parameters
|
|
374
431
|
* @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
|
|
@@ -376,6 +433,7 @@ class RecordingApi {
|
|
|
376
433
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
377
434
|
* @param {String} opts.locale The locale used for redacting sensitive information in requested files, as an ISO 639-1 code
|
|
378
435
|
* @param {Boolean} opts.includePauseAnnotationsForScreenRecordings Include applicable Secure Pause annotations from all audio recordings to all screen recordings (default to false)
|
|
436
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
379
437
|
*/
|
|
380
438
|
getConversationRecordings(conversationId, opts) {
|
|
381
439
|
opts = opts || {};
|
|
@@ -395,7 +453,8 @@ class RecordingApi {
|
|
|
395
453
|
null,
|
|
396
454
|
['PureCloud OAuth'],
|
|
397
455
|
['application/json'],
|
|
398
|
-
['application/json']
|
|
456
|
+
['application/json'],
|
|
457
|
+
opts['customHeaders']
|
|
399
458
|
);
|
|
400
459
|
}
|
|
401
460
|
|
|
@@ -403,8 +462,12 @@ class RecordingApi {
|
|
|
403
462
|
* Gets a single orphan recording
|
|
404
463
|
*
|
|
405
464
|
* @param {String} orphanId Orphan ID
|
|
465
|
+
* @param {Object} opts Optional parameters
|
|
466
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
406
467
|
*/
|
|
407
|
-
getOrphanrecording(orphanId) {
|
|
468
|
+
getOrphanrecording(orphanId, opts) {
|
|
469
|
+
opts = opts || {};
|
|
470
|
+
|
|
408
471
|
// verify the required parameter 'orphanId' is set
|
|
409
472
|
if (orphanId === undefined || orphanId === null || orphanId === '') {
|
|
410
473
|
throw 'Missing the required parameter "orphanId" when calling getOrphanrecording';
|
|
@@ -420,7 +483,8 @@ class RecordingApi {
|
|
|
420
483
|
null,
|
|
421
484
|
['PureCloud OAuth'],
|
|
422
485
|
['application/json'],
|
|
423
|
-
['application/json']
|
|
486
|
+
['application/json'],
|
|
487
|
+
opts['customHeaders']
|
|
424
488
|
);
|
|
425
489
|
}
|
|
426
490
|
|
|
@@ -437,6 +501,7 @@ class RecordingApi {
|
|
|
437
501
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
438
502
|
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
439
503
|
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
504
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
440
505
|
*/
|
|
441
506
|
getOrphanrecordingMedia(orphanId, opts) {
|
|
442
507
|
opts = opts || {};
|
|
@@ -456,7 +521,8 @@ class RecordingApi {
|
|
|
456
521
|
null,
|
|
457
522
|
['PureCloud OAuth'],
|
|
458
523
|
['application/json'],
|
|
459
|
-
['application/json']
|
|
524
|
+
['application/json'],
|
|
525
|
+
opts['customHeaders']
|
|
460
526
|
);
|
|
461
527
|
}
|
|
462
528
|
|
|
@@ -472,6 +538,7 @@ class RecordingApi {
|
|
|
472
538
|
* @param {String} opts.previousPage Previous page token
|
|
473
539
|
* @param {Boolean} opts.hasConversation Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. (default to false)
|
|
474
540
|
* @param {Object} opts.media Filter resulting orphans based on their media type
|
|
541
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
475
542
|
*/
|
|
476
543
|
getOrphanrecordings(opts) {
|
|
477
544
|
opts = opts || {};
|
|
@@ -487,7 +554,8 @@ class RecordingApi {
|
|
|
487
554
|
null,
|
|
488
555
|
['PureCloud OAuth'],
|
|
489
556
|
['application/json'],
|
|
490
|
-
['application/json']
|
|
557
|
+
['application/json'],
|
|
558
|
+
opts['customHeaders']
|
|
491
559
|
);
|
|
492
560
|
}
|
|
493
561
|
|
|
@@ -495,8 +563,12 @@ class RecordingApi {
|
|
|
495
563
|
* Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results.
|
|
496
564
|
*
|
|
497
565
|
* @param {String} jobId jobId
|
|
566
|
+
* @param {Object} opts Optional parameters
|
|
567
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
498
568
|
*/
|
|
499
|
-
getRecordingBatchrequest(jobId) {
|
|
569
|
+
getRecordingBatchrequest(jobId, opts) {
|
|
570
|
+
opts = opts || {};
|
|
571
|
+
|
|
500
572
|
// verify the required parameter 'jobId' is set
|
|
501
573
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
502
574
|
throw 'Missing the required parameter "jobId" when calling getRecordingBatchrequest';
|
|
@@ -512,7 +584,8 @@ class RecordingApi {
|
|
|
512
584
|
null,
|
|
513
585
|
['PureCloud OAuth'],
|
|
514
586
|
['application/json'],
|
|
515
|
-
['application/json']
|
|
587
|
+
['application/json'],
|
|
588
|
+
opts['customHeaders']
|
|
516
589
|
);
|
|
517
590
|
}
|
|
518
591
|
|
|
@@ -531,6 +604,7 @@ class RecordingApi {
|
|
|
531
604
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
532
605
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
533
606
|
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
607
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
534
608
|
*/
|
|
535
609
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
536
610
|
opts = opts || {};
|
|
@@ -546,7 +620,8 @@ class RecordingApi {
|
|
|
546
620
|
null,
|
|
547
621
|
['PureCloud OAuth'],
|
|
548
622
|
['application/json'],
|
|
549
|
-
['application/json']
|
|
623
|
+
['application/json'],
|
|
624
|
+
opts['customHeaders']
|
|
550
625
|
);
|
|
551
626
|
}
|
|
552
627
|
|
|
@@ -554,8 +629,12 @@ class RecordingApi {
|
|
|
554
629
|
* Get a media retention policy
|
|
555
630
|
*
|
|
556
631
|
* @param {String} policyId Policy ID
|
|
632
|
+
* @param {Object} opts Optional parameters
|
|
633
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
557
634
|
*/
|
|
558
|
-
getRecordingCrossplatformMediaretentionpolicy(policyId) {
|
|
635
|
+
getRecordingCrossplatformMediaretentionpolicy(policyId, opts) {
|
|
636
|
+
opts = opts || {};
|
|
637
|
+
|
|
559
638
|
// verify the required parameter 'policyId' is set
|
|
560
639
|
if (policyId === undefined || policyId === null || policyId === '') {
|
|
561
640
|
throw 'Missing the required parameter "policyId" when calling getRecordingCrossplatformMediaretentionpolicy';
|
|
@@ -571,7 +650,8 @@ class RecordingApi {
|
|
|
571
650
|
null,
|
|
572
651
|
['PureCloud OAuth'],
|
|
573
652
|
['application/json'],
|
|
574
|
-
['application/json']
|
|
653
|
+
['application/json'],
|
|
654
|
+
opts['customHeaders']
|
|
575
655
|
);
|
|
576
656
|
}
|
|
577
657
|
|
|
@@ -579,8 +659,12 @@ class RecordingApi {
|
|
|
579
659
|
* Get the status of the job associated with the job id.
|
|
580
660
|
*
|
|
581
661
|
* @param {String} jobId jobId
|
|
662
|
+
* @param {Object} opts Optional parameters
|
|
663
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
582
664
|
*/
|
|
583
|
-
getRecordingJob(jobId) {
|
|
665
|
+
getRecordingJob(jobId, opts) {
|
|
666
|
+
opts = opts || {};
|
|
667
|
+
|
|
584
668
|
// verify the required parameter 'jobId' is set
|
|
585
669
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
586
670
|
throw 'Missing the required parameter "jobId" when calling getRecordingJob';
|
|
@@ -596,7 +680,8 @@ class RecordingApi {
|
|
|
596
680
|
null,
|
|
597
681
|
['PureCloud OAuth'],
|
|
598
682
|
['application/json'],
|
|
599
|
-
['application/json']
|
|
683
|
+
['application/json'],
|
|
684
|
+
opts['customHeaders']
|
|
600
685
|
);
|
|
601
686
|
}
|
|
602
687
|
|
|
@@ -609,6 +694,7 @@ class RecordingApi {
|
|
|
609
694
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
610
695
|
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
|
|
611
696
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
697
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
612
698
|
*/
|
|
613
699
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
614
700
|
opts = opts || {};
|
|
@@ -628,7 +714,8 @@ class RecordingApi {
|
|
|
628
714
|
null,
|
|
629
715
|
['PureCloud OAuth'],
|
|
630
716
|
['application/json'],
|
|
631
|
-
['application/json']
|
|
717
|
+
['application/json'],
|
|
718
|
+
opts['customHeaders']
|
|
632
719
|
);
|
|
633
720
|
}
|
|
634
721
|
|
|
@@ -644,6 +731,7 @@ class RecordingApi {
|
|
|
644
731
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
645
732
|
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
|
|
646
733
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
734
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
647
735
|
*/
|
|
648
736
|
getRecordingJobs(opts) {
|
|
649
737
|
opts = opts || {};
|
|
@@ -659,7 +747,8 @@ class RecordingApi {
|
|
|
659
747
|
null,
|
|
660
748
|
['PureCloud OAuth'],
|
|
661
749
|
['application/json'],
|
|
662
|
-
['application/json']
|
|
750
|
+
['application/json'],
|
|
751
|
+
opts['customHeaders']
|
|
663
752
|
);
|
|
664
753
|
}
|
|
665
754
|
|
|
@@ -667,8 +756,12 @@ class RecordingApi {
|
|
|
667
756
|
* Get the encryption key configurations
|
|
668
757
|
*
|
|
669
758
|
* @param {String} keyConfigurationId Key Configurations Id
|
|
759
|
+
* @param {Object} opts Optional parameters
|
|
760
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
670
761
|
*/
|
|
671
|
-
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
762
|
+
getRecordingKeyconfiguration(keyConfigurationId, opts) {
|
|
763
|
+
opts = opts || {};
|
|
764
|
+
|
|
672
765
|
// verify the required parameter 'keyConfigurationId' is set
|
|
673
766
|
if (keyConfigurationId === undefined || keyConfigurationId === null || keyConfigurationId === '') {
|
|
674
767
|
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
@@ -684,15 +777,20 @@ class RecordingApi {
|
|
|
684
777
|
null,
|
|
685
778
|
['PureCloud OAuth'],
|
|
686
779
|
['application/json'],
|
|
687
|
-
['application/json']
|
|
780
|
+
['application/json'],
|
|
781
|
+
opts['customHeaders']
|
|
688
782
|
);
|
|
689
783
|
}
|
|
690
784
|
|
|
691
785
|
/**
|
|
692
786
|
* Get a list of key configurations data
|
|
693
787
|
*
|
|
788
|
+
* @param {Object} opts Optional parameters
|
|
789
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
694
790
|
*/
|
|
695
|
-
getRecordingKeyconfigurations() {
|
|
791
|
+
getRecordingKeyconfigurations(opts) {
|
|
792
|
+
opts = opts || {};
|
|
793
|
+
|
|
696
794
|
|
|
697
795
|
return this.apiClient.callApi(
|
|
698
796
|
'/api/v2/recording/keyconfigurations',
|
|
@@ -704,7 +802,8 @@ class RecordingApi {
|
|
|
704
802
|
null,
|
|
705
803
|
['PureCloud OAuth'],
|
|
706
804
|
['application/json'],
|
|
707
|
-
['application/json']
|
|
805
|
+
['application/json'],
|
|
806
|
+
opts['customHeaders']
|
|
708
807
|
);
|
|
709
808
|
}
|
|
710
809
|
|
|
@@ -723,6 +822,7 @@ class RecordingApi {
|
|
|
723
822
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
724
823
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
725
824
|
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
825
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
726
826
|
*/
|
|
727
827
|
getRecordingMediaretentionpolicies(opts) {
|
|
728
828
|
opts = opts || {};
|
|
@@ -738,7 +838,8 @@ class RecordingApi {
|
|
|
738
838
|
null,
|
|
739
839
|
['PureCloud OAuth'],
|
|
740
840
|
['application/json'],
|
|
741
|
-
['application/json']
|
|
841
|
+
['application/json'],
|
|
842
|
+
opts['customHeaders']
|
|
742
843
|
);
|
|
743
844
|
}
|
|
744
845
|
|
|
@@ -746,8 +847,12 @@ class RecordingApi {
|
|
|
746
847
|
* Get a media retention policy
|
|
747
848
|
*
|
|
748
849
|
* @param {String} policyId Policy ID
|
|
850
|
+
* @param {Object} opts Optional parameters
|
|
851
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
749
852
|
*/
|
|
750
|
-
getRecordingMediaretentionpolicy(policyId) {
|
|
853
|
+
getRecordingMediaretentionpolicy(policyId, opts) {
|
|
854
|
+
opts = opts || {};
|
|
855
|
+
|
|
751
856
|
// verify the required parameter 'policyId' is set
|
|
752
857
|
if (policyId === undefined || policyId === null || policyId === '') {
|
|
753
858
|
throw 'Missing the required parameter "policyId" when calling getRecordingMediaretentionpolicy';
|
|
@@ -763,7 +868,8 @@ class RecordingApi {
|
|
|
763
868
|
null,
|
|
764
869
|
['PureCloud OAuth'],
|
|
765
870
|
['application/json'],
|
|
766
|
-
['application/json']
|
|
871
|
+
['application/json'],
|
|
872
|
+
opts['customHeaders']
|
|
767
873
|
);
|
|
768
874
|
}
|
|
769
875
|
|
|
@@ -773,6 +879,7 @@ class RecordingApi {
|
|
|
773
879
|
* @param {Object} opts Optional parameters
|
|
774
880
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
775
881
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
882
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
776
883
|
*/
|
|
777
884
|
getRecordingRecordingkeys(opts) {
|
|
778
885
|
opts = opts || {};
|
|
@@ -788,15 +895,20 @@ class RecordingApi {
|
|
|
788
895
|
null,
|
|
789
896
|
['PureCloud OAuth'],
|
|
790
897
|
['application/json'],
|
|
791
|
-
['application/json']
|
|
898
|
+
['application/json'],
|
|
899
|
+
opts['customHeaders']
|
|
792
900
|
);
|
|
793
901
|
}
|
|
794
902
|
|
|
795
903
|
/**
|
|
796
904
|
* Get key rotation schedule
|
|
797
905
|
*
|
|
906
|
+
* @param {Object} opts Optional parameters
|
|
907
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
798
908
|
*/
|
|
799
|
-
getRecordingRecordingkeysRotationschedule() {
|
|
909
|
+
getRecordingRecordingkeysRotationschedule(opts) {
|
|
910
|
+
opts = opts || {};
|
|
911
|
+
|
|
800
912
|
|
|
801
913
|
return this.apiClient.callApi(
|
|
802
914
|
'/api/v2/recording/recordingkeys/rotationschedule',
|
|
@@ -808,7 +920,8 @@ class RecordingApi {
|
|
|
808
920
|
null,
|
|
809
921
|
['PureCloud OAuth'],
|
|
810
922
|
['application/json'],
|
|
811
|
-
['application/json']
|
|
923
|
+
['application/json'],
|
|
924
|
+
opts['customHeaders']
|
|
812
925
|
);
|
|
813
926
|
}
|
|
814
927
|
|
|
@@ -817,6 +930,7 @@ class RecordingApi {
|
|
|
817
930
|
*
|
|
818
931
|
* @param {Object} opts Optional parameters
|
|
819
932
|
* @param {Boolean} opts.createDefault If no settings are found, a new one is created with default values (default to false)
|
|
933
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
820
934
|
*/
|
|
821
935
|
getRecordingSettings(opts) {
|
|
822
936
|
opts = opts || {};
|
|
@@ -832,7 +946,8 @@ class RecordingApi {
|
|
|
832
946
|
null,
|
|
833
947
|
['PureCloud OAuth'],
|
|
834
948
|
['application/json'],
|
|
835
|
-
['application/json']
|
|
949
|
+
['application/json'],
|
|
950
|
+
opts['customHeaders']
|
|
836
951
|
);
|
|
837
952
|
}
|
|
838
953
|
|
|
@@ -840,8 +955,12 @@ class RecordingApi {
|
|
|
840
955
|
* Get the status of a recording upload status report
|
|
841
956
|
*
|
|
842
957
|
* @param {String} reportId reportId
|
|
958
|
+
* @param {Object} opts Optional parameters
|
|
959
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
843
960
|
*/
|
|
844
|
-
getRecordingUploadsReport(reportId) {
|
|
961
|
+
getRecordingUploadsReport(reportId, opts) {
|
|
962
|
+
opts = opts || {};
|
|
963
|
+
|
|
845
964
|
// verify the required parameter 'reportId' is set
|
|
846
965
|
if (reportId === undefined || reportId === null || reportId === '') {
|
|
847
966
|
throw 'Missing the required parameter "reportId" when calling getRecordingUploadsReport';
|
|
@@ -857,7 +976,8 @@ class RecordingApi {
|
|
|
857
976
|
null,
|
|
858
977
|
['PureCloud OAuth'],
|
|
859
978
|
['application/json'],
|
|
860
|
-
['application/json']
|
|
979
|
+
['application/json'],
|
|
980
|
+
opts['customHeaders']
|
|
861
981
|
);
|
|
862
982
|
}
|
|
863
983
|
|
|
@@ -868,6 +988,7 @@ class RecordingApi {
|
|
|
868
988
|
* @param {Object} opts Optional parameters
|
|
869
989
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
870
990
|
* @param {Number} opts.pageSize Page size. Maximum is 500. (default to 25)
|
|
991
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
871
992
|
*/
|
|
872
993
|
getRecordingsRetentionQuery(retentionThresholdDays, opts) {
|
|
873
994
|
opts = opts || {};
|
|
@@ -887,15 +1008,20 @@ class RecordingApi {
|
|
|
887
1008
|
null,
|
|
888
1009
|
['PureCloud OAuth'],
|
|
889
1010
|
['application/json'],
|
|
890
|
-
['application/json']
|
|
1011
|
+
['application/json'],
|
|
1012
|
+
opts['customHeaders']
|
|
891
1013
|
);
|
|
892
1014
|
}
|
|
893
1015
|
|
|
894
1016
|
/**
|
|
895
1017
|
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
896
1018
|
*
|
|
1019
|
+
* @param {Object} opts Optional parameters
|
|
1020
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
897
1021
|
*/
|
|
898
|
-
getRecordingsScreensessionsDetails() {
|
|
1022
|
+
getRecordingsScreensessionsDetails(opts) {
|
|
1023
|
+
opts = opts || {};
|
|
1024
|
+
|
|
899
1025
|
|
|
900
1026
|
return this.apiClient.callApi(
|
|
901
1027
|
'/api/v2/recordings/screensessions/details',
|
|
@@ -907,7 +1033,8 @@ class RecordingApi {
|
|
|
907
1033
|
null,
|
|
908
1034
|
['PureCloud OAuth'],
|
|
909
1035
|
['application/json'],
|
|
910
|
-
['application/json']
|
|
1036
|
+
['application/json'],
|
|
1037
|
+
opts['customHeaders']
|
|
911
1038
|
);
|
|
912
1039
|
}
|
|
913
1040
|
|
|
@@ -916,8 +1043,12 @@ class RecordingApi {
|
|
|
916
1043
|
*
|
|
917
1044
|
* @param {String} policyId Policy ID
|
|
918
1045
|
* @param {Object} body Policy
|
|
1046
|
+
* @param {Object} opts Optional parameters
|
|
1047
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
919
1048
|
*/
|
|
920
|
-
patchRecordingCrossplatformMediaretentionpolicy(policyId, body) {
|
|
1049
|
+
patchRecordingCrossplatformMediaretentionpolicy(policyId, body, opts) {
|
|
1050
|
+
opts = opts || {};
|
|
1051
|
+
|
|
921
1052
|
// verify the required parameter 'policyId' is set
|
|
922
1053
|
if (policyId === undefined || policyId === null || policyId === '') {
|
|
923
1054
|
throw 'Missing the required parameter "policyId" when calling patchRecordingCrossplatformMediaretentionpolicy';
|
|
@@ -937,7 +1068,8 @@ class RecordingApi {
|
|
|
937
1068
|
body,
|
|
938
1069
|
['PureCloud OAuth'],
|
|
939
1070
|
['application/json'],
|
|
940
|
-
['application/json']
|
|
1071
|
+
['application/json'],
|
|
1072
|
+
opts['customHeaders']
|
|
941
1073
|
);
|
|
942
1074
|
}
|
|
943
1075
|
|
|
@@ -946,8 +1078,12 @@ class RecordingApi {
|
|
|
946
1078
|
*
|
|
947
1079
|
* @param {String} policyId Policy ID
|
|
948
1080
|
* @param {Object} body Policy
|
|
1081
|
+
* @param {Object} opts Optional parameters
|
|
1082
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
949
1083
|
*/
|
|
950
|
-
patchRecordingMediaretentionpolicy(policyId, body) {
|
|
1084
|
+
patchRecordingMediaretentionpolicy(policyId, body, opts) {
|
|
1085
|
+
opts = opts || {};
|
|
1086
|
+
|
|
951
1087
|
// verify the required parameter 'policyId' is set
|
|
952
1088
|
if (policyId === undefined || policyId === null || policyId === '') {
|
|
953
1089
|
throw 'Missing the required parameter "policyId" when calling patchRecordingMediaretentionpolicy';
|
|
@@ -967,18 +1103,23 @@ class RecordingApi {
|
|
|
967
1103
|
body,
|
|
968
1104
|
['PureCloud OAuth'],
|
|
969
1105
|
['application/json'],
|
|
970
|
-
['application/json']
|
|
1106
|
+
['application/json'],
|
|
1107
|
+
opts['customHeaders']
|
|
971
1108
|
);
|
|
972
1109
|
}
|
|
973
1110
|
|
|
974
1111
|
/**
|
|
975
1112
|
* Create annotation
|
|
976
|
-
*
|
|
1113
|
+
* If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.
|
|
977
1114
|
* @param {String} conversationId Conversation ID
|
|
978
1115
|
* @param {String} recordingId Recording ID
|
|
979
1116
|
* @param {Object} body annotation
|
|
1117
|
+
* @param {Object} opts Optional parameters
|
|
1118
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
980
1119
|
*/
|
|
981
|
-
postConversationRecordingAnnotations(conversationId, recordingId, body) {
|
|
1120
|
+
postConversationRecordingAnnotations(conversationId, recordingId, body, opts) {
|
|
1121
|
+
opts = opts || {};
|
|
1122
|
+
|
|
982
1123
|
// verify the required parameter 'conversationId' is set
|
|
983
1124
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
984
1125
|
throw 'Missing the required parameter "conversationId" when calling postConversationRecordingAnnotations';
|
|
@@ -1002,16 +1143,21 @@ class RecordingApi {
|
|
|
1002
1143
|
body,
|
|
1003
1144
|
['PureCloud OAuth'],
|
|
1004
1145
|
['application/json'],
|
|
1005
|
-
['application/json']
|
|
1146
|
+
['application/json'],
|
|
1147
|
+
opts['customHeaders']
|
|
1006
1148
|
);
|
|
1007
1149
|
}
|
|
1008
1150
|
|
|
1009
1151
|
/**
|
|
1010
|
-
* Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.
|
|
1152
|
+
* Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be excluded from the batch download.
|
|
1011
1153
|
*
|
|
1012
1154
|
* @param {Object} body Job submission criteria
|
|
1155
|
+
* @param {Object} opts Optional parameters
|
|
1156
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1013
1157
|
*/
|
|
1014
|
-
postRecordingBatchrequests(body) {
|
|
1158
|
+
postRecordingBatchrequests(body, opts) {
|
|
1159
|
+
opts = opts || {};
|
|
1160
|
+
|
|
1015
1161
|
// verify the required parameter 'body' is set
|
|
1016
1162
|
if (body === undefined || body === null) {
|
|
1017
1163
|
throw 'Missing the required parameter "body" when calling postRecordingBatchrequests';
|
|
@@ -1027,7 +1173,8 @@ class RecordingApi {
|
|
|
1027
1173
|
body,
|
|
1028
1174
|
['PureCloud OAuth'],
|
|
1029
1175
|
['application/json'],
|
|
1030
|
-
['application/json']
|
|
1176
|
+
['application/json'],
|
|
1177
|
+
opts['customHeaders']
|
|
1031
1178
|
);
|
|
1032
1179
|
}
|
|
1033
1180
|
|
|
@@ -1035,8 +1182,12 @@ class RecordingApi {
|
|
|
1035
1182
|
* Create media retention policy
|
|
1036
1183
|
* Policy does not work retroactively
|
|
1037
1184
|
* @param {Object} body Policy
|
|
1185
|
+
* @param {Object} opts Optional parameters
|
|
1186
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1038
1187
|
*/
|
|
1039
|
-
postRecordingCrossplatformMediaretentionpolicies(body) {
|
|
1188
|
+
postRecordingCrossplatformMediaretentionpolicies(body, opts) {
|
|
1189
|
+
opts = opts || {};
|
|
1190
|
+
|
|
1040
1191
|
// verify the required parameter 'body' is set
|
|
1041
1192
|
if (body === undefined || body === null) {
|
|
1042
1193
|
throw 'Missing the required parameter "body" when calling postRecordingCrossplatformMediaretentionpolicies';
|
|
@@ -1052,7 +1203,8 @@ class RecordingApi {
|
|
|
1052
1203
|
body,
|
|
1053
1204
|
['PureCloud OAuth'],
|
|
1054
1205
|
['application/json'],
|
|
1055
|
-
['application/json']
|
|
1206
|
+
['application/json'],
|
|
1207
|
+
opts['customHeaders']
|
|
1056
1208
|
);
|
|
1057
1209
|
}
|
|
1058
1210
|
|
|
@@ -1060,8 +1212,12 @@ class RecordingApi {
|
|
|
1060
1212
|
* Create a recording bulk job.
|
|
1061
1213
|
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected. It is recommended to query over smaller time periods so your request does not time out.
|
|
1062
1214
|
* @param {Object} body query
|
|
1215
|
+
* @param {Object} opts Optional parameters
|
|
1216
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1063
1217
|
*/
|
|
1064
|
-
postRecordingJobs(body) {
|
|
1218
|
+
postRecordingJobs(body, opts) {
|
|
1219
|
+
opts = opts || {};
|
|
1220
|
+
|
|
1065
1221
|
// verify the required parameter 'body' is set
|
|
1066
1222
|
if (body === undefined || body === null) {
|
|
1067
1223
|
throw 'Missing the required parameter "body" when calling postRecordingJobs';
|
|
@@ -1077,7 +1233,8 @@ class RecordingApi {
|
|
|
1077
1233
|
body,
|
|
1078
1234
|
['PureCloud OAuth'],
|
|
1079
1235
|
['application/json'],
|
|
1080
|
-
['application/json']
|
|
1236
|
+
['application/json'],
|
|
1237
|
+
opts['customHeaders']
|
|
1081
1238
|
);
|
|
1082
1239
|
}
|
|
1083
1240
|
|
|
@@ -1085,8 +1242,12 @@ class RecordingApi {
|
|
|
1085
1242
|
* Setup configurations for encryption key creation
|
|
1086
1243
|
*
|
|
1087
1244
|
* @param {Object} body Encryption Configuration
|
|
1245
|
+
* @param {Object} opts Optional parameters
|
|
1246
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1088
1247
|
*/
|
|
1089
|
-
postRecordingKeyconfigurations(body) {
|
|
1248
|
+
postRecordingKeyconfigurations(body, opts) {
|
|
1249
|
+
opts = opts || {};
|
|
1250
|
+
|
|
1090
1251
|
// verify the required parameter 'body' is set
|
|
1091
1252
|
if (body === undefined || body === null) {
|
|
1092
1253
|
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
|
|
@@ -1102,7 +1263,8 @@ class RecordingApi {
|
|
|
1102
1263
|
body,
|
|
1103
1264
|
['PureCloud OAuth'],
|
|
1104
1265
|
['application/json'],
|
|
1105
|
-
['application/json']
|
|
1266
|
+
['application/json'],
|
|
1267
|
+
opts['customHeaders']
|
|
1106
1268
|
);
|
|
1107
1269
|
}
|
|
1108
1270
|
|
|
@@ -1110,8 +1272,12 @@ class RecordingApi {
|
|
|
1110
1272
|
* Validate encryption key configurations without saving it
|
|
1111
1273
|
*
|
|
1112
1274
|
* @param {Object} body Encryption Configuration
|
|
1275
|
+
* @param {Object} opts Optional parameters
|
|
1276
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1113
1277
|
*/
|
|
1114
|
-
postRecordingKeyconfigurationsValidate(body) {
|
|
1278
|
+
postRecordingKeyconfigurationsValidate(body, opts) {
|
|
1279
|
+
opts = opts || {};
|
|
1280
|
+
|
|
1115
1281
|
// verify the required parameter 'body' is set
|
|
1116
1282
|
if (body === undefined || body === null) {
|
|
1117
1283
|
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
|
|
@@ -1127,7 +1293,8 @@ class RecordingApi {
|
|
|
1127
1293
|
body,
|
|
1128
1294
|
['PureCloud OAuth'],
|
|
1129
1295
|
['application/json'],
|
|
1130
|
-
['application/json']
|
|
1296
|
+
['application/json'],
|
|
1297
|
+
opts['customHeaders']
|
|
1131
1298
|
);
|
|
1132
1299
|
}
|
|
1133
1300
|
|
|
@@ -1135,8 +1302,12 @@ class RecordingApi {
|
|
|
1135
1302
|
* create a local key management recording key
|
|
1136
1303
|
*
|
|
1137
1304
|
* @param {Object} body Local Encryption body
|
|
1305
|
+
* @param {Object} opts Optional parameters
|
|
1306
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1138
1307
|
*/
|
|
1139
|
-
postRecordingLocalkeys(body) {
|
|
1308
|
+
postRecordingLocalkeys(body, opts) {
|
|
1309
|
+
opts = opts || {};
|
|
1310
|
+
|
|
1140
1311
|
// verify the required parameter 'body' is set
|
|
1141
1312
|
if (body === undefined || body === null) {
|
|
1142
1313
|
throw 'Missing the required parameter "body" when calling postRecordingLocalkeys';
|
|
@@ -1152,7 +1323,8 @@ class RecordingApi {
|
|
|
1152
1323
|
body,
|
|
1153
1324
|
['PureCloud OAuth'],
|
|
1154
1325
|
['application/json'],
|
|
1155
|
-
['application/json']
|
|
1326
|
+
['application/json'],
|
|
1327
|
+
opts['customHeaders']
|
|
1156
1328
|
);
|
|
1157
1329
|
}
|
|
1158
1330
|
|
|
@@ -1160,8 +1332,12 @@ class RecordingApi {
|
|
|
1160
1332
|
* Create media retention policy
|
|
1161
1333
|
* Policy does not work retroactively
|
|
1162
1334
|
* @param {Object} body Policy
|
|
1335
|
+
* @param {Object} opts Optional parameters
|
|
1336
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1163
1337
|
*/
|
|
1164
|
-
postRecordingMediaretentionpolicies(body) {
|
|
1338
|
+
postRecordingMediaretentionpolicies(body, opts) {
|
|
1339
|
+
opts = opts || {};
|
|
1340
|
+
|
|
1165
1341
|
// verify the required parameter 'body' is set
|
|
1166
1342
|
if (body === undefined || body === null) {
|
|
1167
1343
|
throw 'Missing the required parameter "body" when calling postRecordingMediaretentionpolicies';
|
|
@@ -1177,15 +1353,20 @@ class RecordingApi {
|
|
|
1177
1353
|
body,
|
|
1178
1354
|
['PureCloud OAuth'],
|
|
1179
1355
|
['application/json'],
|
|
1180
|
-
['application/json']
|
|
1356
|
+
['application/json'],
|
|
1357
|
+
opts['customHeaders']
|
|
1181
1358
|
);
|
|
1182
1359
|
}
|
|
1183
1360
|
|
|
1184
1361
|
/**
|
|
1185
1362
|
* Create encryption key
|
|
1186
1363
|
*
|
|
1364
|
+
* @param {Object} opts Optional parameters
|
|
1365
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1187
1366
|
*/
|
|
1188
|
-
postRecordingRecordingkeys() {
|
|
1367
|
+
postRecordingRecordingkeys(opts) {
|
|
1368
|
+
opts = opts || {};
|
|
1369
|
+
|
|
1189
1370
|
|
|
1190
1371
|
return this.apiClient.callApi(
|
|
1191
1372
|
'/api/v2/recording/recordingkeys',
|
|
@@ -1197,7 +1378,8 @@ class RecordingApi {
|
|
|
1197
1378
|
null,
|
|
1198
1379
|
['PureCloud OAuth'],
|
|
1199
1380
|
['application/json'],
|
|
1200
|
-
['application/json']
|
|
1381
|
+
['application/json'],
|
|
1382
|
+
opts['customHeaders']
|
|
1201
1383
|
);
|
|
1202
1384
|
}
|
|
1203
1385
|
|
|
@@ -1205,8 +1387,12 @@ class RecordingApi {
|
|
|
1205
1387
|
* Creates a recording upload status report
|
|
1206
1388
|
*
|
|
1207
1389
|
* @param {Object} body Report parameters
|
|
1390
|
+
* @param {Object} opts Optional parameters
|
|
1391
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1208
1392
|
*/
|
|
1209
|
-
postRecordingUploadsReports(body) {
|
|
1393
|
+
postRecordingUploadsReports(body, opts) {
|
|
1394
|
+
opts = opts || {};
|
|
1395
|
+
|
|
1210
1396
|
// verify the required parameter 'body' is set
|
|
1211
1397
|
if (body === undefined || body === null) {
|
|
1212
1398
|
throw 'Missing the required parameter "body" when calling postRecordingUploadsReports';
|
|
@@ -1222,7 +1408,8 @@ class RecordingApi {
|
|
|
1222
1408
|
body,
|
|
1223
1409
|
['PureCloud OAuth'],
|
|
1224
1410
|
['application/json'],
|
|
1225
|
-
['application/json']
|
|
1411
|
+
['application/json'],
|
|
1412
|
+
opts['customHeaders']
|
|
1226
1413
|
);
|
|
1227
1414
|
}
|
|
1228
1415
|
|
|
@@ -1230,8 +1417,12 @@ class RecordingApi {
|
|
|
1230
1417
|
* Get a list of conversations with protected recordings
|
|
1231
1418
|
*
|
|
1232
1419
|
* @param {Object} body conversationIds
|
|
1420
|
+
* @param {Object} opts Optional parameters
|
|
1421
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1233
1422
|
*/
|
|
1234
|
-
postRecordingsDeletionprotection(body) {
|
|
1423
|
+
postRecordingsDeletionprotection(body, opts) {
|
|
1424
|
+
opts = opts || {};
|
|
1425
|
+
|
|
1235
1426
|
// verify the required parameter 'body' is set
|
|
1236
1427
|
if (body === undefined || body === null) {
|
|
1237
1428
|
throw 'Missing the required parameter "body" when calling postRecordingsDeletionprotection';
|
|
@@ -1247,7 +1438,8 @@ class RecordingApi {
|
|
|
1247
1438
|
body,
|
|
1248
1439
|
['PureCloud OAuth'],
|
|
1249
1440
|
['application/json'],
|
|
1250
|
-
['application/json']
|
|
1441
|
+
['application/json'],
|
|
1442
|
+
opts['customHeaders']
|
|
1251
1443
|
);
|
|
1252
1444
|
}
|
|
1253
1445
|
|
|
@@ -1255,8 +1447,12 @@ class RecordingApi {
|
|
|
1255
1447
|
* Acknowledge a screen recording.
|
|
1256
1448
|
*
|
|
1257
1449
|
* @param {Object} body AcknowledgeScreenRecordingRequest
|
|
1450
|
+
* @param {Object} opts Optional parameters
|
|
1451
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1258
1452
|
*/
|
|
1259
|
-
postRecordingsScreensessionsAcknowledge(body) {
|
|
1453
|
+
postRecordingsScreensessionsAcknowledge(body, opts) {
|
|
1454
|
+
opts = opts || {};
|
|
1455
|
+
|
|
1260
1456
|
// verify the required parameter 'body' is set
|
|
1261
1457
|
if (body === undefined || body === null) {
|
|
1262
1458
|
throw 'Missing the required parameter "body" when calling postRecordingsScreensessionsAcknowledge';
|
|
@@ -1272,7 +1468,8 @@ class RecordingApi {
|
|
|
1272
1468
|
body,
|
|
1273
1469
|
['PureCloud OAuth'],
|
|
1274
1470
|
['application/json'],
|
|
1275
|
-
['application/json']
|
|
1471
|
+
['application/json'],
|
|
1472
|
+
opts['customHeaders']
|
|
1276
1473
|
);
|
|
1277
1474
|
}
|
|
1278
1475
|
|
|
@@ -1280,8 +1477,12 @@ class RecordingApi {
|
|
|
1280
1477
|
* Provide meta-data a screen recording.
|
|
1281
1478
|
*
|
|
1282
1479
|
* @param {Object} body ScreenRecordingMetaDataRequest
|
|
1480
|
+
* @param {Object} opts Optional parameters
|
|
1481
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1283
1482
|
*/
|
|
1284
|
-
postRecordingsScreensessionsMetadata(body) {
|
|
1483
|
+
postRecordingsScreensessionsMetadata(body, opts) {
|
|
1484
|
+
opts = opts || {};
|
|
1485
|
+
|
|
1285
1486
|
// verify the required parameter 'body' is set
|
|
1286
1487
|
if (body === undefined || body === null) {
|
|
1287
1488
|
throw 'Missing the required parameter "body" when calling postRecordingsScreensessionsMetadata';
|
|
@@ -1297,18 +1498,20 @@ class RecordingApi {
|
|
|
1297
1498
|
body,
|
|
1298
1499
|
['PureCloud OAuth'],
|
|
1299
1500
|
['application/json'],
|
|
1300
|
-
['application/json']
|
|
1501
|
+
['application/json'],
|
|
1502
|
+
opts['customHeaders']
|
|
1301
1503
|
);
|
|
1302
1504
|
}
|
|
1303
1505
|
|
|
1304
1506
|
/**
|
|
1305
1507
|
* Updates the retention records on a recording.
|
|
1306
|
-
* Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set.
|
|
1508
|
+
* Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Required permissions depend on the operation: view (recording, screenRecording, or snippetRecording) is always required; editRetention is required when updating retention dates except for restoration; restore is required when restoring an archived recording.
|
|
1307
1509
|
* @param {String} conversationId Conversation ID
|
|
1308
1510
|
* @param {String} recordingId Recording ID
|
|
1309
1511
|
* @param {Object} body recording
|
|
1310
1512
|
* @param {Object} opts Optional parameters
|
|
1311
1513
|
* @param {Boolean} opts.clearExport Whether to clear the pending export for the recording
|
|
1514
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1312
1515
|
*/
|
|
1313
1516
|
putConversationRecording(conversationId, recordingId, body, opts) {
|
|
1314
1517
|
opts = opts || {};
|
|
@@ -1336,19 +1539,24 @@ class RecordingApi {
|
|
|
1336
1539
|
body,
|
|
1337
1540
|
['PureCloud OAuth'],
|
|
1338
1541
|
['application/json'],
|
|
1339
|
-
['application/json']
|
|
1542
|
+
['application/json'],
|
|
1543
|
+
opts['customHeaders']
|
|
1340
1544
|
);
|
|
1341
1545
|
}
|
|
1342
1546
|
|
|
1343
1547
|
/**
|
|
1344
1548
|
* Update annotation
|
|
1345
|
-
*
|
|
1549
|
+
* If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates.
|
|
1346
1550
|
* @param {String} conversationId Conversation ID
|
|
1347
1551
|
* @param {String} recordingId Recording ID
|
|
1348
1552
|
* @param {String} annotationId Annotation ID
|
|
1349
1553
|
* @param {Object} body annotation
|
|
1554
|
+
* @param {Object} opts Optional parameters
|
|
1555
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1350
1556
|
*/
|
|
1351
|
-
putConversationRecordingAnnotation(conversationId, recordingId, annotationId, body) {
|
|
1557
|
+
putConversationRecordingAnnotation(conversationId, recordingId, annotationId, body, opts) {
|
|
1558
|
+
opts = opts || {};
|
|
1559
|
+
|
|
1352
1560
|
// verify the required parameter 'conversationId' is set
|
|
1353
1561
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
1354
1562
|
throw 'Missing the required parameter "conversationId" when calling putConversationRecordingAnnotation';
|
|
@@ -1376,7 +1584,8 @@ class RecordingApi {
|
|
|
1376
1584
|
body,
|
|
1377
1585
|
['PureCloud OAuth'],
|
|
1378
1586
|
['application/json'],
|
|
1379
|
-
['application/json']
|
|
1587
|
+
['application/json'],
|
|
1588
|
+
opts['customHeaders']
|
|
1380
1589
|
);
|
|
1381
1590
|
}
|
|
1382
1591
|
|
|
@@ -1386,6 +1595,7 @@ class RecordingApi {
|
|
|
1386
1595
|
* @param {String} orphanId Orphan ID
|
|
1387
1596
|
* @param {Object} opts Optional parameters
|
|
1388
1597
|
* @param {Object} opts.body
|
|
1598
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1389
1599
|
*/
|
|
1390
1600
|
putOrphanrecording(orphanId, opts) {
|
|
1391
1601
|
opts = opts || {};
|
|
@@ -1405,7 +1615,8 @@ class RecordingApi {
|
|
|
1405
1615
|
opts['body'],
|
|
1406
1616
|
['PureCloud OAuth'],
|
|
1407
1617
|
['application/json'],
|
|
1408
|
-
['application/json']
|
|
1618
|
+
['application/json'],
|
|
1619
|
+
opts['customHeaders']
|
|
1409
1620
|
);
|
|
1410
1621
|
}
|
|
1411
1622
|
|
|
@@ -1414,8 +1625,12 @@ class RecordingApi {
|
|
|
1414
1625
|
* Policy does not work retroactively
|
|
1415
1626
|
* @param {String} policyId Policy ID
|
|
1416
1627
|
* @param {Object} body Policy
|
|
1628
|
+
* @param {Object} opts Optional parameters
|
|
1629
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1417
1630
|
*/
|
|
1418
|
-
putRecordingCrossplatformMediaretentionpolicy(policyId, body) {
|
|
1631
|
+
putRecordingCrossplatformMediaretentionpolicy(policyId, body, opts) {
|
|
1632
|
+
opts = opts || {};
|
|
1633
|
+
|
|
1419
1634
|
// verify the required parameter 'policyId' is set
|
|
1420
1635
|
if (policyId === undefined || policyId === null || policyId === '') {
|
|
1421
1636
|
throw 'Missing the required parameter "policyId" when calling putRecordingCrossplatformMediaretentionpolicy';
|
|
@@ -1435,7 +1650,8 @@ class RecordingApi {
|
|
|
1435
1650
|
body,
|
|
1436
1651
|
['PureCloud OAuth'],
|
|
1437
1652
|
['application/json'],
|
|
1438
|
-
['application/json']
|
|
1653
|
+
['application/json'],
|
|
1654
|
+
opts['customHeaders']
|
|
1439
1655
|
);
|
|
1440
1656
|
}
|
|
1441
1657
|
|
|
@@ -1444,8 +1660,12 @@ class RecordingApi {
|
|
|
1444
1660
|
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recordings retention.
|
|
1445
1661
|
* @param {String} jobId jobId
|
|
1446
1662
|
* @param {Object} body query
|
|
1663
|
+
* @param {Object} opts Optional parameters
|
|
1664
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1447
1665
|
*/
|
|
1448
|
-
putRecordingJob(jobId, body) {
|
|
1666
|
+
putRecordingJob(jobId, body, opts) {
|
|
1667
|
+
opts = opts || {};
|
|
1668
|
+
|
|
1449
1669
|
// verify the required parameter 'jobId' is set
|
|
1450
1670
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1451
1671
|
throw 'Missing the required parameter "jobId" when calling putRecordingJob';
|
|
@@ -1465,7 +1685,8 @@ class RecordingApi {
|
|
|
1465
1685
|
body,
|
|
1466
1686
|
['PureCloud OAuth'],
|
|
1467
1687
|
['application/json'],
|
|
1468
|
-
['application/json']
|
|
1688
|
+
['application/json'],
|
|
1689
|
+
opts['customHeaders']
|
|
1469
1690
|
);
|
|
1470
1691
|
}
|
|
1471
1692
|
|
|
@@ -1474,8 +1695,12 @@ class RecordingApi {
|
|
|
1474
1695
|
*
|
|
1475
1696
|
* @param {String} keyConfigurationId Key Configurations Id
|
|
1476
1697
|
* @param {Object} body Encryption key configuration metadata
|
|
1698
|
+
* @param {Object} opts Optional parameters
|
|
1699
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1477
1700
|
*/
|
|
1478
|
-
putRecordingKeyconfiguration(keyConfigurationId, body) {
|
|
1701
|
+
putRecordingKeyconfiguration(keyConfigurationId, body, opts) {
|
|
1702
|
+
opts = opts || {};
|
|
1703
|
+
|
|
1479
1704
|
// verify the required parameter 'keyConfigurationId' is set
|
|
1480
1705
|
if (keyConfigurationId === undefined || keyConfigurationId === null || keyConfigurationId === '') {
|
|
1481
1706
|
throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
|
|
@@ -1495,7 +1720,8 @@ class RecordingApi {
|
|
|
1495
1720
|
body,
|
|
1496
1721
|
['PureCloud OAuth'],
|
|
1497
1722
|
['application/json'],
|
|
1498
|
-
['application/json']
|
|
1723
|
+
['application/json'],
|
|
1724
|
+
opts['customHeaders']
|
|
1499
1725
|
);
|
|
1500
1726
|
}
|
|
1501
1727
|
|
|
@@ -1504,8 +1730,12 @@ class RecordingApi {
|
|
|
1504
1730
|
* Policy does not work retroactively. In the conditions.forUsers section, each user object can include the id field containing the users unique identifier. Example: [{"id":"<userId>"}].
|
|
1505
1731
|
* @param {String} policyId Policy ID
|
|
1506
1732
|
* @param {Object} body Policy
|
|
1733
|
+
* @param {Object} opts Optional parameters
|
|
1734
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1507
1735
|
*/
|
|
1508
|
-
putRecordingMediaretentionpolicy(policyId, body) {
|
|
1736
|
+
putRecordingMediaretentionpolicy(policyId, body, opts) {
|
|
1737
|
+
opts = opts || {};
|
|
1738
|
+
|
|
1509
1739
|
// verify the required parameter 'policyId' is set
|
|
1510
1740
|
if (policyId === undefined || policyId === null || policyId === '') {
|
|
1511
1741
|
throw 'Missing the required parameter "policyId" when calling putRecordingMediaretentionpolicy';
|
|
@@ -1525,7 +1755,8 @@ class RecordingApi {
|
|
|
1525
1755
|
body,
|
|
1526
1756
|
['PureCloud OAuth'],
|
|
1527
1757
|
['application/json'],
|
|
1528
|
-
['application/json']
|
|
1758
|
+
['application/json'],
|
|
1759
|
+
opts['customHeaders']
|
|
1529
1760
|
);
|
|
1530
1761
|
}
|
|
1531
1762
|
|
|
@@ -1533,8 +1764,12 @@ class RecordingApi {
|
|
|
1533
1764
|
* Update key rotation schedule
|
|
1534
1765
|
*
|
|
1535
1766
|
* @param {Object} body KeyRotationSchedule
|
|
1767
|
+
* @param {Object} opts Optional parameters
|
|
1768
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1536
1769
|
*/
|
|
1537
|
-
putRecordingRecordingkeysRotationschedule(body) {
|
|
1770
|
+
putRecordingRecordingkeysRotationschedule(body, opts) {
|
|
1771
|
+
opts = opts || {};
|
|
1772
|
+
|
|
1538
1773
|
// verify the required parameter 'body' is set
|
|
1539
1774
|
if (body === undefined || body === null) {
|
|
1540
1775
|
throw 'Missing the required parameter "body" when calling putRecordingRecordingkeysRotationschedule';
|
|
@@ -1550,7 +1785,8 @@ class RecordingApi {
|
|
|
1550
1785
|
body,
|
|
1551
1786
|
['PureCloud OAuth'],
|
|
1552
1787
|
['application/json'],
|
|
1553
|
-
['application/json']
|
|
1788
|
+
['application/json'],
|
|
1789
|
+
opts['customHeaders']
|
|
1554
1790
|
);
|
|
1555
1791
|
}
|
|
1556
1792
|
|
|
@@ -1558,8 +1794,12 @@ class RecordingApi {
|
|
|
1558
1794
|
* Update the Recording Settings for the Organization
|
|
1559
1795
|
*
|
|
1560
1796
|
* @param {Object} body Recording settings
|
|
1797
|
+
* @param {Object} opts Optional parameters
|
|
1798
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1561
1799
|
*/
|
|
1562
|
-
putRecordingSettings(body) {
|
|
1800
|
+
putRecordingSettings(body, opts) {
|
|
1801
|
+
opts = opts || {};
|
|
1802
|
+
|
|
1563
1803
|
// verify the required parameter 'body' is set
|
|
1564
1804
|
if (body === undefined || body === null) {
|
|
1565
1805
|
throw 'Missing the required parameter "body" when calling putRecordingSettings';
|
|
@@ -1575,7 +1815,8 @@ class RecordingApi {
|
|
|
1575
1815
|
body,
|
|
1576
1816
|
['PureCloud OAuth'],
|
|
1577
1817
|
['application/json'],
|
|
1578
|
-
['application/json']
|
|
1818
|
+
['application/json'],
|
|
1819
|
+
opts['customHeaders']
|
|
1579
1820
|
);
|
|
1580
1821
|
}
|
|
1581
1822
|
|
|
@@ -1585,6 +1826,7 @@ class RecordingApi {
|
|
|
1585
1826
|
* @param {Object} opts Optional parameters
|
|
1586
1827
|
* @param {Boolean} opts.protect Check for apply, uncheck for revoke (each action requires the respective permission) (default to true)
|
|
1587
1828
|
* @param {Object} opts.body
|
|
1829
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1588
1830
|
*/
|
|
1589
1831
|
putRecordingsDeletionprotection(opts) {
|
|
1590
1832
|
opts = opts || {};
|
|
@@ -1600,7 +1842,8 @@ class RecordingApi {
|
|
|
1600
1842
|
opts['body'],
|
|
1601
1843
|
['PureCloud OAuth'],
|
|
1602
1844
|
['application/json'],
|
|
1603
|
-
['application/json']
|
|
1845
|
+
['application/json'],
|
|
1846
|
+
opts['customHeaders']
|
|
1604
1847
|
);
|
|
1605
1848
|
}
|
|
1606
1849
|
|