purecloud-platform-client-v2 140.0.0 → 141.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 +504 -80
- package/dist/web-amd/purecloud-platform-client-v2.js +504 -81
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +504 -80
- package/dist/web-cjs/purecloud-platform-client-v2.js +2598 -118
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +396 -196
- package/package.json +2 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +18 -16
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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 +152 -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/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 +35 -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 +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/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.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 +4 -2
- 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 +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/TeamsApi.js +184 -0
- 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/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
|
@@ -5,7 +5,7 @@ class RoutingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Routing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 141.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1115,6 +1115,8 @@ class RoutingApi {
|
|
|
1115
1115
|
* @param {String} opts.name Filter by queue name
|
|
1116
1116
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
1117
1117
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
1118
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
1119
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
1118
1120
|
*/
|
|
1119
1121
|
getRoutingQueues(opts) {
|
|
1120
1122
|
opts = opts || {};
|
|
@@ -1124,7 +1126,7 @@ class RoutingApi {
|
|
|
1124
1126
|
'/api/v2/routing/queues',
|
|
1125
1127
|
'GET',
|
|
1126
1128
|
{ },
|
|
1127
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
1129
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'hasPeer': opts['hasPeer'] },
|
|
1128
1130
|
{ },
|
|
1129
1131
|
{ },
|
|
1130
1132
|
null,
|
|
@@ -5,7 +5,7 @@ class SearchApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Search service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 141.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -484,6 +484,31 @@ class SearchApi {
|
|
|
484
484
|
);
|
|
485
485
|
}
|
|
486
486
|
|
|
487
|
+
/**
|
|
488
|
+
* Search resources.
|
|
489
|
+
*
|
|
490
|
+
* @param {Object} body Search request options
|
|
491
|
+
*/
|
|
492
|
+
postTeamsSearch(body) {
|
|
493
|
+
// verify the required parameter 'body' is set
|
|
494
|
+
if (body === undefined || body === null) {
|
|
495
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
return this.apiClient.callApi(
|
|
499
|
+
'/api/v2/teams/search',
|
|
500
|
+
'POST',
|
|
501
|
+
{ },
|
|
502
|
+
{ },
|
|
503
|
+
{ },
|
|
504
|
+
{ },
|
|
505
|
+
body,
|
|
506
|
+
['PureCloud OAuth'],
|
|
507
|
+
['application/json'],
|
|
508
|
+
['application/json']
|
|
509
|
+
);
|
|
510
|
+
}
|
|
511
|
+
|
|
487
512
|
/**
|
|
488
513
|
* Search users
|
|
489
514
|
*
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
import ApiClient from '../ApiClient.js';
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class TeamsApi {
|
|
5
|
+
/**
|
|
6
|
+
* Teams service.
|
|
7
|
+
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
8
|
+
* @version 141.1.0
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Constructs a new TeamsApi.
|
|
13
|
+
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
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
|
+
* Delete team
|
|
25
|
+
*
|
|
26
|
+
* @param {String} teamId Team ID
|
|
27
|
+
*/
|
|
28
|
+
deleteTeam(teamId) {
|
|
29
|
+
// verify the required parameter 'teamId' is set
|
|
30
|
+
if (teamId === undefined || teamId === null) {
|
|
31
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeam';
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
return this.apiClient.callApi(
|
|
35
|
+
'/api/v2/teams/{teamId}',
|
|
36
|
+
'DELETE',
|
|
37
|
+
{ 'teamId': teamId },
|
|
38
|
+
{ },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
null,
|
|
42
|
+
['PureCloud OAuth'],
|
|
43
|
+
['application/json'],
|
|
44
|
+
['application/json']
|
|
45
|
+
);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Get team
|
|
50
|
+
*
|
|
51
|
+
* @param {String} teamId Team ID
|
|
52
|
+
*/
|
|
53
|
+
getTeam(teamId) {
|
|
54
|
+
// verify the required parameter 'teamId' is set
|
|
55
|
+
if (teamId === undefined || teamId === null) {
|
|
56
|
+
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
return this.apiClient.callApi(
|
|
60
|
+
'/api/v2/teams/{teamId}',
|
|
61
|
+
'GET',
|
|
62
|
+
{ 'teamId': teamId },
|
|
63
|
+
{ },
|
|
64
|
+
{ },
|
|
65
|
+
{ },
|
|
66
|
+
null,
|
|
67
|
+
['PureCloud OAuth'],
|
|
68
|
+
['application/json'],
|
|
69
|
+
['application/json']
|
|
70
|
+
);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Get Team listing
|
|
75
|
+
*
|
|
76
|
+
* @param {Object} opts Optional parameters
|
|
77
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
78
|
+
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
79
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
80
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
81
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
82
|
+
*/
|
|
83
|
+
getTeams(opts) {
|
|
84
|
+
opts = opts || {};
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
return this.apiClient.callApi(
|
|
88
|
+
'/api/v2/teams',
|
|
89
|
+
'GET',
|
|
90
|
+
{ },
|
|
91
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
92
|
+
{ },
|
|
93
|
+
{ },
|
|
94
|
+
null,
|
|
95
|
+
['PureCloud OAuth'],
|
|
96
|
+
['application/json'],
|
|
97
|
+
['application/json']
|
|
98
|
+
);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* Update team
|
|
103
|
+
*
|
|
104
|
+
* @param {String} teamId Team ID
|
|
105
|
+
* @param {Object} body Team
|
|
106
|
+
*/
|
|
107
|
+
patchTeam(teamId, body) {
|
|
108
|
+
// verify the required parameter 'teamId' is set
|
|
109
|
+
if (teamId === undefined || teamId === null) {
|
|
110
|
+
throw 'Missing the required parameter "teamId" when calling patchTeam';
|
|
111
|
+
}
|
|
112
|
+
// verify the required parameter 'body' is set
|
|
113
|
+
if (body === undefined || body === null) {
|
|
114
|
+
throw 'Missing the required parameter "body" when calling patchTeam';
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
return this.apiClient.callApi(
|
|
118
|
+
'/api/v2/teams/{teamId}',
|
|
119
|
+
'PATCH',
|
|
120
|
+
{ 'teamId': teamId },
|
|
121
|
+
{ },
|
|
122
|
+
{ },
|
|
123
|
+
{ },
|
|
124
|
+
body,
|
|
125
|
+
['PureCloud OAuth'],
|
|
126
|
+
['application/json'],
|
|
127
|
+
['application/json']
|
|
128
|
+
);
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Create a team
|
|
133
|
+
*
|
|
134
|
+
* @param {Object} body Team
|
|
135
|
+
*/
|
|
136
|
+
postTeams(body) {
|
|
137
|
+
// verify the required parameter 'body' is set
|
|
138
|
+
if (body === undefined || body === null) {
|
|
139
|
+
throw 'Missing the required parameter "body" when calling postTeams';
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
return this.apiClient.callApi(
|
|
143
|
+
'/api/v2/teams',
|
|
144
|
+
'POST',
|
|
145
|
+
{ },
|
|
146
|
+
{ },
|
|
147
|
+
{ },
|
|
148
|
+
{ },
|
|
149
|
+
body,
|
|
150
|
+
['PureCloud OAuth'],
|
|
151
|
+
['application/json'],
|
|
152
|
+
['application/json']
|
|
153
|
+
);
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
/**
|
|
157
|
+
* Search resources.
|
|
158
|
+
*
|
|
159
|
+
* @param {Object} body Search request options
|
|
160
|
+
*/
|
|
161
|
+
postTeamsSearch(body) {
|
|
162
|
+
// verify the required parameter 'body' is set
|
|
163
|
+
if (body === undefined || body === null) {
|
|
164
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
return this.apiClient.callApi(
|
|
168
|
+
'/api/v2/teams/search',
|
|
169
|
+
'POST',
|
|
170
|
+
{ },
|
|
171
|
+
{ },
|
|
172
|
+
{ },
|
|
173
|
+
{ },
|
|
174
|
+
body,
|
|
175
|
+
['PureCloud OAuth'],
|
|
176
|
+
['application/json'],
|
|
177
|
+
['application/json']
|
|
178
|
+
);
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
export default TeamsApi;
|
|
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* WorkforceManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 141.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -425,6 +425,31 @@ class WorkforceManagementApi {
|
|
|
425
425
|
);
|
|
426
426
|
}
|
|
427
427
|
|
|
428
|
+
/**
|
|
429
|
+
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
430
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
431
|
+
* @param {String} jobId jobId
|
|
432
|
+
*/
|
|
433
|
+
getWorkforcemanagementAdherenceHistoricalJob(jobId) {
|
|
434
|
+
// verify the required parameter 'jobId' is set
|
|
435
|
+
if (jobId === undefined || jobId === null) {
|
|
436
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
return this.apiClient.callApi(
|
|
440
|
+
'/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}',
|
|
441
|
+
'GET',
|
|
442
|
+
{ 'jobId': jobId },
|
|
443
|
+
{ },
|
|
444
|
+
{ },
|
|
445
|
+
{ },
|
|
446
|
+
null,
|
|
447
|
+
['PureCloud OAuth'],
|
|
448
|
+
['application/json'],
|
|
449
|
+
['application/json']
|
|
450
|
+
);
|
|
451
|
+
}
|
|
452
|
+
|
|
428
453
|
/**
|
|
429
454
|
* Get status of the modeling job
|
|
430
455
|
*
|
|
@@ -48,6 +48,7 @@ import SearchApi from './api/SearchApi.js';
|
|
|
48
48
|
import SpeechTextAnalyticsApi from './api/SpeechTextAnalyticsApi.js';
|
|
49
49
|
import StationsApi from './api/StationsApi.js';
|
|
50
50
|
import SuggestApi from './api/SuggestApi.js';
|
|
51
|
+
import TeamsApi from './api/TeamsApi.js';
|
|
51
52
|
import TelephonyApi from './api/TelephonyApi.js';
|
|
52
53
|
import TelephonyProvidersEdgeApi from './api/TelephonyProvidersEdgeApi.js';
|
|
53
54
|
import TextbotsApi from './api/TextbotsApi.js';
|
|
@@ -95,7 +96,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
|
|
|
95
96
|
* </pre>
|
|
96
97
|
* </p>
|
|
97
98
|
* @module purecloud-platform-client-v2/index
|
|
98
|
-
* @version
|
|
99
|
+
* @version 141.1.0
|
|
99
100
|
*/
|
|
100
101
|
class platformClient {
|
|
101
102
|
constructor() {
|
|
@@ -344,6 +345,11 @@ class platformClient {
|
|
|
344
345
|
* @property {module:purecloud-platform-client-v2/api/SuggestApi}
|
|
345
346
|
*/
|
|
346
347
|
this.SuggestApi = SuggestApi;
|
|
348
|
+
/**
|
|
349
|
+
* The TeamsApi service constructor.
|
|
350
|
+
* @property {module:purecloud-platform-client-v2/api/TeamsApi}
|
|
351
|
+
*/
|
|
352
|
+
this.TeamsApi = TeamsApi;
|
|
347
353
|
/**
|
|
348
354
|
* The TelephonyApi service constructor.
|
|
349
355
|
* @property {module:purecloud-platform-client-v2/api/TelephonyApi}
|