purecloud-platform-client-v2 97.0.0 → 99.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/dist/node/purecloud-platform-client-v2.js +72 -196
- package/dist/web-amd/purecloud-platform-client-v2.js +72 -196
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +72 -196
- package/dist/web-cjs/purecloud-platform-client-v2.js +73 -199
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +264 -278
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- 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/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/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 -131
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +5 -3
- 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/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.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 +3 -2
- 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 +3 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +2 -2
- 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/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +5 -3
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@ import superagent from 'superagent';
|
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* @module purecloud-platform-client-v2/ApiClient
|
|
5
|
-
* @version
|
|
5
|
+
* @version 99.0.1
|
|
6
6
|
*/
|
|
7
7
|
class ApiClient {
|
|
8
8
|
/**
|
|
@@ -758,7 +758,7 @@ class ApiClient {
|
|
|
758
758
|
|
|
759
759
|
// set header parameters
|
|
760
760
|
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
|
|
761
|
-
//request.set({ 'purecloud-sdk': '
|
|
761
|
+
//request.set({ 'purecloud-sdk': '99.0.1' });
|
|
762
762
|
|
|
763
763
|
// set request timeout
|
|
764
764
|
request.timeout(this.timeout);
|
|
@@ -5,7 +5,7 @@ class JourneyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Journey service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 99.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -70,107 +70,6 @@ class JourneyApi {
|
|
|
70
70
|
);
|
|
71
71
|
}
|
|
72
72
|
|
|
73
|
-
/**
|
|
74
|
-
* Retrieve segment assignments by customer ID.
|
|
75
|
-
*
|
|
76
|
-
* @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
|
|
77
|
-
* @param {String} customerId Primary identifier of the customer to query for segment assignments.
|
|
78
|
-
* @param {Object} opts Optional parameters
|
|
79
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
80
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
81
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
82
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
83
|
-
*/
|
|
84
|
-
getJourneyCustomerCustomerIdSegments(customerIdType, customerId, opts) {
|
|
85
|
-
opts = opts || {};
|
|
86
|
-
|
|
87
|
-
// verify the required parameter 'customerIdType' is set
|
|
88
|
-
if (customerIdType === undefined || customerIdType === null) {
|
|
89
|
-
throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSegments';
|
|
90
|
-
}
|
|
91
|
-
// verify the required parameter 'customerId' is set
|
|
92
|
-
if (customerId === undefined || customerId === null) {
|
|
93
|
-
throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSegments';
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
return this.apiClient.callApi(
|
|
97
|
-
'/api/v2/journey/customers/{customerIdType}/{customerId}/segments',
|
|
98
|
-
'GET',
|
|
99
|
-
{ 'customerIdType': customerIdType,'customerId': customerId },
|
|
100
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
101
|
-
{ },
|
|
102
|
-
{ },
|
|
103
|
-
null,
|
|
104
|
-
['PureCloud OAuth'],
|
|
105
|
-
['application/json'],
|
|
106
|
-
['application/json']
|
|
107
|
-
);
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
/**
|
|
111
|
-
* Retrieve segment assignments by external contact ID.
|
|
112
|
-
*
|
|
113
|
-
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
114
|
-
* @param {Object} opts Optional parameters
|
|
115
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
116
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
117
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
118
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
119
|
-
*/
|
|
120
|
-
getJourneyExternalcontactSegments(externalContactId, opts) {
|
|
121
|
-
opts = opts || {};
|
|
122
|
-
|
|
123
|
-
// verify the required parameter 'externalContactId' is set
|
|
124
|
-
if (externalContactId === undefined || externalContactId === null) {
|
|
125
|
-
throw 'Missing the required parameter "externalContactId" when calling getJourneyExternalcontactSegments';
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
return this.apiClient.callApi(
|
|
129
|
-
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
130
|
-
'GET',
|
|
131
|
-
{ 'externalContactId': externalContactId },
|
|
132
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
133
|
-
{ },
|
|
134
|
-
{ },
|
|
135
|
-
null,
|
|
136
|
-
['PureCloud OAuth'],
|
|
137
|
-
['application/json'],
|
|
138
|
-
['application/json']
|
|
139
|
-
);
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
/**
|
|
143
|
-
* Retrieve segment assignments by session ID.
|
|
144
|
-
*
|
|
145
|
-
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
146
|
-
* @param {Object} opts Optional parameters
|
|
147
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
148
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
149
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
150
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
151
|
-
*/
|
|
152
|
-
getJourneySessionSegments(sessionId, opts) {
|
|
153
|
-
opts = opts || {};
|
|
154
|
-
|
|
155
|
-
// verify the required parameter 'sessionId' is set
|
|
156
|
-
if (sessionId === undefined || sessionId === null) {
|
|
157
|
-
throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
return this.apiClient.callApi(
|
|
161
|
-
'/api/v2/journey/sessions/{sessionId}/segments',
|
|
162
|
-
'GET',
|
|
163
|
-
{ 'sessionId': sessionId },
|
|
164
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
165
|
-
{ },
|
|
166
|
-
{ },
|
|
167
|
-
null,
|
|
168
|
-
['PureCloud OAuth'],
|
|
169
|
-
['application/json'],
|
|
170
|
-
['application/json']
|
|
171
|
-
);
|
|
172
|
-
}
|
|
173
|
-
|
|
174
73
|
/**
|
|
175
74
|
* Update a single action target.
|
|
176
75
|
*
|
|
@@ -225,35 +124,6 @@ class JourneyApi {
|
|
|
225
124
|
);
|
|
226
125
|
}
|
|
227
126
|
|
|
228
|
-
/**
|
|
229
|
-
* Assign/Unassign a segment to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
|
|
230
|
-
*
|
|
231
|
-
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
232
|
-
* @param {Object} opts Optional parameters
|
|
233
|
-
* @param {Array.<Object>} opts.body
|
|
234
|
-
*/
|
|
235
|
-
postJourneyExternalcontactSegments(externalContactId, opts) {
|
|
236
|
-
opts = opts || {};
|
|
237
|
-
|
|
238
|
-
// verify the required parameter 'externalContactId' is set
|
|
239
|
-
if (externalContactId === undefined || externalContactId === null) {
|
|
240
|
-
throw 'Missing the required parameter "externalContactId" when calling postJourneyExternalcontactSegments';
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
return this.apiClient.callApi(
|
|
244
|
-
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
245
|
-
'POST',
|
|
246
|
-
{ 'externalContactId': externalContactId },
|
|
247
|
-
{ },
|
|
248
|
-
{ },
|
|
249
|
-
{ },
|
|
250
|
-
opts['body'],
|
|
251
|
-
['PureCloud OAuth'],
|
|
252
|
-
['application/json'],
|
|
253
|
-
['application/json']
|
|
254
|
-
);
|
|
255
|
-
}
|
|
256
|
-
|
|
257
127
|
}
|
|
258
128
|
|
|
259
129
|
|
|
@@ -5,7 +5,7 @@ class KnowledgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Knowledge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 99.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -150,6 +150,7 @@ class KnowledgeApi {
|
|
|
150
150
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
151
151
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
152
152
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
153
|
+
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
153
154
|
*/
|
|
154
155
|
getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
|
|
155
156
|
opts = opts || {};
|
|
@@ -167,7 +168,7 @@ class KnowledgeApi {
|
|
|
167
168
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories',
|
|
168
169
|
'GET',
|
|
169
170
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
170
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
|
|
171
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
171
172
|
{ },
|
|
172
173
|
{ },
|
|
173
174
|
null,
|
|
@@ -258,6 +259,7 @@ class KnowledgeApi {
|
|
|
258
259
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
259
260
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
260
261
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
262
|
+
* @param {String} opts.title Filter by document title.
|
|
261
263
|
*/
|
|
262
264
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
263
265
|
opts = opts || {};
|
|
@@ -275,7 +277,7 @@ class KnowledgeApi {
|
|
|
275
277
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
276
278
|
'GET',
|
|
277
279
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
278
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'] },
|
|
280
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'] },
|
|
279
281
|
{ },
|
|
280
282
|
{ },
|
|
281
283
|
null,
|
|
@@ -5,7 +5,7 @@ class QualityApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Quality service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 99.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -599,6 +599,7 @@ class QualityApi {
|
|
|
599
599
|
* @param {Object} opts Optional parameters
|
|
600
600
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
601
601
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
602
|
+
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
602
603
|
*/
|
|
603
604
|
getQualityFormsEvaluationVersions(formId, opts) {
|
|
604
605
|
opts = opts || {};
|
|
@@ -612,7 +613,7 @@ class QualityApi {
|
|
|
612
613
|
'/api/v2/quality/forms/evaluations/{formId}/versions',
|
|
613
614
|
'GET',
|
|
614
615
|
{ 'formId': formId },
|
|
615
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
616
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
616
617
|
{ },
|
|
617
618
|
{ },
|
|
618
619
|
null,
|
|
@@ -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 99.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1191,6 +1191,7 @@ class RoutingApi {
|
|
|
1191
1191
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1192
1192
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1193
1193
|
* @param {Object} opts.sortBy Sort by (default to name)
|
|
1194
|
+
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
1194
1195
|
* @param {String} opts.name Name
|
|
1195
1196
|
*/
|
|
1196
1197
|
getRoutingWrapupcodes(opts) {
|
|
@@ -1201,7 +1202,7 @@ class RoutingApi {
|
|
|
1201
1202
|
'/api/v2/routing/wrapupcodes',
|
|
1202
1203
|
'GET',
|
|
1203
1204
|
{ },
|
|
1204
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'name': opts['name'] },
|
|
1205
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
1205
1206
|
{ },
|
|
1206
1207
|
{ },
|
|
1207
1208
|
null,
|