purecloud-platform-client-v2 159.0.0 → 160.1.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +1281 -177
- package/dist/web-amd/purecloud-platform-client-v2.js +1281 -177
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1281 -177
- package/dist/web-cjs/purecloud-platform-client-v2.js +7744 -400
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +455 -168
- package/package.json +3 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +16 -4
- 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 +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/BillingApi.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 +814 -42
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -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 +107 -0
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.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 +55 -1
- 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/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +13 -5
- 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/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +60 -1
- 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 -101
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +38 -3
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +76 -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/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 +32 -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 +26 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import ApiClient from '../ApiClient.js';
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class InfrastructureAsCodeApi {
|
|
5
|
+
/**
|
|
6
|
+
* InfrastructureAsCode service.
|
|
7
|
+
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
8
|
+
* @version 160.1.0
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Constructs a new InfrastructureAsCodeApi.
|
|
13
|
+
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
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
|
+
* Get job status and results
|
|
25
|
+
* Get the execution status of a submitted job, optionally including results and error details.
|
|
26
|
+
* @param {String} jobId Job ID
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Boolean} opts.details Include details of execution, including job results or error information (default to false)
|
|
29
|
+
*/
|
|
30
|
+
getInfrastructureascodeJob(jobId, opts) {
|
|
31
|
+
opts = opts || {};
|
|
32
|
+
|
|
33
|
+
// verify the required parameter 'jobId' is set
|
|
34
|
+
if (jobId === undefined || jobId === null) {
|
|
35
|
+
throw 'Missing the required parameter "jobId" when calling getInfrastructureascodeJob';
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
return this.apiClient.callApi(
|
|
39
|
+
'/api/v2/infrastructureascode/jobs/{jobId}',
|
|
40
|
+
'GET',
|
|
41
|
+
{ 'jobId': jobId },
|
|
42
|
+
{ 'details': opts['details'] },
|
|
43
|
+
{ },
|
|
44
|
+
{ },
|
|
45
|
+
null,
|
|
46
|
+
['PureCloud OAuth'],
|
|
47
|
+
['application/json'],
|
|
48
|
+
['application/json']
|
|
49
|
+
);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Get job history
|
|
54
|
+
* Get a history of submitted jobs, optionally including error messages.
|
|
55
|
+
* @param {Object} opts Optional parameters
|
|
56
|
+
* @param {Number} opts.maxResults Number of jobs to show (default to 1)
|
|
57
|
+
* @param {Boolean} opts.includeErrors Include error messages (default to false)
|
|
58
|
+
* @param {Object} opts.sortBy Sort by (default to id)
|
|
59
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
60
|
+
*/
|
|
61
|
+
getInfrastructureascodeJobs(opts) {
|
|
62
|
+
opts = opts || {};
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
return this.apiClient.callApi(
|
|
66
|
+
'/api/v2/infrastructureascode/jobs',
|
|
67
|
+
'GET',
|
|
68
|
+
{ },
|
|
69
|
+
{ 'maxResults': opts['maxResults'],'includeErrors': opts['includeErrors'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
70
|
+
{ },
|
|
71
|
+
{ },
|
|
72
|
+
null,
|
|
73
|
+
['PureCloud OAuth'],
|
|
74
|
+
['application/json'],
|
|
75
|
+
['application/json']
|
|
76
|
+
);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* Create a Job
|
|
81
|
+
* Create and submit a job for remote execution or see job planning results.
|
|
82
|
+
* @param {Object} body
|
|
83
|
+
*/
|
|
84
|
+
postInfrastructureascodeJobs(body) {
|
|
85
|
+
// verify the required parameter 'body' is set
|
|
86
|
+
if (body === undefined || body === null) {
|
|
87
|
+
throw 'Missing the required parameter "body" when calling postInfrastructureascodeJobs';
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
return this.apiClient.callApi(
|
|
91
|
+
'/api/v2/infrastructureascode/jobs',
|
|
92
|
+
'POST',
|
|
93
|
+
{ },
|
|
94
|
+
{ },
|
|
95
|
+
{ },
|
|
96
|
+
{ },
|
|
97
|
+
body,
|
|
98
|
+
['PureCloud OAuth'],
|
|
99
|
+
['application/json'],
|
|
100
|
+
['application/json']
|
|
101
|
+
);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
export default InfrastructureAsCodeApi;
|
|
@@ -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 160.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -413,6 +413,35 @@ class LearningApi {
|
|
|
413
413
|
);
|
|
414
414
|
}
|
|
415
415
|
|
|
416
|
+
/**
|
|
417
|
+
* Reschedule Learning Assignment
|
|
418
|
+
*
|
|
419
|
+
* @param {String} assignmentId The ID of Learning Assignment
|
|
420
|
+
* @param {Object} opts Optional parameters
|
|
421
|
+
* @param {Object} opts.body The Learning assignment reschedule model
|
|
422
|
+
*/
|
|
423
|
+
patchLearningAssignmentReschedule(assignmentId, opts) {
|
|
424
|
+
opts = opts || {};
|
|
425
|
+
|
|
426
|
+
// verify the required parameter 'assignmentId' is set
|
|
427
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
428
|
+
throw 'Missing the required parameter "assignmentId" when calling patchLearningAssignmentReschedule';
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
return this.apiClient.callApi(
|
|
432
|
+
'/api/v2/learning/assignments/{assignmentId}/reschedule',
|
|
433
|
+
'PATCH',
|
|
434
|
+
{ 'assignmentId': assignmentId },
|
|
435
|
+
{ },
|
|
436
|
+
{ },
|
|
437
|
+
{ },
|
|
438
|
+
opts['body'],
|
|
439
|
+
['PureCloud OAuth'],
|
|
440
|
+
['application/json'],
|
|
441
|
+
['application/json']
|
|
442
|
+
);
|
|
443
|
+
}
|
|
444
|
+
|
|
416
445
|
/**
|
|
417
446
|
* Score learning assessment for preview
|
|
418
447
|
*
|
|
@@ -700,6 +729,31 @@ class LearningApi {
|
|
|
700
729
|
);
|
|
701
730
|
}
|
|
702
731
|
|
|
732
|
+
/**
|
|
733
|
+
* Get list of possible slots where a learning activity can be scheduled.
|
|
734
|
+
*
|
|
735
|
+
* @param {Object} body The slot search request
|
|
736
|
+
*/
|
|
737
|
+
postLearningScheduleslotsQuery(body) {
|
|
738
|
+
// verify the required parameter 'body' is set
|
|
739
|
+
if (body === undefined || body === null) {
|
|
740
|
+
throw 'Missing the required parameter "body" when calling postLearningScheduleslotsQuery';
|
|
741
|
+
}
|
|
742
|
+
|
|
743
|
+
return this.apiClient.callApi(
|
|
744
|
+
'/api/v2/learning/scheduleslots/query',
|
|
745
|
+
'POST',
|
|
746
|
+
{ },
|
|
747
|
+
{ },
|
|
748
|
+
{ },
|
|
749
|
+
{ },
|
|
750
|
+
body,
|
|
751
|
+
['PureCloud OAuth'],
|
|
752
|
+
['application/json'],
|
|
753
|
+
['application/json']
|
|
754
|
+
);
|
|
755
|
+
}
|
|
756
|
+
|
|
703
757
|
/**
|
|
704
758
|
* Update a learning module
|
|
705
759
|
* This will update the name, description, completion time in days and inform steps for a learning module
|
|
@@ -5,7 +5,7 @@ class NotificationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Notifications service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 160.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -149,8 +149,12 @@ class NotificationsApi {
|
|
|
149
149
|
*
|
|
150
150
|
* @param {String} channelId Channel ID
|
|
151
151
|
* @param {Array.<Object>} body Body
|
|
152
|
+
* @param {Object} opts Optional parameters
|
|
153
|
+
* @param {Boolean} opts.ignoreErrors Optionally prevent throwing of errors for failed permissions checks. (default to false)
|
|
152
154
|
*/
|
|
153
|
-
postNotificationsChannelSubscriptions(channelId, body) {
|
|
155
|
+
postNotificationsChannelSubscriptions(channelId, body, opts) {
|
|
156
|
+
opts = opts || {};
|
|
157
|
+
|
|
154
158
|
// verify the required parameter 'channelId' is set
|
|
155
159
|
if (channelId === undefined || channelId === null) {
|
|
156
160
|
throw 'Missing the required parameter "channelId" when calling postNotificationsChannelSubscriptions';
|
|
@@ -164,7 +168,7 @@ class NotificationsApi {
|
|
|
164
168
|
'/api/v2/notifications/channels/{channelId}/subscriptions',
|
|
165
169
|
'POST',
|
|
166
170
|
{ 'channelId': channelId },
|
|
167
|
-
{
|
|
171
|
+
{ 'ignoreErrors': opts['ignoreErrors'] },
|
|
168
172
|
{ },
|
|
169
173
|
{ },
|
|
170
174
|
body,
|
|
@@ -199,8 +203,12 @@ class NotificationsApi {
|
|
|
199
203
|
*
|
|
200
204
|
* @param {String} channelId Channel ID
|
|
201
205
|
* @param {Array.<Object>} body Body
|
|
206
|
+
* @param {Object} opts Optional parameters
|
|
207
|
+
* @param {Boolean} opts.ignoreErrors Optionally prevent throwing of errors for failed permissions checks. (default to false)
|
|
202
208
|
*/
|
|
203
|
-
putNotificationsChannelSubscriptions(channelId, body) {
|
|
209
|
+
putNotificationsChannelSubscriptions(channelId, body, opts) {
|
|
210
|
+
opts = opts || {};
|
|
211
|
+
|
|
204
212
|
// verify the required parameter 'channelId' is set
|
|
205
213
|
if (channelId === undefined || channelId === null) {
|
|
206
214
|
throw 'Missing the required parameter "channelId" when calling putNotificationsChannelSubscriptions';
|
|
@@ -214,7 +222,7 @@ class NotificationsApi {
|
|
|
214
222
|
'/api/v2/notifications/channels/{channelId}/subscriptions',
|
|
215
223
|
'PUT',
|
|
216
224
|
{ 'channelId': channelId },
|
|
217
|
-
{
|
|
225
|
+
{ 'ignoreErrors': opts['ignoreErrors'] },
|
|
218
226
|
{ },
|
|
219
227
|
{ },
|
|
220
228
|
body,
|
|
@@ -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 160.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -355,6 +355,35 @@ class OutboundApi {
|
|
|
355
355
|
);
|
|
356
356
|
}
|
|
357
357
|
|
|
358
|
+
/**
|
|
359
|
+
* Deletes all or expired custom exclusion column entries from a DNC list.
|
|
360
|
+
* This operation is only for Internal DNC lists of custom exclusion column entries
|
|
361
|
+
* @param {String} dncListId DncList ID
|
|
362
|
+
* @param {Object} opts Optional parameters
|
|
363
|
+
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
364
|
+
*/
|
|
365
|
+
deleteOutboundDnclistCustomexclusioncolumns(dncListId, opts) {
|
|
366
|
+
opts = opts || {};
|
|
367
|
+
|
|
368
|
+
// verify the required parameter 'dncListId' is set
|
|
369
|
+
if (dncListId === undefined || dncListId === null) {
|
|
370
|
+
throw 'Missing the required parameter "dncListId" when calling deleteOutboundDnclistCustomexclusioncolumns';
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
return this.apiClient.callApi(
|
|
374
|
+
'/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns',
|
|
375
|
+
'DELETE',
|
|
376
|
+
{ 'dncListId': dncListId },
|
|
377
|
+
{ 'expiredOnly': opts['expiredOnly'] },
|
|
378
|
+
{ },
|
|
379
|
+
{ },
|
|
380
|
+
null,
|
|
381
|
+
['PureCloud OAuth'],
|
|
382
|
+
['application/json'],
|
|
383
|
+
['application/json']
|
|
384
|
+
);
|
|
385
|
+
}
|
|
386
|
+
|
|
358
387
|
/**
|
|
359
388
|
* Deletes all or expired email addresses from a DNC list.
|
|
360
389
|
* This operation is Only for Internal DNC lists of email addresses
|
|
@@ -2183,6 +2212,36 @@ class OutboundApi {
|
|
|
2183
2212
|
);
|
|
2184
2213
|
}
|
|
2185
2214
|
|
|
2215
|
+
/**
|
|
2216
|
+
* Add entries to or delete entries from a DNC list.
|
|
2217
|
+
* Only Internal DNC lists may be deleted from
|
|
2218
|
+
* @param {String} dncListId DncList ID
|
|
2219
|
+
* @param {Object} body DNC Custom exclusion column entries
|
|
2220
|
+
*/
|
|
2221
|
+
patchOutboundDnclistCustomexclusioncolumns(dncListId, body) {
|
|
2222
|
+
// verify the required parameter 'dncListId' is set
|
|
2223
|
+
if (dncListId === undefined || dncListId === null) {
|
|
2224
|
+
throw 'Missing the required parameter "dncListId" when calling patchOutboundDnclistCustomexclusioncolumns';
|
|
2225
|
+
}
|
|
2226
|
+
// verify the required parameter 'body' is set
|
|
2227
|
+
if (body === undefined || body === null) {
|
|
2228
|
+
throw 'Missing the required parameter "body" when calling patchOutboundDnclistCustomexclusioncolumns';
|
|
2229
|
+
}
|
|
2230
|
+
|
|
2231
|
+
return this.apiClient.callApi(
|
|
2232
|
+
'/api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns',
|
|
2233
|
+
'PATCH',
|
|
2234
|
+
{ 'dncListId': dncListId },
|
|
2235
|
+
{ },
|
|
2236
|
+
{ },
|
|
2237
|
+
{ },
|
|
2238
|
+
body,
|
|
2239
|
+
['PureCloud OAuth'],
|
|
2240
|
+
['application/json'],
|
|
2241
|
+
['application/json']
|
|
2242
|
+
);
|
|
2243
|
+
}
|
|
2244
|
+
|
|
2186
2245
|
/**
|
|
2187
2246
|
* Add emails to or Delete emails from a DNC list.
|
|
2188
2247
|
* Only Internal DNC lists may be added to or deleted from
|