purecloud-platform-client-v2 97.0.0 → 98.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +67 -193
- package/dist/web-amd/purecloud-platform-client-v2.js +67 -193
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +67 -193
- package/dist/web-cjs/purecloud-platform-client-v2.js +68 -196
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +68 -97
- 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 +3 -2
- 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 +1 -1
- 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 +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/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/dist/web-cjs/bundle.js
CHANGED
|
@@ -1983,7 +1983,7 @@ function isSlowBuffer (obj) {
|
|
|
1983
1983
|
|
|
1984
1984
|
/**
|
|
1985
1985
|
* @module purecloud-platform-client-v2/ApiClient
|
|
1986
|
-
* @version
|
|
1986
|
+
* @version 98.0.0
|
|
1987
1987
|
*/
|
|
1988
1988
|
class ApiClient {
|
|
1989
1989
|
/**
|
|
@@ -2739,7 +2739,7 @@ class ApiClient {
|
|
|
2739
2739
|
|
|
2740
2740
|
// set header parameters
|
|
2741
2741
|
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
|
|
2742
|
-
//request.set({ 'purecloud-sdk': '
|
|
2742
|
+
//request.set({ 'purecloud-sdk': '98.0.0' });
|
|
2743
2743
|
|
|
2744
2744
|
// set request timeout
|
|
2745
2745
|
request.timeout(this.timeout);
|
|
@@ -2864,7 +2864,7 @@ class AlertingApi {
|
|
|
2864
2864
|
/**
|
|
2865
2865
|
* Alerting service.
|
|
2866
2866
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2867
|
-
* @version
|
|
2867
|
+
* @version 98.0.0
|
|
2868
2868
|
*/
|
|
2869
2869
|
|
|
2870
2870
|
/**
|
|
@@ -3178,7 +3178,7 @@ class AnalyticsApi {
|
|
|
3178
3178
|
/**
|
|
3179
3179
|
* Analytics service.
|
|
3180
3180
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3181
|
-
* @version
|
|
3181
|
+
* @version 98.0.0
|
|
3182
3182
|
*/
|
|
3183
3183
|
|
|
3184
3184
|
/**
|
|
@@ -4258,7 +4258,7 @@ class ArchitectApi {
|
|
|
4258
4258
|
/**
|
|
4259
4259
|
* Architect service.
|
|
4260
4260
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4261
|
-
* @version
|
|
4261
|
+
* @version 98.0.0
|
|
4262
4262
|
*/
|
|
4263
4263
|
|
|
4264
4264
|
/**
|
|
@@ -7096,7 +7096,7 @@ class AuditApi {
|
|
|
7096
7096
|
/**
|
|
7097
7097
|
* Audit service.
|
|
7098
7098
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7099
|
-
* @version
|
|
7099
|
+
* @version 98.0.0
|
|
7100
7100
|
*/
|
|
7101
7101
|
|
|
7102
7102
|
/**
|
|
@@ -7267,7 +7267,7 @@ class AuthorizationApi {
|
|
|
7267
7267
|
/**
|
|
7268
7268
|
* Authorization service.
|
|
7269
7269
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7270
|
-
* @version
|
|
7270
|
+
* @version 98.0.0
|
|
7271
7271
|
*/
|
|
7272
7272
|
|
|
7273
7273
|
/**
|
|
@@ -8386,7 +8386,7 @@ class BillingApi {
|
|
|
8386
8386
|
/**
|
|
8387
8387
|
* Billing service.
|
|
8388
8388
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8389
|
-
* @version
|
|
8389
|
+
* @version 98.0.0
|
|
8390
8390
|
*/
|
|
8391
8391
|
|
|
8392
8392
|
/**
|
|
@@ -8466,7 +8466,7 @@ class CoachingApi {
|
|
|
8466
8466
|
/**
|
|
8467
8467
|
* Coaching service.
|
|
8468
8468
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8469
|
-
* @version
|
|
8469
|
+
* @version 98.0.0
|
|
8470
8470
|
*/
|
|
8471
8471
|
|
|
8472
8472
|
/**
|
|
@@ -8986,7 +8986,7 @@ class ContentManagementApi {
|
|
|
8986
8986
|
/**
|
|
8987
8987
|
* ContentManagement service.
|
|
8988
8988
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8989
|
-
* @version
|
|
8989
|
+
* @version 98.0.0
|
|
8990
8990
|
*/
|
|
8991
8991
|
|
|
8992
8992
|
/**
|
|
@@ -10126,7 +10126,7 @@ class ConversationsApi {
|
|
|
10126
10126
|
/**
|
|
10127
10127
|
* Conversations service.
|
|
10128
10128
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
10129
|
-
* @version
|
|
10129
|
+
* @version 98.0.0
|
|
10130
10130
|
*/
|
|
10131
10131
|
|
|
10132
10132
|
/**
|
|
@@ -14184,7 +14184,7 @@ class DataExtensionsApi {
|
|
|
14184
14184
|
/**
|
|
14185
14185
|
* DataExtensions service.
|
|
14186
14186
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14187
|
-
* @version
|
|
14187
|
+
* @version 98.0.0
|
|
14188
14188
|
*/
|
|
14189
14189
|
|
|
14190
14190
|
/**
|
|
@@ -14270,7 +14270,7 @@ class ExternalContactsApi {
|
|
|
14270
14270
|
/**
|
|
14271
14271
|
* ExternalContacts service.
|
|
14272
14272
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14273
|
-
* @version
|
|
14273
|
+
* @version 98.0.0
|
|
14274
14274
|
*/
|
|
14275
14275
|
|
|
14276
14276
|
/**
|
|
@@ -15613,7 +15613,7 @@ class FaxApi {
|
|
|
15613
15613
|
/**
|
|
15614
15614
|
* Fax service.
|
|
15615
15615
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15616
|
-
* @version
|
|
15616
|
+
* @version 98.0.0
|
|
15617
15617
|
*/
|
|
15618
15618
|
|
|
15619
15619
|
/**
|
|
@@ -15784,7 +15784,7 @@ class FlowsApi {
|
|
|
15784
15784
|
/**
|
|
15785
15785
|
* Flows service.
|
|
15786
15786
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15787
|
-
* @version
|
|
15787
|
+
* @version 98.0.0
|
|
15788
15788
|
*/
|
|
15789
15789
|
|
|
15790
15790
|
/**
|
|
@@ -15855,7 +15855,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
15855
15855
|
/**
|
|
15856
15856
|
* GeneralDataProtectionRegulation service.
|
|
15857
15857
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
15858
|
-
* @version
|
|
15858
|
+
* @version 98.0.0
|
|
15859
15859
|
*/
|
|
15860
15860
|
|
|
15861
15861
|
/**
|
|
@@ -15985,7 +15985,7 @@ class GeolocationApi {
|
|
|
15985
15985
|
/**
|
|
15986
15986
|
* Geolocation service.
|
|
15987
15987
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
15988
|
-
* @version
|
|
15988
|
+
* @version 98.0.0
|
|
15989
15989
|
*/
|
|
15990
15990
|
|
|
15991
15991
|
/**
|
|
@@ -16116,7 +16116,7 @@ class GreetingsApi {
|
|
|
16116
16116
|
/**
|
|
16117
16117
|
* Greetings service.
|
|
16118
16118
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
16119
|
-
* @version
|
|
16119
|
+
* @version 98.0.0
|
|
16120
16120
|
*/
|
|
16121
16121
|
|
|
16122
16122
|
/**
|
|
@@ -16571,7 +16571,7 @@ class GroupsApi {
|
|
|
16571
16571
|
/**
|
|
16572
16572
|
* Groups service.
|
|
16573
16573
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
16574
|
-
* @version
|
|
16574
|
+
* @version 98.0.0
|
|
16575
16575
|
*/
|
|
16576
16576
|
|
|
16577
16577
|
/**
|
|
@@ -16976,7 +16976,7 @@ class IdentityProviderApi {
|
|
|
16976
16976
|
/**
|
|
16977
16977
|
* IdentityProvider service.
|
|
16978
16978
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
16979
|
-
* @version
|
|
16979
|
+
* @version 98.0.0
|
|
16980
16980
|
*/
|
|
16981
16981
|
|
|
16982
16982
|
/**
|
|
@@ -17732,7 +17732,7 @@ class IntegrationsApi {
|
|
|
17732
17732
|
/**
|
|
17733
17733
|
* Integrations service.
|
|
17734
17734
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
17735
|
-
* @version
|
|
17735
|
+
* @version 98.0.0
|
|
17736
17736
|
*/
|
|
17737
17737
|
|
|
17738
17738
|
/**
|
|
@@ -19224,7 +19224,7 @@ class JourneyApi {
|
|
|
19224
19224
|
/**
|
|
19225
19225
|
* Journey service.
|
|
19226
19226
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
19227
|
-
* @version
|
|
19227
|
+
* @version 98.0.0
|
|
19228
19228
|
*/
|
|
19229
19229
|
|
|
19230
19230
|
/**
|
|
@@ -19289,107 +19289,6 @@ class JourneyApi {
|
|
|
19289
19289
|
);
|
|
19290
19290
|
}
|
|
19291
19291
|
|
|
19292
|
-
/**
|
|
19293
|
-
* Retrieve segment assignments by customer ID.
|
|
19294
|
-
*
|
|
19295
|
-
* @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
|
|
19296
|
-
* @param {String} customerId Primary identifier of the customer to query for segment assignments.
|
|
19297
|
-
* @param {Object} opts Optional parameters
|
|
19298
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
19299
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
19300
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
19301
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
19302
|
-
*/
|
|
19303
|
-
getJourneyCustomerCustomerIdSegments(customerIdType, customerId, opts) {
|
|
19304
|
-
opts = opts || {};
|
|
19305
|
-
|
|
19306
|
-
// verify the required parameter 'customerIdType' is set
|
|
19307
|
-
if (customerIdType === undefined || customerIdType === null) {
|
|
19308
|
-
throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSegments';
|
|
19309
|
-
}
|
|
19310
|
-
// verify the required parameter 'customerId' is set
|
|
19311
|
-
if (customerId === undefined || customerId === null) {
|
|
19312
|
-
throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSegments';
|
|
19313
|
-
}
|
|
19314
|
-
|
|
19315
|
-
return this.apiClient.callApi(
|
|
19316
|
-
'/api/v2/journey/customers/{customerIdType}/{customerId}/segments',
|
|
19317
|
-
'GET',
|
|
19318
|
-
{ 'customerIdType': customerIdType,'customerId': customerId },
|
|
19319
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
19320
|
-
{ },
|
|
19321
|
-
{ },
|
|
19322
|
-
null,
|
|
19323
|
-
['PureCloud OAuth'],
|
|
19324
|
-
['application/json'],
|
|
19325
|
-
['application/json']
|
|
19326
|
-
);
|
|
19327
|
-
}
|
|
19328
|
-
|
|
19329
|
-
/**
|
|
19330
|
-
* Retrieve segment assignments by external contact ID.
|
|
19331
|
-
*
|
|
19332
|
-
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
19333
|
-
* @param {Object} opts Optional parameters
|
|
19334
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
19335
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
19336
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
19337
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
19338
|
-
*/
|
|
19339
|
-
getJourneyExternalcontactSegments(externalContactId, opts) {
|
|
19340
|
-
opts = opts || {};
|
|
19341
|
-
|
|
19342
|
-
// verify the required parameter 'externalContactId' is set
|
|
19343
|
-
if (externalContactId === undefined || externalContactId === null) {
|
|
19344
|
-
throw 'Missing the required parameter "externalContactId" when calling getJourneyExternalcontactSegments';
|
|
19345
|
-
}
|
|
19346
|
-
|
|
19347
|
-
return this.apiClient.callApi(
|
|
19348
|
-
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
19349
|
-
'GET',
|
|
19350
|
-
{ 'externalContactId': externalContactId },
|
|
19351
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
19352
|
-
{ },
|
|
19353
|
-
{ },
|
|
19354
|
-
null,
|
|
19355
|
-
['PureCloud OAuth'],
|
|
19356
|
-
['application/json'],
|
|
19357
|
-
['application/json']
|
|
19358
|
-
);
|
|
19359
|
-
}
|
|
19360
|
-
|
|
19361
|
-
/**
|
|
19362
|
-
* Retrieve segment assignments by session ID.
|
|
19363
|
-
*
|
|
19364
|
-
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
19365
|
-
* @param {Object} opts Optional parameters
|
|
19366
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
19367
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
19368
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
19369
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
19370
|
-
*/
|
|
19371
|
-
getJourneySessionSegments(sessionId, opts) {
|
|
19372
|
-
opts = opts || {};
|
|
19373
|
-
|
|
19374
|
-
// verify the required parameter 'sessionId' is set
|
|
19375
|
-
if (sessionId === undefined || sessionId === null) {
|
|
19376
|
-
throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
|
|
19377
|
-
}
|
|
19378
|
-
|
|
19379
|
-
return this.apiClient.callApi(
|
|
19380
|
-
'/api/v2/journey/sessions/{sessionId}/segments',
|
|
19381
|
-
'GET',
|
|
19382
|
-
{ 'sessionId': sessionId },
|
|
19383
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
19384
|
-
{ },
|
|
19385
|
-
{ },
|
|
19386
|
-
null,
|
|
19387
|
-
['PureCloud OAuth'],
|
|
19388
|
-
['application/json'],
|
|
19389
|
-
['application/json']
|
|
19390
|
-
);
|
|
19391
|
-
}
|
|
19392
|
-
|
|
19393
19292
|
/**
|
|
19394
19293
|
* Update a single action target.
|
|
19395
19294
|
*
|
|
@@ -19444,42 +19343,13 @@ class JourneyApi {
|
|
|
19444
19343
|
);
|
|
19445
19344
|
}
|
|
19446
19345
|
|
|
19447
|
-
/**
|
|
19448
|
-
* Assign/Unassign a segment to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
|
|
19449
|
-
*
|
|
19450
|
-
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
19451
|
-
* @param {Object} opts Optional parameters
|
|
19452
|
-
* @param {Array.<Object>} opts.body
|
|
19453
|
-
*/
|
|
19454
|
-
postJourneyExternalcontactSegments(externalContactId, opts) {
|
|
19455
|
-
opts = opts || {};
|
|
19456
|
-
|
|
19457
|
-
// verify the required parameter 'externalContactId' is set
|
|
19458
|
-
if (externalContactId === undefined || externalContactId === null) {
|
|
19459
|
-
throw 'Missing the required parameter "externalContactId" when calling postJourneyExternalcontactSegments';
|
|
19460
|
-
}
|
|
19461
|
-
|
|
19462
|
-
return this.apiClient.callApi(
|
|
19463
|
-
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
19464
|
-
'POST',
|
|
19465
|
-
{ 'externalContactId': externalContactId },
|
|
19466
|
-
{ },
|
|
19467
|
-
{ },
|
|
19468
|
-
{ },
|
|
19469
|
-
opts['body'],
|
|
19470
|
-
['PureCloud OAuth'],
|
|
19471
|
-
['application/json'],
|
|
19472
|
-
['application/json']
|
|
19473
|
-
);
|
|
19474
|
-
}
|
|
19475
|
-
|
|
19476
19346
|
}
|
|
19477
19347
|
|
|
19478
19348
|
class KnowledgeApi {
|
|
19479
19349
|
/**
|
|
19480
19350
|
* Knowledge service.
|
|
19481
19351
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
19482
|
-
* @version
|
|
19352
|
+
* @version 98.0.0
|
|
19483
19353
|
*/
|
|
19484
19354
|
|
|
19485
19355
|
/**
|
|
@@ -19732,6 +19602,7 @@ class KnowledgeApi {
|
|
|
19732
19602
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
19733
19603
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
19734
19604
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
19605
|
+
* @param {String} opts.title Filter by document title.
|
|
19735
19606
|
*/
|
|
19736
19607
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
19737
19608
|
opts = opts || {};
|
|
@@ -19749,7 +19620,7 @@ class KnowledgeApi {
|
|
|
19749
19620
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
19750
19621
|
'GET',
|
|
19751
19622
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
19752
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'] },
|
|
19623
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'] },
|
|
19753
19624
|
{ },
|
|
19754
19625
|
{ },
|
|
19755
19626
|
null,
|
|
@@ -20200,7 +20071,7 @@ class LanguageUnderstandingApi {
|
|
|
20200
20071
|
/**
|
|
20201
20072
|
* LanguageUnderstanding service.
|
|
20202
20073
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
20203
|
-
* @version
|
|
20074
|
+
* @version 98.0.0
|
|
20204
20075
|
*/
|
|
20205
20076
|
|
|
20206
20077
|
/**
|
|
@@ -20766,7 +20637,7 @@ class LanguagesApi {
|
|
|
20766
20637
|
/**
|
|
20767
20638
|
* Languages service.
|
|
20768
20639
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
20769
|
-
* @version
|
|
20640
|
+
* @version 98.0.0
|
|
20770
20641
|
*/
|
|
20771
20642
|
|
|
20772
20643
|
/**
|
|
@@ -21034,7 +20905,7 @@ class LicenseApi {
|
|
|
21034
20905
|
/**
|
|
21035
20906
|
* License service.
|
|
21036
20907
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
21037
|
-
* @version
|
|
20908
|
+
* @version 98.0.0
|
|
21038
20909
|
*/
|
|
21039
20910
|
|
|
21040
20911
|
/**
|
|
@@ -21272,7 +21143,7 @@ class LocationsApi {
|
|
|
21272
21143
|
/**
|
|
21273
21144
|
* Locations service.
|
|
21274
21145
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
21275
|
-
* @version
|
|
21146
|
+
* @version 98.0.0
|
|
21276
21147
|
*/
|
|
21277
21148
|
|
|
21278
21149
|
/**
|
|
@@ -21508,7 +21379,7 @@ class MobileDevicesApi {
|
|
|
21508
21379
|
/**
|
|
21509
21380
|
* MobileDevices service.
|
|
21510
21381
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
21511
|
-
* @version
|
|
21382
|
+
* @version 98.0.0
|
|
21512
21383
|
*/
|
|
21513
21384
|
|
|
21514
21385
|
/**
|
|
@@ -21659,7 +21530,7 @@ class NotificationsApi {
|
|
|
21659
21530
|
/**
|
|
21660
21531
|
* Notifications service.
|
|
21661
21532
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
21662
|
-
* @version
|
|
21533
|
+
* @version 98.0.0
|
|
21663
21534
|
*/
|
|
21664
21535
|
|
|
21665
21536
|
/**
|
|
@@ -21858,7 +21729,7 @@ class OAuthApi {
|
|
|
21858
21729
|
/**
|
|
21859
21730
|
* OAuth service.
|
|
21860
21731
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
21861
|
-
* @version
|
|
21732
|
+
* @version 98.0.0
|
|
21862
21733
|
*/
|
|
21863
21734
|
|
|
21864
21735
|
/**
|
|
@@ -22216,7 +22087,7 @@ class ObjectsApi {
|
|
|
22216
22087
|
/**
|
|
22217
22088
|
* Objects service.
|
|
22218
22089
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
22219
|
-
* @version
|
|
22090
|
+
* @version 98.0.0
|
|
22220
22091
|
*/
|
|
22221
22092
|
|
|
22222
22093
|
/**
|
|
@@ -22457,7 +22328,7 @@ class OrganizationApi {
|
|
|
22457
22328
|
/**
|
|
22458
22329
|
* Organization service.
|
|
22459
22330
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
22460
|
-
* @version
|
|
22331
|
+
* @version 98.0.0
|
|
22461
22332
|
*/
|
|
22462
22333
|
|
|
22463
22334
|
/**
|
|
@@ -22712,7 +22583,7 @@ class OrganizationAuthorizationApi {
|
|
|
22712
22583
|
/**
|
|
22713
22584
|
* OrganizationAuthorization service.
|
|
22714
22585
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
22715
|
-
* @version
|
|
22586
|
+
* @version 98.0.0
|
|
22716
22587
|
*/
|
|
22717
22588
|
|
|
22718
22589
|
/**
|
|
@@ -23422,7 +23293,7 @@ class OutboundApi {
|
|
|
23422
23293
|
/**
|
|
23423
23294
|
* Outbound service.
|
|
23424
23295
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
23425
|
-
* @version
|
|
23296
|
+
* @version 98.0.0
|
|
23426
23297
|
*/
|
|
23427
23298
|
|
|
23428
23299
|
/**
|
|
@@ -26396,7 +26267,7 @@ class PresenceApi {
|
|
|
26396
26267
|
/**
|
|
26397
26268
|
* Presence service.
|
|
26398
26269
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
26399
|
-
* @version
|
|
26270
|
+
* @version 98.0.0
|
|
26400
26271
|
*/
|
|
26401
26272
|
|
|
26402
26273
|
/**
|
|
@@ -26743,7 +26614,7 @@ class QualityApi {
|
|
|
26743
26614
|
/**
|
|
26744
26615
|
* Quality service.
|
|
26745
26616
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
26746
|
-
* @version
|
|
26617
|
+
* @version 98.0.0
|
|
26747
26618
|
*/
|
|
26748
26619
|
|
|
26749
26620
|
/**
|
|
@@ -27337,6 +27208,7 @@ class QualityApi {
|
|
|
27337
27208
|
* @param {Object} opts Optional parameters
|
|
27338
27209
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
27339
27210
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
27211
|
+
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
27340
27212
|
*/
|
|
27341
27213
|
getQualityFormsEvaluationVersions(formId, opts) {
|
|
27342
27214
|
opts = opts || {};
|
|
@@ -27350,7 +27222,7 @@ class QualityApi {
|
|
|
27350
27222
|
'/api/v2/quality/forms/evaluations/{formId}/versions',
|
|
27351
27223
|
'GET',
|
|
27352
27224
|
{ 'formId': formId },
|
|
27353
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
27225
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
27354
27226
|
{ },
|
|
27355
27227
|
{ },
|
|
27356
27228
|
null,
|
|
@@ -28440,7 +28312,7 @@ class RecordingApi {
|
|
|
28440
28312
|
/**
|
|
28441
28313
|
* Recording service.
|
|
28442
28314
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
28443
|
-
* @version
|
|
28315
|
+
* @version 98.0.0
|
|
28444
28316
|
*/
|
|
28445
28317
|
|
|
28446
28318
|
/**
|
|
@@ -29686,7 +29558,7 @@ class ResponseManagementApi {
|
|
|
29686
29558
|
/**
|
|
29687
29559
|
* ResponseManagement service.
|
|
29688
29560
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
29689
|
-
* @version
|
|
29561
|
+
* @version 98.0.0
|
|
29690
29562
|
*/
|
|
29691
29563
|
|
|
29692
29564
|
/**
|
|
@@ -30011,7 +29883,7 @@ class RoutingApi {
|
|
|
30011
29883
|
/**
|
|
30012
29884
|
* Routing service.
|
|
30013
29885
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
30014
|
-
* @version
|
|
29886
|
+
* @version 98.0.0
|
|
30015
29887
|
*/
|
|
30016
29888
|
|
|
30017
29889
|
/**
|
|
@@ -32309,7 +32181,7 @@ class SCIMApi {
|
|
|
32309
32181
|
/**
|
|
32310
32182
|
* SCIM service.
|
|
32311
32183
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
32312
|
-
* @version
|
|
32184
|
+
* @version 98.0.0
|
|
32313
32185
|
*/
|
|
32314
32186
|
|
|
32315
32187
|
/**
|
|
@@ -33294,7 +33166,7 @@ class ScriptsApi {
|
|
|
33294
33166
|
/**
|
|
33295
33167
|
* Scripts service.
|
|
33296
33168
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
33297
|
-
* @version
|
|
33169
|
+
* @version 98.0.0
|
|
33298
33170
|
*/
|
|
33299
33171
|
|
|
33300
33172
|
/**
|
|
@@ -33647,7 +33519,7 @@ class SearchApi {
|
|
|
33647
33519
|
/**
|
|
33648
33520
|
* Search service.
|
|
33649
33521
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
33650
|
-
* @version
|
|
33522
|
+
* @version 98.0.0
|
|
33651
33523
|
*/
|
|
33652
33524
|
|
|
33653
33525
|
/**
|
|
@@ -34157,7 +34029,7 @@ class SpeechTextAnalyticsApi {
|
|
|
34157
34029
|
/**
|
|
34158
34030
|
* SpeechTextAnalytics service.
|
|
34159
34031
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
34160
|
-
* @version
|
|
34032
|
+
* @version 98.0.0
|
|
34161
34033
|
*/
|
|
34162
34034
|
|
|
34163
34035
|
/**
|
|
@@ -34233,7 +34105,7 @@ class StationsApi {
|
|
|
34233
34105
|
/**
|
|
34234
34106
|
* Stations service.
|
|
34235
34107
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
34236
|
-
* @version
|
|
34108
|
+
* @version 98.0.0
|
|
34237
34109
|
*/
|
|
34238
34110
|
|
|
34239
34111
|
/**
|
|
@@ -34380,7 +34252,7 @@ class SuggestApi {
|
|
|
34380
34252
|
/**
|
|
34381
34253
|
* Suggest service.
|
|
34382
34254
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
34383
|
-
* @version
|
|
34255
|
+
* @version 98.0.0
|
|
34384
34256
|
*/
|
|
34385
34257
|
|
|
34386
34258
|
/**
|
|
@@ -34519,7 +34391,7 @@ class TelephonyApi {
|
|
|
34519
34391
|
/**
|
|
34520
34392
|
* Telephony service.
|
|
34521
34393
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
34522
|
-
* @version
|
|
34394
|
+
* @version 98.0.0
|
|
34523
34395
|
*/
|
|
34524
34396
|
|
|
34525
34397
|
/**
|
|
@@ -34627,7 +34499,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
34627
34499
|
/**
|
|
34628
34500
|
* TelephonyProvidersEdge service.
|
|
34629
34501
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
34630
|
-
* @version
|
|
34502
|
+
* @version 98.0.0
|
|
34631
34503
|
*/
|
|
34632
34504
|
|
|
34633
34505
|
/**
|
|
@@ -38204,7 +38076,7 @@ class TextbotsApi {
|
|
|
38204
38076
|
/**
|
|
38205
38077
|
* Textbots service.
|
|
38206
38078
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
38207
|
-
* @version
|
|
38079
|
+
* @version 98.0.0
|
|
38208
38080
|
*/
|
|
38209
38081
|
|
|
38210
38082
|
/**
|
|
@@ -38250,7 +38122,7 @@ class TokensApi {
|
|
|
38250
38122
|
/**
|
|
38251
38123
|
* Tokens service.
|
|
38252
38124
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
38253
|
-
* @version
|
|
38125
|
+
* @version 98.0.0
|
|
38254
38126
|
*/
|
|
38255
38127
|
|
|
38256
38128
|
/**
|
|
@@ -38336,7 +38208,7 @@ class UploadsApi {
|
|
|
38336
38208
|
/**
|
|
38337
38209
|
* Uploads service.
|
|
38338
38210
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
38339
|
-
* @version
|
|
38211
|
+
* @version 98.0.0
|
|
38340
38212
|
*/
|
|
38341
38213
|
|
|
38342
38214
|
/**
|
|
@@ -38382,7 +38254,7 @@ class UsageApi {
|
|
|
38382
38254
|
/**
|
|
38383
38255
|
* Usage service.
|
|
38384
38256
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
38385
|
-
* @version
|
|
38257
|
+
* @version 98.0.0
|
|
38386
38258
|
*/
|
|
38387
38259
|
|
|
38388
38260
|
/**
|
|
@@ -38453,7 +38325,7 @@ class UserRecordingsApi {
|
|
|
38453
38325
|
/**
|
|
38454
38326
|
* UserRecordings service.
|
|
38455
38327
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
38456
|
-
* @version
|
|
38328
|
+
* @version 98.0.0
|
|
38457
38329
|
*/
|
|
38458
38330
|
|
|
38459
38331
|
/**
|
|
@@ -38637,7 +38509,7 @@ class UsersApi {
|
|
|
38637
38509
|
/**
|
|
38638
38510
|
* Users service.
|
|
38639
38511
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
38640
|
-
* @version
|
|
38512
|
+
* @version 98.0.0
|
|
38641
38513
|
*/
|
|
38642
38514
|
|
|
38643
38515
|
/**
|
|
@@ -40850,7 +40722,7 @@ class UtilitiesApi {
|
|
|
40850
40722
|
/**
|
|
40851
40723
|
* Utilities service.
|
|
40852
40724
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
40853
|
-
* @version
|
|
40725
|
+
* @version 98.0.0
|
|
40854
40726
|
*/
|
|
40855
40727
|
|
|
40856
40728
|
/**
|
|
@@ -40961,7 +40833,7 @@ class VoicemailApi {
|
|
|
40961
40833
|
/**
|
|
40962
40834
|
* Voicemail service.
|
|
40963
40835
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
40964
|
-
* @version
|
|
40836
|
+
* @version 98.0.0
|
|
40965
40837
|
*/
|
|
40966
40838
|
|
|
40967
40839
|
/**
|
|
@@ -41598,7 +41470,7 @@ class WebChatApi {
|
|
|
41598
41470
|
/**
|
|
41599
41471
|
* WebChat service.
|
|
41600
41472
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
41601
|
-
* @version
|
|
41473
|
+
* @version 98.0.0
|
|
41602
41474
|
*/
|
|
41603
41475
|
|
|
41604
41476
|
/**
|
|
@@ -42142,7 +42014,7 @@ class WidgetsApi {
|
|
|
42142
42014
|
/**
|
|
42143
42015
|
* Widgets service.
|
|
42144
42016
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
42145
|
-
* @version
|
|
42017
|
+
* @version 98.0.0
|
|
42146
42018
|
*/
|
|
42147
42019
|
|
|
42148
42020
|
/**
|
|
@@ -42288,7 +42160,7 @@ class WorkforceManagementApi {
|
|
|
42288
42160
|
/**
|
|
42289
42161
|
* WorkforceManagement service.
|
|
42290
42162
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
42291
|
-
* @version
|
|
42163
|
+
* @version 98.0.0
|
|
42292
42164
|
*/
|
|
42293
42165
|
|
|
42294
42166
|
/**
|
|
@@ -44343,6 +44215,7 @@ class WorkforceManagementApi {
|
|
|
44343
44215
|
* @param {String} workPlanId The ID of the work plan to update
|
|
44344
44216
|
* @param {Object} opts Optional parameters
|
|
44345
44217
|
* @param {Object} opts.body body
|
|
44218
|
+
* @param {Object} opts.validationMode Allows to update work plan even if validation result is invalid
|
|
44346
44219
|
*/
|
|
44347
44220
|
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
|
|
44348
44221
|
opts = opts || {};
|
|
@@ -44360,7 +44233,7 @@ class WorkforceManagementApi {
|
|
|
44360
44233
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
44361
44234
|
'PATCH',
|
|
44362
44235
|
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
44363
|
-
{
|
|
44236
|
+
{ 'validationMode': opts['validationMode'] },
|
|
44364
44237
|
{ },
|
|
44365
44238
|
{ },
|
|
44366
44239
|
opts['body'],
|
|
@@ -45394,6 +45267,7 @@ class WorkforceManagementApi {
|
|
|
45394
45267
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
45395
45268
|
* @param {Object} opts Optional parameters
|
|
45396
45269
|
* @param {Object} opts.body body
|
|
45270
|
+
* @param {Object} opts.validationMode Allows to create work plan even if the validation result is invalid
|
|
45397
45271
|
*/
|
|
45398
45272
|
postWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
45399
45273
|
opts = opts || {};
|
|
@@ -45407,7 +45281,7 @@ class WorkforceManagementApi {
|
|
|
45407
45281
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
45408
45282
|
'POST',
|
|
45409
45283
|
{ 'managementUnitId': managementUnitId },
|
|
45410
|
-
{
|
|
45284
|
+
{ 'validationMode': opts['validationMode'] },
|
|
45411
45285
|
{ },
|
|
45412
45286
|
{ },
|
|
45413
45287
|
opts['body'],
|
|
@@ -45544,7 +45418,7 @@ class WorkforceManagementApi {
|
|
|
45544
45418
|
* </pre>
|
|
45545
45419
|
* </p>
|
|
45546
45420
|
* @module purecloud-platform-client-v2/index
|
|
45547
|
-
* @version
|
|
45421
|
+
* @version 98.0.0
|
|
45548
45422
|
*/
|
|
45549
45423
|
class platformClient {
|
|
45550
45424
|
constructor() {
|