purecloud-platform-client-v2 173.1.0 → 175.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 +1580 -131
- package/dist/web-amd/purecloud-platform-client-v2.js +1580 -131
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1580 -131
- package/dist/web-cjs/purecloud-platform-client-v2.js +1580 -131
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1223 -20
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +612 -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/CarrierServicesApi.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 +223 -5
- 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/EmailsApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +62 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +188 -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/LearningApi.js +7 -3
- 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/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +10 -8
- 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/SettingsApi.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/TaskManagementApi.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 +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +7 -3
- 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 +10 -5
- 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 +362 -5
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2279,7 +2279,7 @@ class Configuration {
|
|
|
2279
2279
|
|
|
2280
2280
|
/**
|
|
2281
2281
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2282
|
-
* @version
|
|
2282
|
+
* @version 175.0.0
|
|
2283
2283
|
*/
|
|
2284
2284
|
class ApiClient {
|
|
2285
2285
|
/**
|
|
@@ -3358,7 +3358,7 @@ class AlertingApi {
|
|
|
3358
3358
|
/**
|
|
3359
3359
|
* Alerting service.
|
|
3360
3360
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3361
|
-
* @version
|
|
3361
|
+
* @version 175.0.0
|
|
3362
3362
|
*/
|
|
3363
3363
|
|
|
3364
3364
|
/**
|
|
@@ -4008,7 +4008,7 @@ class AnalyticsApi {
|
|
|
4008
4008
|
/**
|
|
4009
4009
|
* Analytics service.
|
|
4010
4010
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4011
|
-
* @version
|
|
4011
|
+
* @version 175.0.0
|
|
4012
4012
|
*/
|
|
4013
4013
|
|
|
4014
4014
|
/**
|
|
@@ -4156,13 +4156,14 @@ class AnalyticsApi {
|
|
|
4156
4156
|
|
|
4157
4157
|
/**
|
|
4158
4158
|
* Get Reporting Turns.
|
|
4159
|
-
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list.
|
|
4159
|
+
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint do not persist indefinitely, as they auto delete after a predefined period.
|
|
4160
4160
|
* @param {String} botFlowId ID of the bot flow.
|
|
4161
4161
|
* @param {Object} opts Optional parameters
|
|
4162
4162
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
4163
4163
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
4164
|
+
* @param {String} opts.interval Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
4164
4165
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
4165
|
-
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
4166
|
+
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
|
|
4166
4167
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
4167
4168
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
4168
4169
|
*/
|
|
@@ -4178,7 +4179,7 @@ class AnalyticsApi {
|
|
|
4178
4179
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
4179
4180
|
'GET',
|
|
4180
4181
|
{ 'botFlowId': botFlowId },
|
|
4181
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
4182
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
4182
4183
|
{ },
|
|
4183
4184
|
{ },
|
|
4184
4185
|
null,
|
|
@@ -6453,7 +6454,7 @@ class ArchitectApi {
|
|
|
6453
6454
|
/**
|
|
6454
6455
|
* Architect service.
|
|
6455
6456
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6456
|
-
* @version
|
|
6457
|
+
* @version 175.0.0
|
|
6457
6458
|
*/
|
|
6458
6459
|
|
|
6459
6460
|
/**
|
|
@@ -6493,6 +6494,125 @@ class ArchitectApi {
|
|
|
6493
6494
|
);
|
|
6494
6495
|
}
|
|
6495
6496
|
|
|
6497
|
+
/**
|
|
6498
|
+
* Delete a grammar.
|
|
6499
|
+
*
|
|
6500
|
+
* @param {String} grammarId grammar ID
|
|
6501
|
+
* deleteArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6502
|
+
*/
|
|
6503
|
+
deleteArchitectGrammar(grammarId) {
|
|
6504
|
+
// verify the required parameter 'grammarId' is set
|
|
6505
|
+
if (grammarId === undefined || grammarId === null) {
|
|
6506
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';
|
|
6507
|
+
}
|
|
6508
|
+
|
|
6509
|
+
return this.apiClient.callApi(
|
|
6510
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
6511
|
+
'DELETE',
|
|
6512
|
+
{ 'grammarId': grammarId },
|
|
6513
|
+
{ },
|
|
6514
|
+
{ },
|
|
6515
|
+
{ },
|
|
6516
|
+
null,
|
|
6517
|
+
['PureCloud OAuth'],
|
|
6518
|
+
['application/json'],
|
|
6519
|
+
['application/json']
|
|
6520
|
+
);
|
|
6521
|
+
}
|
|
6522
|
+
|
|
6523
|
+
/**
|
|
6524
|
+
* Delete specified grammar language
|
|
6525
|
+
*
|
|
6526
|
+
* @param {String} grammarId Grammar ID
|
|
6527
|
+
* @param {String} languageCode Language
|
|
6528
|
+
* deleteArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6529
|
+
*/
|
|
6530
|
+
deleteArchitectGrammarLanguage(grammarId, languageCode) {
|
|
6531
|
+
// verify the required parameter 'grammarId' is set
|
|
6532
|
+
if (grammarId === undefined || grammarId === null) {
|
|
6533
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';
|
|
6534
|
+
}
|
|
6535
|
+
// verify the required parameter 'languageCode' is set
|
|
6536
|
+
if (languageCode === undefined || languageCode === null) {
|
|
6537
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';
|
|
6538
|
+
}
|
|
6539
|
+
|
|
6540
|
+
return this.apiClient.callApi(
|
|
6541
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
6542
|
+
'DELETE',
|
|
6543
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
6544
|
+
{ },
|
|
6545
|
+
{ },
|
|
6546
|
+
{ },
|
|
6547
|
+
null,
|
|
6548
|
+
['PureCloud OAuth'],
|
|
6549
|
+
['application/json'],
|
|
6550
|
+
['application/json']
|
|
6551
|
+
);
|
|
6552
|
+
}
|
|
6553
|
+
|
|
6554
|
+
/**
|
|
6555
|
+
* Clear the DTMF mode file for the grammar language if there is one
|
|
6556
|
+
*
|
|
6557
|
+
* @param {String} grammarId Grammar ID
|
|
6558
|
+
* @param {String} languageCode Language
|
|
6559
|
+
* deleteArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6560
|
+
*/
|
|
6561
|
+
deleteArchitectGrammarLanguageFilesDtmf(grammarId, languageCode) {
|
|
6562
|
+
// verify the required parameter 'grammarId' is set
|
|
6563
|
+
if (grammarId === undefined || grammarId === null) {
|
|
6564
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
6565
|
+
}
|
|
6566
|
+
// verify the required parameter 'languageCode' is set
|
|
6567
|
+
if (languageCode === undefined || languageCode === null) {
|
|
6568
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
6569
|
+
}
|
|
6570
|
+
|
|
6571
|
+
return this.apiClient.callApi(
|
|
6572
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
6573
|
+
'DELETE',
|
|
6574
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
6575
|
+
{ },
|
|
6576
|
+
{ },
|
|
6577
|
+
{ },
|
|
6578
|
+
null,
|
|
6579
|
+
['PureCloud OAuth'],
|
|
6580
|
+
['application/json'],
|
|
6581
|
+
['application/json']
|
|
6582
|
+
);
|
|
6583
|
+
}
|
|
6584
|
+
|
|
6585
|
+
/**
|
|
6586
|
+
* Clear the voice mode file for the grammar language if there is one
|
|
6587
|
+
*
|
|
6588
|
+
* @param {String} grammarId Grammar ID
|
|
6589
|
+
* @param {String} languageCode Language
|
|
6590
|
+
* deleteArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6591
|
+
*/
|
|
6592
|
+
deleteArchitectGrammarLanguageFilesVoice(grammarId, languageCode) {
|
|
6593
|
+
// verify the required parameter 'grammarId' is set
|
|
6594
|
+
if (grammarId === undefined || grammarId === null) {
|
|
6595
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
6596
|
+
}
|
|
6597
|
+
// verify the required parameter 'languageCode' is set
|
|
6598
|
+
if (languageCode === undefined || languageCode === null) {
|
|
6599
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
6600
|
+
}
|
|
6601
|
+
|
|
6602
|
+
return this.apiClient.callApi(
|
|
6603
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
6604
|
+
'DELETE',
|
|
6605
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
6606
|
+
{ },
|
|
6607
|
+
{ },
|
|
6608
|
+
{ },
|
|
6609
|
+
null,
|
|
6610
|
+
['PureCloud OAuth'],
|
|
6611
|
+
['application/json'],
|
|
6612
|
+
['application/json']
|
|
6613
|
+
);
|
|
6614
|
+
}
|
|
6615
|
+
|
|
6496
6616
|
/**
|
|
6497
6617
|
* Delete an IVR Config.
|
|
6498
6618
|
*
|
|
@@ -7177,6 +7297,130 @@ class ArchitectApi {
|
|
|
7177
7297
|
);
|
|
7178
7298
|
}
|
|
7179
7299
|
|
|
7300
|
+
/**
|
|
7301
|
+
* Get a pageable list of basic emergency group objects filterable by query parameters.
|
|
7302
|
+
* This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.
|
|
7303
|
+
* @param {Object} opts Optional parameters
|
|
7304
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7305
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7306
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
7307
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
7308
|
+
* @param {Array.<String>} opts.id ID of the Emergency Groups to filter by.
|
|
7309
|
+
* @param {String} opts.name Name of the Emergency Group to filter by.
|
|
7310
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7311
|
+
*/
|
|
7312
|
+
getArchitectEmergencygroupsDivisionviews(opts) {
|
|
7313
|
+
opts = opts || {};
|
|
7314
|
+
|
|
7315
|
+
|
|
7316
|
+
return this.apiClient.callApi(
|
|
7317
|
+
'/api/v2/architect/emergencygroups/divisionviews',
|
|
7318
|
+
'GET',
|
|
7319
|
+
{ },
|
|
7320
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
7321
|
+
{ },
|
|
7322
|
+
{ },
|
|
7323
|
+
null,
|
|
7324
|
+
['PureCloud OAuth'],
|
|
7325
|
+
['application/json'],
|
|
7326
|
+
['application/json']
|
|
7327
|
+
);
|
|
7328
|
+
}
|
|
7329
|
+
|
|
7330
|
+
/**
|
|
7331
|
+
* Get a grammar
|
|
7332
|
+
* Returns a specified grammar
|
|
7333
|
+
* @param {String} grammarId grammar ID
|
|
7334
|
+
* @param {Object} opts Optional parameters
|
|
7335
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
7336
|
+
* getArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7337
|
+
*/
|
|
7338
|
+
getArchitectGrammar(grammarId, opts) {
|
|
7339
|
+
opts = opts || {};
|
|
7340
|
+
|
|
7341
|
+
// verify the required parameter 'grammarId' is set
|
|
7342
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7343
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammar';
|
|
7344
|
+
}
|
|
7345
|
+
|
|
7346
|
+
return this.apiClient.callApi(
|
|
7347
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
7348
|
+
'GET',
|
|
7349
|
+
{ 'grammarId': grammarId },
|
|
7350
|
+
{ 'includeFileUrls': opts['includeFileUrls'] },
|
|
7351
|
+
{ },
|
|
7352
|
+
{ },
|
|
7353
|
+
null,
|
|
7354
|
+
['PureCloud OAuth'],
|
|
7355
|
+
['application/json'],
|
|
7356
|
+
['application/json']
|
|
7357
|
+
);
|
|
7358
|
+
}
|
|
7359
|
+
|
|
7360
|
+
/**
|
|
7361
|
+
* Get a grammar language.
|
|
7362
|
+
*
|
|
7363
|
+
* @param {String} grammarId Grammar ID
|
|
7364
|
+
* @param {String} languageCode Language
|
|
7365
|
+
* getArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7366
|
+
*/
|
|
7367
|
+
getArchitectGrammarLanguage(grammarId, languageCode) {
|
|
7368
|
+
// verify the required parameter 'grammarId' is set
|
|
7369
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7370
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';
|
|
7371
|
+
}
|
|
7372
|
+
// verify the required parameter 'languageCode' is set
|
|
7373
|
+
if (languageCode === undefined || languageCode === null) {
|
|
7374
|
+
throw 'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';
|
|
7375
|
+
}
|
|
7376
|
+
|
|
7377
|
+
return this.apiClient.callApi(
|
|
7378
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
7379
|
+
'GET',
|
|
7380
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
7381
|
+
{ },
|
|
7382
|
+
{ },
|
|
7383
|
+
{ },
|
|
7384
|
+
null,
|
|
7385
|
+
['PureCloud OAuth'],
|
|
7386
|
+
['application/json'],
|
|
7387
|
+
['application/json']
|
|
7388
|
+
);
|
|
7389
|
+
}
|
|
7390
|
+
|
|
7391
|
+
/**
|
|
7392
|
+
* Get a pageable list of grammars, filtered by query parameters
|
|
7393
|
+
* Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
|
|
7394
|
+
* @param {Object} opts Optional parameters
|
|
7395
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7396
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7397
|
+
* @param {Object} opts.sortBy Sort by (default to id)
|
|
7398
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
7399
|
+
* @param {Array.<String>} opts.id ID
|
|
7400
|
+
* @param {String} opts.name Name
|
|
7401
|
+
* @param {String} opts.description Description
|
|
7402
|
+
* @param {String} opts.nameOrDescription Name or description
|
|
7403
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
7404
|
+
* getArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7405
|
+
*/
|
|
7406
|
+
getArchitectGrammars(opts) {
|
|
7407
|
+
opts = opts || {};
|
|
7408
|
+
|
|
7409
|
+
|
|
7410
|
+
return this.apiClient.callApi(
|
|
7411
|
+
'/api/v2/architect/grammars',
|
|
7412
|
+
'GET',
|
|
7413
|
+
{ },
|
|
7414
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'includeFileUrls': opts['includeFileUrls'] },
|
|
7415
|
+
{ },
|
|
7416
|
+
{ },
|
|
7417
|
+
null,
|
|
7418
|
+
['PureCloud OAuth'],
|
|
7419
|
+
['application/json'],
|
|
7420
|
+
['application/json']
|
|
7421
|
+
);
|
|
7422
|
+
}
|
|
7423
|
+
|
|
7180
7424
|
/**
|
|
7181
7425
|
* Get an IVR config.
|
|
7182
7426
|
*
|
|
@@ -7232,6 +7476,36 @@ class ArchitectApi {
|
|
|
7232
7476
|
);
|
|
7233
7477
|
}
|
|
7234
7478
|
|
|
7479
|
+
/**
|
|
7480
|
+
* Get a pageable list of basic ivr configuration information objects filterable by query parameters.
|
|
7481
|
+
*
|
|
7482
|
+
* @param {Object} opts Optional parameters
|
|
7483
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7484
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7485
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
7486
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
7487
|
+
* @param {Array.<String>} opts.id ID of the IVR to filter by.
|
|
7488
|
+
* @param {String} opts.name Name of the IVR to filter by.
|
|
7489
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7490
|
+
*/
|
|
7491
|
+
getArchitectIvrsDivisionviews(opts) {
|
|
7492
|
+
opts = opts || {};
|
|
7493
|
+
|
|
7494
|
+
|
|
7495
|
+
return this.apiClient.callApi(
|
|
7496
|
+
'/api/v2/architect/ivrs/divisionviews',
|
|
7497
|
+
'GET',
|
|
7498
|
+
{ },
|
|
7499
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
7500
|
+
{ },
|
|
7501
|
+
{ },
|
|
7502
|
+
null,
|
|
7503
|
+
['PureCloud OAuth'],
|
|
7504
|
+
['application/json'],
|
|
7505
|
+
['application/json']
|
|
7506
|
+
);
|
|
7507
|
+
}
|
|
7508
|
+
|
|
7235
7509
|
/**
|
|
7236
7510
|
* Get specified user prompt
|
|
7237
7511
|
*
|
|
@@ -7465,6 +7739,36 @@ class ArchitectApi {
|
|
|
7465
7739
|
);
|
|
7466
7740
|
}
|
|
7467
7741
|
|
|
7742
|
+
/**
|
|
7743
|
+
* Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
|
|
7744
|
+
*
|
|
7745
|
+
* @param {Object} opts Optional parameters
|
|
7746
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7747
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7748
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
7749
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
7750
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
7751
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
7752
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7753
|
+
*/
|
|
7754
|
+
getArchitectSchedulegroupsDivisionviews(opts) {
|
|
7755
|
+
opts = opts || {};
|
|
7756
|
+
|
|
7757
|
+
|
|
7758
|
+
return this.apiClient.callApi(
|
|
7759
|
+
'/api/v2/architect/schedulegroups/divisionviews',
|
|
7760
|
+
'GET',
|
|
7761
|
+
{ },
|
|
7762
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
7763
|
+
{ },
|
|
7764
|
+
{ },
|
|
7765
|
+
null,
|
|
7766
|
+
['PureCloud OAuth'],
|
|
7767
|
+
['application/json'],
|
|
7768
|
+
['application/json']
|
|
7769
|
+
);
|
|
7770
|
+
}
|
|
7771
|
+
|
|
7468
7772
|
/**
|
|
7469
7773
|
* Get a list of schedules.
|
|
7470
7774
|
*
|
|
@@ -7494,6 +7798,36 @@ class ArchitectApi {
|
|
|
7494
7798
|
);
|
|
7495
7799
|
}
|
|
7496
7800
|
|
|
7801
|
+
/**
|
|
7802
|
+
* Get a pageable list of basic schedule configuration information objects filterable by query parameters.
|
|
7803
|
+
*
|
|
7804
|
+
* @param {Object} opts Optional parameters
|
|
7805
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7806
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7807
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
7808
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
7809
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
7810
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
7811
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
7812
|
+
*/
|
|
7813
|
+
getArchitectSchedulesDivisionviews(opts) {
|
|
7814
|
+
opts = opts || {};
|
|
7815
|
+
|
|
7816
|
+
|
|
7817
|
+
return this.apiClient.callApi(
|
|
7818
|
+
'/api/v2/architect/schedules/divisionviews',
|
|
7819
|
+
'GET',
|
|
7820
|
+
{ },
|
|
7821
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
7822
|
+
{ },
|
|
7823
|
+
{ },
|
|
7824
|
+
null,
|
|
7825
|
+
['PureCloud OAuth'],
|
|
7826
|
+
['application/json'],
|
|
7827
|
+
['application/json']
|
|
7828
|
+
);
|
|
7829
|
+
}
|
|
7830
|
+
|
|
7497
7831
|
/**
|
|
7498
7832
|
* Get a system prompt
|
|
7499
7833
|
*
|
|
@@ -7813,6 +8147,125 @@ class ArchitectApi {
|
|
|
7813
8147
|
);
|
|
7814
8148
|
}
|
|
7815
8149
|
|
|
8150
|
+
/**
|
|
8151
|
+
* Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
|
|
8152
|
+
*
|
|
8153
|
+
* @param {String} flowId Flow ID.
|
|
8154
|
+
* @param {String} versionId Version ID.
|
|
8155
|
+
* @param {Object} opts Optional parameters
|
|
8156
|
+
* @param {Object} opts.language Language to filter for
|
|
8157
|
+
*/
|
|
8158
|
+
getFlowVersionHealth(flowId, versionId, opts) {
|
|
8159
|
+
opts = opts || {};
|
|
8160
|
+
|
|
8161
|
+
// verify the required parameter 'flowId' is set
|
|
8162
|
+
if (flowId === undefined || flowId === null) {
|
|
8163
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionHealth';
|
|
8164
|
+
}
|
|
8165
|
+
// verify the required parameter 'versionId' is set
|
|
8166
|
+
if (versionId === undefined || versionId === null) {
|
|
8167
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionHealth';
|
|
8168
|
+
}
|
|
8169
|
+
|
|
8170
|
+
return this.apiClient.callApi(
|
|
8171
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/health',
|
|
8172
|
+
'GET',
|
|
8173
|
+
{ 'flowId': flowId,'versionId': versionId },
|
|
8174
|
+
{ 'language': opts['language'] },
|
|
8175
|
+
{ },
|
|
8176
|
+
{ },
|
|
8177
|
+
null,
|
|
8178
|
+
['PureCloud OAuth'],
|
|
8179
|
+
['application/json'],
|
|
8180
|
+
['application/json']
|
|
8181
|
+
);
|
|
8182
|
+
}
|
|
8183
|
+
|
|
8184
|
+
/**
|
|
8185
|
+
* Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.
|
|
8186
|
+
*
|
|
8187
|
+
* @param {String} flowId Flow ID.
|
|
8188
|
+
* @param {String} versionId Version ID.
|
|
8189
|
+
* @param {String} intentId Intent ID.
|
|
8190
|
+
* @param {Object} language Language to filter for
|
|
8191
|
+
*/
|
|
8192
|
+
getFlowVersionIntentHealth(flowId, versionId, intentId, language) {
|
|
8193
|
+
// verify the required parameter 'flowId' is set
|
|
8194
|
+
if (flowId === undefined || flowId === null) {
|
|
8195
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentHealth';
|
|
8196
|
+
}
|
|
8197
|
+
// verify the required parameter 'versionId' is set
|
|
8198
|
+
if (versionId === undefined || versionId === null) {
|
|
8199
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentHealth';
|
|
8200
|
+
}
|
|
8201
|
+
// verify the required parameter 'intentId' is set
|
|
8202
|
+
if (intentId === undefined || intentId === null) {
|
|
8203
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentHealth';
|
|
8204
|
+
}
|
|
8205
|
+
// verify the required parameter 'language' is set
|
|
8206
|
+
if (language === undefined || language === null) {
|
|
8207
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentHealth';
|
|
8208
|
+
}
|
|
8209
|
+
|
|
8210
|
+
return this.apiClient.callApi(
|
|
8211
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health',
|
|
8212
|
+
'GET',
|
|
8213
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId },
|
|
8214
|
+
{ 'language': language },
|
|
8215
|
+
{ },
|
|
8216
|
+
{ },
|
|
8217
|
+
null,
|
|
8218
|
+
['PureCloud OAuth'],
|
|
8219
|
+
['application/json'],
|
|
8220
|
+
['application/json']
|
|
8221
|
+
);
|
|
8222
|
+
}
|
|
8223
|
+
|
|
8224
|
+
/**
|
|
8225
|
+
* Get health metrics associated with a specific utterance of an intent.
|
|
8226
|
+
*
|
|
8227
|
+
* @param {String} flowId Flow ID.
|
|
8228
|
+
* @param {String} versionId Version ID.
|
|
8229
|
+
* @param {String} intentId Intent ID.
|
|
8230
|
+
* @param {String} utteranceId Utterance ID.
|
|
8231
|
+
* @param {Object} language Language to filter for
|
|
8232
|
+
*/
|
|
8233
|
+
getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language) {
|
|
8234
|
+
// verify the required parameter 'flowId' is set
|
|
8235
|
+
if (flowId === undefined || flowId === null) {
|
|
8236
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentUtteranceHealth';
|
|
8237
|
+
}
|
|
8238
|
+
// verify the required parameter 'versionId' is set
|
|
8239
|
+
if (versionId === undefined || versionId === null) {
|
|
8240
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentUtteranceHealth';
|
|
8241
|
+
}
|
|
8242
|
+
// verify the required parameter 'intentId' is set
|
|
8243
|
+
if (intentId === undefined || intentId === null) {
|
|
8244
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentUtteranceHealth';
|
|
8245
|
+
}
|
|
8246
|
+
// verify the required parameter 'utteranceId' is set
|
|
8247
|
+
if (utteranceId === undefined || utteranceId === null) {
|
|
8248
|
+
throw 'Missing the required parameter "utteranceId" when calling getFlowVersionIntentUtteranceHealth';
|
|
8249
|
+
}
|
|
8250
|
+
// verify the required parameter 'language' is set
|
|
8251
|
+
if (language === undefined || language === null) {
|
|
8252
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentUtteranceHealth';
|
|
8253
|
+
}
|
|
8254
|
+
|
|
8255
|
+
return this.apiClient.callApi(
|
|
8256
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health',
|
|
8257
|
+
'GET',
|
|
8258
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId,'utteranceId': utteranceId },
|
|
8259
|
+
{ 'language': language },
|
|
8260
|
+
{ },
|
|
8261
|
+
{ },
|
|
8262
|
+
null,
|
|
8263
|
+
['PureCloud OAuth'],
|
|
8264
|
+
['application/json'],
|
|
8265
|
+
['application/json']
|
|
8266
|
+
);
|
|
8267
|
+
}
|
|
8268
|
+
|
|
7816
8269
|
/**
|
|
7817
8270
|
* Get flow version list
|
|
7818
8271
|
*
|
|
@@ -8504,6 +8957,36 @@ class ArchitectApi {
|
|
|
8504
8957
|
);
|
|
8505
8958
|
}
|
|
8506
8959
|
|
|
8960
|
+
/**
|
|
8961
|
+
* Updates a grammar
|
|
8962
|
+
*
|
|
8963
|
+
* @param {String} grammarId grammar ID
|
|
8964
|
+
* @param {Object} opts Optional parameters
|
|
8965
|
+
* @param {Object} opts.body
|
|
8966
|
+
* patchArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8967
|
+
*/
|
|
8968
|
+
patchArchitectGrammar(grammarId, opts) {
|
|
8969
|
+
opts = opts || {};
|
|
8970
|
+
|
|
8971
|
+
// verify the required parameter 'grammarId' is set
|
|
8972
|
+
if (grammarId === undefined || grammarId === null) {
|
|
8973
|
+
throw 'Missing the required parameter "grammarId" when calling patchArchitectGrammar';
|
|
8974
|
+
}
|
|
8975
|
+
|
|
8976
|
+
return this.apiClient.callApi(
|
|
8977
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
8978
|
+
'PATCH',
|
|
8979
|
+
{ 'grammarId': grammarId },
|
|
8980
|
+
{ },
|
|
8981
|
+
{ },
|
|
8982
|
+
{ },
|
|
8983
|
+
opts['body'],
|
|
8984
|
+
['PureCloud OAuth'],
|
|
8985
|
+
['application/json'],
|
|
8986
|
+
['application/json']
|
|
8987
|
+
);
|
|
8988
|
+
}
|
|
8989
|
+
|
|
8507
8990
|
/**
|
|
8508
8991
|
* Rebuild Dependency Tracking data for an organization
|
|
8509
8992
|
* Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
|
@@ -8549,6 +9032,135 @@ class ArchitectApi {
|
|
|
8549
9032
|
);
|
|
8550
9033
|
}
|
|
8551
9034
|
|
|
9035
|
+
/**
|
|
9036
|
+
* Creates a presigned URL for uploading a grammar DTMF mode file
|
|
9037
|
+
*
|
|
9038
|
+
* @param {String} grammarId Grammar ID
|
|
9039
|
+
* @param {String} languageCode Language
|
|
9040
|
+
* @param {Object} body query
|
|
9041
|
+
* postArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9042
|
+
*/
|
|
9043
|
+
postArchitectGrammarLanguageFilesDtmf(grammarId, languageCode, body) {
|
|
9044
|
+
// verify the required parameter 'grammarId' is set
|
|
9045
|
+
if (grammarId === undefined || grammarId === null) {
|
|
9046
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
9047
|
+
}
|
|
9048
|
+
// verify the required parameter 'languageCode' is set
|
|
9049
|
+
if (languageCode === undefined || languageCode === null) {
|
|
9050
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
9051
|
+
}
|
|
9052
|
+
// verify the required parameter 'body' is set
|
|
9053
|
+
if (body === undefined || body === null) {
|
|
9054
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
9055
|
+
}
|
|
9056
|
+
|
|
9057
|
+
return this.apiClient.callApi(
|
|
9058
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
9059
|
+
'POST',
|
|
9060
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
9061
|
+
{ },
|
|
9062
|
+
{ },
|
|
9063
|
+
{ },
|
|
9064
|
+
body,
|
|
9065
|
+
['PureCloud OAuth'],
|
|
9066
|
+
['application/json'],
|
|
9067
|
+
['application/json']
|
|
9068
|
+
);
|
|
9069
|
+
}
|
|
9070
|
+
|
|
9071
|
+
/**
|
|
9072
|
+
* Creates a presigned URL for uploading a grammar voice mode file
|
|
9073
|
+
*
|
|
9074
|
+
* @param {String} grammarId Grammar ID
|
|
9075
|
+
* @param {String} languageCode Language
|
|
9076
|
+
* @param {Object} body query
|
|
9077
|
+
* postArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9078
|
+
*/
|
|
9079
|
+
postArchitectGrammarLanguageFilesVoice(grammarId, languageCode, body) {
|
|
9080
|
+
// verify the required parameter 'grammarId' is set
|
|
9081
|
+
if (grammarId === undefined || grammarId === null) {
|
|
9082
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';
|
|
9083
|
+
}
|
|
9084
|
+
// verify the required parameter 'languageCode' is set
|
|
9085
|
+
if (languageCode === undefined || languageCode === null) {
|
|
9086
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';
|
|
9087
|
+
}
|
|
9088
|
+
// verify the required parameter 'body' is set
|
|
9089
|
+
if (body === undefined || body === null) {
|
|
9090
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';
|
|
9091
|
+
}
|
|
9092
|
+
|
|
9093
|
+
return this.apiClient.callApi(
|
|
9094
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
9095
|
+
'POST',
|
|
9096
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
9097
|
+
{ },
|
|
9098
|
+
{ },
|
|
9099
|
+
{ },
|
|
9100
|
+
body,
|
|
9101
|
+
['PureCloud OAuth'],
|
|
9102
|
+
['application/json'],
|
|
9103
|
+
['application/json']
|
|
9104
|
+
);
|
|
9105
|
+
}
|
|
9106
|
+
|
|
9107
|
+
/**
|
|
9108
|
+
* Create a new language for a given grammar
|
|
9109
|
+
*
|
|
9110
|
+
* @param {String} grammarId Grammar ID
|
|
9111
|
+
* @param {Object} body
|
|
9112
|
+
* postArchitectGrammarLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9113
|
+
*/
|
|
9114
|
+
postArchitectGrammarLanguages(grammarId, body) {
|
|
9115
|
+
// verify the required parameter 'grammarId' is set
|
|
9116
|
+
if (grammarId === undefined || grammarId === null) {
|
|
9117
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';
|
|
9118
|
+
}
|
|
9119
|
+
// verify the required parameter 'body' is set
|
|
9120
|
+
if (body === undefined || body === null) {
|
|
9121
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguages';
|
|
9122
|
+
}
|
|
9123
|
+
|
|
9124
|
+
return this.apiClient.callApi(
|
|
9125
|
+
'/api/v2/architect/grammars/{grammarId}/languages',
|
|
9126
|
+
'POST',
|
|
9127
|
+
{ 'grammarId': grammarId },
|
|
9128
|
+
{ },
|
|
9129
|
+
{ },
|
|
9130
|
+
{ },
|
|
9131
|
+
body,
|
|
9132
|
+
['PureCloud OAuth'],
|
|
9133
|
+
['application/json'],
|
|
9134
|
+
['application/json']
|
|
9135
|
+
);
|
|
9136
|
+
}
|
|
9137
|
+
|
|
9138
|
+
/**
|
|
9139
|
+
* Create a new grammar
|
|
9140
|
+
*
|
|
9141
|
+
* @param {Object} body
|
|
9142
|
+
* postArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9143
|
+
*/
|
|
9144
|
+
postArchitectGrammars(body) {
|
|
9145
|
+
// verify the required parameter 'body' is set
|
|
9146
|
+
if (body === undefined || body === null) {
|
|
9147
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammars';
|
|
9148
|
+
}
|
|
9149
|
+
|
|
9150
|
+
return this.apiClient.callApi(
|
|
9151
|
+
'/api/v2/architect/grammars',
|
|
9152
|
+
'POST',
|
|
9153
|
+
{ },
|
|
9154
|
+
{ },
|
|
9155
|
+
{ },
|
|
9156
|
+
{ },
|
|
9157
|
+
body,
|
|
9158
|
+
['PureCloud OAuth'],
|
|
9159
|
+
['application/json'],
|
|
9160
|
+
['application/json']
|
|
9161
|
+
);
|
|
9162
|
+
}
|
|
9163
|
+
|
|
8552
9164
|
/**
|
|
8553
9165
|
* Create IVR config.
|
|
8554
9166
|
*
|
|
@@ -9642,7 +10254,7 @@ class AuditApi {
|
|
|
9642
10254
|
/**
|
|
9643
10255
|
* Audit service.
|
|
9644
10256
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9645
|
-
* @version
|
|
10257
|
+
* @version 175.0.0
|
|
9646
10258
|
*/
|
|
9647
10259
|
|
|
9648
10260
|
/**
|
|
@@ -9813,7 +10425,7 @@ class AuthorizationApi {
|
|
|
9813
10425
|
/**
|
|
9814
10426
|
* Authorization service.
|
|
9815
10427
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9816
|
-
* @version
|
|
10428
|
+
* @version 175.0.0
|
|
9817
10429
|
*/
|
|
9818
10430
|
|
|
9819
10431
|
/**
|
|
@@ -11044,7 +11656,7 @@ class BillingApi {
|
|
|
11044
11656
|
/**
|
|
11045
11657
|
* Billing service.
|
|
11046
11658
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
11047
|
-
* @version
|
|
11659
|
+
* @version 175.0.0
|
|
11048
11660
|
*/
|
|
11049
11661
|
|
|
11050
11662
|
/**
|
|
@@ -11124,7 +11736,7 @@ class CarrierServicesApi {
|
|
|
11124
11736
|
/**
|
|
11125
11737
|
* CarrierServices service.
|
|
11126
11738
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11127
|
-
* @version
|
|
11739
|
+
* @version 175.0.0
|
|
11128
11740
|
*/
|
|
11129
11741
|
|
|
11130
11742
|
/**
|
|
@@ -11194,7 +11806,7 @@ class ChatApi {
|
|
|
11194
11806
|
/**
|
|
11195
11807
|
* Chat service.
|
|
11196
11808
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11197
|
-
* @version
|
|
11809
|
+
* @version 175.0.0
|
|
11198
11810
|
*/
|
|
11199
11811
|
|
|
11200
11812
|
/**
|
|
@@ -11358,7 +11970,7 @@ class CoachingApi {
|
|
|
11358
11970
|
/**
|
|
11359
11971
|
* Coaching service.
|
|
11360
11972
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11361
|
-
* @version
|
|
11973
|
+
* @version 175.0.0
|
|
11362
11974
|
*/
|
|
11363
11975
|
|
|
11364
11976
|
/**
|
|
@@ -11935,7 +12547,7 @@ class ContentManagementApi {
|
|
|
11935
12547
|
/**
|
|
11936
12548
|
* ContentManagement service.
|
|
11937
12549
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11938
|
-
* @version
|
|
12550
|
+
* @version 175.0.0
|
|
11939
12551
|
*/
|
|
11940
12552
|
|
|
11941
12553
|
/**
|
|
@@ -13078,7 +13690,7 @@ class ConversationsApi {
|
|
|
13078
13690
|
/**
|
|
13079
13691
|
* Conversations service.
|
|
13080
13692
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13081
|
-
* @version
|
|
13693
|
+
* @version 175.0.0
|
|
13082
13694
|
*/
|
|
13083
13695
|
|
|
13084
13696
|
/**
|
|
@@ -13243,6 +13855,31 @@ class ConversationsApi {
|
|
|
13243
13855
|
);
|
|
13244
13856
|
}
|
|
13245
13857
|
|
|
13858
|
+
/**
|
|
13859
|
+
* Remove a cached media item asychronously
|
|
13860
|
+
*
|
|
13861
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
13862
|
+
*/
|
|
13863
|
+
deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
13864
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
13865
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
13866
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';
|
|
13867
|
+
}
|
|
13868
|
+
|
|
13869
|
+
return this.apiClient.callApi(
|
|
13870
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
13871
|
+
'DELETE',
|
|
13872
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
13873
|
+
{ },
|
|
13874
|
+
{ },
|
|
13875
|
+
{ },
|
|
13876
|
+
null,
|
|
13877
|
+
['PureCloud OAuth'],
|
|
13878
|
+
['application/json'],
|
|
13879
|
+
['application/json']
|
|
13880
|
+
);
|
|
13881
|
+
}
|
|
13882
|
+
|
|
13246
13883
|
/**
|
|
13247
13884
|
* Delete a Facebook messaging integration
|
|
13248
13885
|
*
|
|
@@ -15044,7 +15681,7 @@ class ConversationsApi {
|
|
|
15044
15681
|
/**
|
|
15045
15682
|
* Get list of wrapup codes for this conversation participant
|
|
15046
15683
|
*
|
|
15047
|
-
* @param {String} conversationId
|
|
15684
|
+
* @param {String} conversationId conversationId
|
|
15048
15685
|
* @param {String} participantId participantId
|
|
15049
15686
|
*/
|
|
15050
15687
|
getConversationsMessageParticipantWrapupcodes(conversationId, participantId) {
|
|
@@ -15091,6 +15728,57 @@ class ConversationsApi {
|
|
|
15091
15728
|
);
|
|
15092
15729
|
}
|
|
15093
15730
|
|
|
15731
|
+
/**
|
|
15732
|
+
* Get a list of cached media items
|
|
15733
|
+
*
|
|
15734
|
+
* @param {Object} opts Optional parameters
|
|
15735
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
15736
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15737
|
+
* @param {String} opts.url URL to search for
|
|
15738
|
+
*/
|
|
15739
|
+
getConversationsMessagesCachedmedia(opts) {
|
|
15740
|
+
opts = opts || {};
|
|
15741
|
+
|
|
15742
|
+
|
|
15743
|
+
return this.apiClient.callApi(
|
|
15744
|
+
'/api/v2/conversations/messages/cachedmedia',
|
|
15745
|
+
'GET',
|
|
15746
|
+
{ },
|
|
15747
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'url': opts['url'] },
|
|
15748
|
+
{ },
|
|
15749
|
+
{ },
|
|
15750
|
+
null,
|
|
15751
|
+
['PureCloud OAuth'],
|
|
15752
|
+
['application/json'],
|
|
15753
|
+
['application/json']
|
|
15754
|
+
);
|
|
15755
|
+
}
|
|
15756
|
+
|
|
15757
|
+
/**
|
|
15758
|
+
* Get a cached media item
|
|
15759
|
+
*
|
|
15760
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
15761
|
+
*/
|
|
15762
|
+
getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
15763
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
15764
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
15765
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';
|
|
15766
|
+
}
|
|
15767
|
+
|
|
15768
|
+
return this.apiClient.callApi(
|
|
15769
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
15770
|
+
'GET',
|
|
15771
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
15772
|
+
{ },
|
|
15773
|
+
{ },
|
|
15774
|
+
{ },
|
|
15775
|
+
null,
|
|
15776
|
+
['PureCloud OAuth'],
|
|
15777
|
+
['application/json'],
|
|
15778
|
+
['application/json']
|
|
15779
|
+
);
|
|
15780
|
+
}
|
|
15781
|
+
|
|
15094
15782
|
/**
|
|
15095
15783
|
* Get Genesys Facebook App Id
|
|
15096
15784
|
*
|
|
@@ -15834,6 +16522,32 @@ class ConversationsApi {
|
|
|
15834
16522
|
);
|
|
15835
16523
|
}
|
|
15836
16524
|
|
|
16525
|
+
/**
|
|
16526
|
+
* Gets a record for a given meetingId
|
|
16527
|
+
*
|
|
16528
|
+
* @param {String} meetingId meetingId
|
|
16529
|
+
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16530
|
+
*/
|
|
16531
|
+
getConversationsVideosMeeting(meetingId) {
|
|
16532
|
+
// verify the required parameter 'meetingId' is set
|
|
16533
|
+
if (meetingId === undefined || meetingId === null) {
|
|
16534
|
+
throw 'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';
|
|
16535
|
+
}
|
|
16536
|
+
|
|
16537
|
+
return this.apiClient.callApi(
|
|
16538
|
+
'/api/v2/conversations/videos/meetings/{meetingId}',
|
|
16539
|
+
'GET',
|
|
16540
|
+
{ 'meetingId': meetingId },
|
|
16541
|
+
{ },
|
|
16542
|
+
{ },
|
|
16543
|
+
{ },
|
|
16544
|
+
null,
|
|
16545
|
+
['PureCloud OAuth'],
|
|
16546
|
+
['application/json'],
|
|
16547
|
+
['application/json']
|
|
16548
|
+
);
|
|
16549
|
+
}
|
|
16550
|
+
|
|
15837
16551
|
/**
|
|
15838
16552
|
* Update a participant.
|
|
15839
16553
|
* Update conversation participant.
|
|
@@ -16796,7 +17510,7 @@ class ConversationsApi {
|
|
|
16796
17510
|
/**
|
|
16797
17511
|
* Update conversation participant
|
|
16798
17512
|
*
|
|
16799
|
-
* @param {String} conversationId
|
|
17513
|
+
* @param {String} conversationId conversationId
|
|
16800
17514
|
* @param {String} participantId participantId
|
|
16801
17515
|
* @param {Object} opts Optional parameters
|
|
16802
17516
|
* @param {Object} opts.body
|
|
@@ -16830,7 +17544,7 @@ class ConversationsApi {
|
|
|
16830
17544
|
/**
|
|
16831
17545
|
* Update the attributes on a conversation participant.
|
|
16832
17546
|
*
|
|
16833
|
-
* @param {String} conversationId
|
|
17547
|
+
* @param {String} conversationId conversationId
|
|
16834
17548
|
* @param {String} participantId participantId
|
|
16835
17549
|
* @param {Object} opts Optional parameters
|
|
16836
17550
|
* @param {Object} opts.body
|
|
@@ -16864,7 +17578,7 @@ class ConversationsApi {
|
|
|
16864
17578
|
/**
|
|
16865
17579
|
* Update conversation participant's communication by disconnecting it.
|
|
16866
17580
|
*
|
|
16867
|
-
* @param {String} conversationId
|
|
17581
|
+
* @param {String} conversationId conversationId
|
|
16868
17582
|
* @param {String} participantId participantId
|
|
16869
17583
|
* @param {String} communicationId communicationId
|
|
16870
17584
|
* @param {Object} body Participant
|
|
@@ -18821,6 +19535,96 @@ class ConversationsApi {
|
|
|
18821
19535
|
);
|
|
18822
19536
|
}
|
|
18823
19537
|
|
|
19538
|
+
/**
|
|
19539
|
+
* Send an inbound Open Event Message
|
|
19540
|
+
* Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
19541
|
+
* @param {String} integrationId integrationId
|
|
19542
|
+
* @param {Object} body NormalizedMessage
|
|
19543
|
+
*/
|
|
19544
|
+
postConversationsMessageInboundOpenEvent(integrationId, body) {
|
|
19545
|
+
// verify the required parameter 'integrationId' is set
|
|
19546
|
+
if (integrationId === undefined || integrationId === null) {
|
|
19547
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';
|
|
19548
|
+
}
|
|
19549
|
+
// verify the required parameter 'body' is set
|
|
19550
|
+
if (body === undefined || body === null) {
|
|
19551
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';
|
|
19552
|
+
}
|
|
19553
|
+
|
|
19554
|
+
return this.apiClient.callApi(
|
|
19555
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/event',
|
|
19556
|
+
'POST',
|
|
19557
|
+
{ 'integrationId': integrationId },
|
|
19558
|
+
{ },
|
|
19559
|
+
{ },
|
|
19560
|
+
{ },
|
|
19561
|
+
body,
|
|
19562
|
+
['PureCloud OAuth'],
|
|
19563
|
+
['application/json'],
|
|
19564
|
+
['application/json']
|
|
19565
|
+
);
|
|
19566
|
+
}
|
|
19567
|
+
|
|
19568
|
+
/**
|
|
19569
|
+
* Send inbound Open Message
|
|
19570
|
+
* Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
19571
|
+
* @param {String} integrationId integrationId
|
|
19572
|
+
* @param {Object} body NormalizedMessage
|
|
19573
|
+
*/
|
|
19574
|
+
postConversationsMessageInboundOpenMessage(integrationId, body) {
|
|
19575
|
+
// verify the required parameter 'integrationId' is set
|
|
19576
|
+
if (integrationId === undefined || integrationId === null) {
|
|
19577
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
|
|
19578
|
+
}
|
|
19579
|
+
// verify the required parameter 'body' is set
|
|
19580
|
+
if (body === undefined || body === null) {
|
|
19581
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';
|
|
19582
|
+
}
|
|
19583
|
+
|
|
19584
|
+
return this.apiClient.callApi(
|
|
19585
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/message',
|
|
19586
|
+
'POST',
|
|
19587
|
+
{ 'integrationId': integrationId },
|
|
19588
|
+
{ },
|
|
19589
|
+
{ },
|
|
19590
|
+
{ },
|
|
19591
|
+
body,
|
|
19592
|
+
['PureCloud OAuth'],
|
|
19593
|
+
['application/json'],
|
|
19594
|
+
['application/json']
|
|
19595
|
+
);
|
|
19596
|
+
}
|
|
19597
|
+
|
|
19598
|
+
/**
|
|
19599
|
+
* Send an inbound Open Receipt Message
|
|
19600
|
+
* Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
19601
|
+
* @param {String} integrationId integrationId
|
|
19602
|
+
* @param {Object} body NormalizedMessage
|
|
19603
|
+
*/
|
|
19604
|
+
postConversationsMessageInboundOpenReceipt(integrationId, body) {
|
|
19605
|
+
// verify the required parameter 'integrationId' is set
|
|
19606
|
+
if (integrationId === undefined || integrationId === null) {
|
|
19607
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';
|
|
19608
|
+
}
|
|
19609
|
+
// verify the required parameter 'body' is set
|
|
19610
|
+
if (body === undefined || body === null) {
|
|
19611
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';
|
|
19612
|
+
}
|
|
19613
|
+
|
|
19614
|
+
return this.apiClient.callApi(
|
|
19615
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/receipt',
|
|
19616
|
+
'POST',
|
|
19617
|
+
{ 'integrationId': integrationId },
|
|
19618
|
+
{ },
|
|
19619
|
+
{ },
|
|
19620
|
+
{ },
|
|
19621
|
+
body,
|
|
19622
|
+
['PureCloud OAuth'],
|
|
19623
|
+
['application/json'],
|
|
19624
|
+
['application/json']
|
|
19625
|
+
);
|
|
19626
|
+
}
|
|
19627
|
+
|
|
18824
19628
|
/**
|
|
18825
19629
|
* Get messages in batch
|
|
18826
19630
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
@@ -19304,24 +20108,63 @@ class ConversationsApi {
|
|
|
19304
20108
|
* @param {Object} opts Optional parameters
|
|
19305
20109
|
* @param {Object} opts.body Wrap-up
|
|
19306
20110
|
*/
|
|
19307
|
-
postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
20111
|
+
postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
20112
|
+
opts = opts || {};
|
|
20113
|
+
|
|
20114
|
+
// verify the required parameter 'conversationId' is set
|
|
20115
|
+
if (conversationId === undefined || conversationId === null) {
|
|
20116
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
20117
|
+
}
|
|
20118
|
+
// verify the required parameter 'participantId' is set
|
|
20119
|
+
if (participantId === undefined || participantId === null) {
|
|
20120
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
20121
|
+
}
|
|
20122
|
+
// verify the required parameter 'communicationId' is set
|
|
20123
|
+
if (communicationId === undefined || communicationId === null) {
|
|
20124
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
20125
|
+
}
|
|
20126
|
+
|
|
20127
|
+
return this.apiClient.callApi(
|
|
20128
|
+
'/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup',
|
|
20129
|
+
'POST',
|
|
20130
|
+
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
20131
|
+
{ },
|
|
20132
|
+
{ },
|
|
20133
|
+
{ },
|
|
20134
|
+
opts['body'],
|
|
20135
|
+
['PureCloud OAuth'],
|
|
20136
|
+
['application/json'],
|
|
20137
|
+
['application/json']
|
|
20138
|
+
);
|
|
20139
|
+
}
|
|
20140
|
+
|
|
20141
|
+
/**
|
|
20142
|
+
* Apply wrap-up for this conversation communication
|
|
20143
|
+
*
|
|
20144
|
+
* @param {String} conversationId conversationId
|
|
20145
|
+
* @param {String} participantId participantId
|
|
20146
|
+
* @param {String} communicationId communicationId
|
|
20147
|
+
* @param {Object} opts Optional parameters
|
|
20148
|
+
* @param {Object} opts.body Wrap-up
|
|
20149
|
+
*/
|
|
20150
|
+
postConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
19308
20151
|
opts = opts || {};
|
|
19309
20152
|
|
|
19310
20153
|
// verify the required parameter 'conversationId' is set
|
|
19311
20154
|
if (conversationId === undefined || conversationId === null) {
|
|
19312
|
-
throw 'Missing the required parameter "conversationId" when calling
|
|
20155
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
19313
20156
|
}
|
|
19314
20157
|
// verify the required parameter 'participantId' is set
|
|
19315
20158
|
if (participantId === undefined || participantId === null) {
|
|
19316
|
-
throw 'Missing the required parameter "participantId" when calling
|
|
20159
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
19317
20160
|
}
|
|
19318
20161
|
// verify the required parameter 'communicationId' is set
|
|
19319
20162
|
if (communicationId === undefined || communicationId === null) {
|
|
19320
|
-
throw 'Missing the required parameter "communicationId" when calling
|
|
20163
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
19321
20164
|
}
|
|
19322
20165
|
|
|
19323
20166
|
return this.apiClient.callApi(
|
|
19324
|
-
'/api/v2/conversations/
|
|
20167
|
+
'/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup',
|
|
19325
20168
|
'POST',
|
|
19326
20169
|
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
19327
20170
|
{ },
|
|
@@ -19335,38 +20178,25 @@ class ConversationsApi {
|
|
|
19335
20178
|
}
|
|
19336
20179
|
|
|
19337
20180
|
/**
|
|
19338
|
-
*
|
|
20181
|
+
* Generate a meetingId for a given conferenceId
|
|
19339
20182
|
*
|
|
19340
|
-
* @param {
|
|
19341
|
-
*
|
|
19342
|
-
* @param {String} communicationId communicationId
|
|
19343
|
-
* @param {Object} opts Optional parameters
|
|
19344
|
-
* @param {Object} opts.body Wrap-up
|
|
20183
|
+
* @param {Object} body MeetingIdRequest
|
|
20184
|
+
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19345
20185
|
*/
|
|
19346
|
-
|
|
19347
|
-
|
|
19348
|
-
|
|
19349
|
-
|
|
19350
|
-
if (conversationId === undefined || conversationId === null) {
|
|
19351
|
-
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
19352
|
-
}
|
|
19353
|
-
// verify the required parameter 'participantId' is set
|
|
19354
|
-
if (participantId === undefined || participantId === null) {
|
|
19355
|
-
throw 'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
19356
|
-
}
|
|
19357
|
-
// verify the required parameter 'communicationId' is set
|
|
19358
|
-
if (communicationId === undefined || communicationId === null) {
|
|
19359
|
-
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
20186
|
+
postConversationsVideosMeetings(body) {
|
|
20187
|
+
// verify the required parameter 'body' is set
|
|
20188
|
+
if (body === undefined || body === null) {
|
|
20189
|
+
throw 'Missing the required parameter "body" when calling postConversationsVideosMeetings';
|
|
19360
20190
|
}
|
|
19361
20191
|
|
|
19362
20192
|
return this.apiClient.callApi(
|
|
19363
|
-
'/api/v2/conversations/videos/
|
|
20193
|
+
'/api/v2/conversations/videos/meetings',
|
|
19364
20194
|
'POST',
|
|
19365
|
-
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
19366
20195
|
{ },
|
|
19367
20196
|
{ },
|
|
19368
20197
|
{ },
|
|
19369
|
-
|
|
20198
|
+
{ },
|
|
20199
|
+
body,
|
|
19370
20200
|
['PureCloud OAuth'],
|
|
19371
20201
|
['application/json'],
|
|
19372
20202
|
['application/json']
|
|
@@ -19944,7 +20774,7 @@ class DataExtensionsApi {
|
|
|
19944
20774
|
/**
|
|
19945
20775
|
* DataExtensions service.
|
|
19946
20776
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19947
|
-
* @version
|
|
20777
|
+
* @version 175.0.0
|
|
19948
20778
|
*/
|
|
19949
20779
|
|
|
19950
20780
|
/**
|
|
@@ -20030,7 +20860,7 @@ class DownloadsApi {
|
|
|
20030
20860
|
/**
|
|
20031
20861
|
* Downloads service.
|
|
20032
20862
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20033
|
-
* @version
|
|
20863
|
+
* @version 175.0.0
|
|
20034
20864
|
*/
|
|
20035
20865
|
|
|
20036
20866
|
/**
|
|
@@ -20082,7 +20912,7 @@ class EmailsApi {
|
|
|
20082
20912
|
/**
|
|
20083
20913
|
* Emails service.
|
|
20084
20914
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20085
|
-
* @version
|
|
20915
|
+
* @version 175.0.0
|
|
20086
20916
|
*/
|
|
20087
20917
|
|
|
20088
20918
|
/**
|
|
@@ -20147,7 +20977,7 @@ class EventsApi {
|
|
|
20147
20977
|
/**
|
|
20148
20978
|
* Events service.
|
|
20149
20979
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20150
|
-
* @version
|
|
20980
|
+
* @version 175.0.0
|
|
20151
20981
|
*/
|
|
20152
20982
|
|
|
20153
20983
|
/**
|
|
@@ -20243,7 +21073,7 @@ class ExternalContactsApi {
|
|
|
20243
21073
|
/**
|
|
20244
21074
|
* ExternalContacts service.
|
|
20245
21075
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20246
|
-
* @version
|
|
21076
|
+
* @version 175.0.0
|
|
20247
21077
|
*/
|
|
20248
21078
|
|
|
20249
21079
|
/**
|
|
@@ -22201,7 +23031,7 @@ class FaxApi {
|
|
|
22201
23031
|
/**
|
|
22202
23032
|
* Fax service.
|
|
22203
23033
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22204
|
-
* @version
|
|
23034
|
+
* @version 175.0.0
|
|
22205
23035
|
*/
|
|
22206
23036
|
|
|
22207
23037
|
/**
|
|
@@ -22372,7 +23202,7 @@ class FlowsApi {
|
|
|
22372
23202
|
/**
|
|
22373
23203
|
* Flows service.
|
|
22374
23204
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22375
|
-
* @version
|
|
23205
|
+
* @version 175.0.0
|
|
22376
23206
|
*/
|
|
22377
23207
|
|
|
22378
23208
|
/**
|
|
@@ -22556,7 +23386,7 @@ class GamificationApi {
|
|
|
22556
23386
|
/**
|
|
22557
23387
|
* Gamification service.
|
|
22558
23388
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22559
|
-
* @version
|
|
23389
|
+
* @version 175.0.0
|
|
22560
23390
|
*/
|
|
22561
23391
|
|
|
22562
23392
|
/**
|
|
@@ -24642,7 +25472,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
24642
25472
|
/**
|
|
24643
25473
|
* GeneralDataProtectionRegulation service.
|
|
24644
25474
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24645
|
-
* @version
|
|
25475
|
+
* @version 175.0.0
|
|
24646
25476
|
*/
|
|
24647
25477
|
|
|
24648
25478
|
/**
|
|
@@ -24772,7 +25602,7 @@ class GeolocationApi {
|
|
|
24772
25602
|
/**
|
|
24773
25603
|
* Geolocation service.
|
|
24774
25604
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24775
|
-
* @version
|
|
25605
|
+
* @version 175.0.0
|
|
24776
25606
|
*/
|
|
24777
25607
|
|
|
24778
25608
|
/**
|
|
@@ -24903,7 +25733,7 @@ class GreetingsApi {
|
|
|
24903
25733
|
/**
|
|
24904
25734
|
* Greetings service.
|
|
24905
25735
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24906
|
-
* @version
|
|
25736
|
+
* @version 175.0.0
|
|
24907
25737
|
*/
|
|
24908
25738
|
|
|
24909
25739
|
/**
|
|
@@ -25358,7 +26188,7 @@ class GroupsApi {
|
|
|
25358
26188
|
/**
|
|
25359
26189
|
* Groups service.
|
|
25360
26190
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25361
|
-
* @version
|
|
26191
|
+
* @version 175.0.0
|
|
25362
26192
|
*/
|
|
25363
26193
|
|
|
25364
26194
|
/**
|
|
@@ -25877,7 +26707,7 @@ class IdentityProviderApi {
|
|
|
25877
26707
|
/**
|
|
25878
26708
|
* IdentityProvider service.
|
|
25879
26709
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25880
|
-
* @version
|
|
26710
|
+
* @version 175.0.0
|
|
25881
26711
|
*/
|
|
25882
26712
|
|
|
25883
26713
|
/**
|
|
@@ -26633,7 +27463,7 @@ class InfrastructureAsCodeApi {
|
|
|
26633
27463
|
/**
|
|
26634
27464
|
* InfrastructureAsCode service.
|
|
26635
27465
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26636
|
-
* @version
|
|
27466
|
+
* @version 175.0.0
|
|
26637
27467
|
*/
|
|
26638
27468
|
|
|
26639
27469
|
/**
|
|
@@ -26800,7 +27630,7 @@ class IntegrationsApi {
|
|
|
26800
27630
|
/**
|
|
26801
27631
|
* Integrations service.
|
|
26802
27632
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26803
|
-
* @version
|
|
27633
|
+
* @version 175.0.0
|
|
26804
27634
|
*/
|
|
26805
27635
|
|
|
26806
27636
|
/**
|
|
@@ -28762,7 +29592,7 @@ class JourneyApi {
|
|
|
28762
29592
|
/**
|
|
28763
29593
|
* Journey service.
|
|
28764
29594
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28765
|
-
* @version
|
|
29595
|
+
* @version 175.0.0
|
|
28766
29596
|
*/
|
|
28767
29597
|
|
|
28768
29598
|
/**
|
|
@@ -28962,6 +29792,37 @@ class JourneyApi {
|
|
|
28962
29792
|
);
|
|
28963
29793
|
}
|
|
28964
29794
|
|
|
29795
|
+
/**
|
|
29796
|
+
* Retrieve all sessions for a given external contact.
|
|
29797
|
+
*
|
|
29798
|
+
* @param {String} contactId ExternalContact ID
|
|
29799
|
+
* @param {Object} opts Optional parameters
|
|
29800
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
29801
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
29802
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
29803
|
+
*/
|
|
29804
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
29805
|
+
opts = opts || {};
|
|
29806
|
+
|
|
29807
|
+
// verify the required parameter 'contactId' is set
|
|
29808
|
+
if (contactId === undefined || contactId === null) {
|
|
29809
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
29810
|
+
}
|
|
29811
|
+
|
|
29812
|
+
return this.apiClient.callApi(
|
|
29813
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
29814
|
+
'GET',
|
|
29815
|
+
{ 'contactId': contactId },
|
|
29816
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
29817
|
+
{ },
|
|
29818
|
+
{ },
|
|
29819
|
+
null,
|
|
29820
|
+
['PureCloud OAuth'],
|
|
29821
|
+
['application/json'],
|
|
29822
|
+
['application/json']
|
|
29823
|
+
);
|
|
29824
|
+
}
|
|
29825
|
+
|
|
28965
29826
|
/**
|
|
28966
29827
|
* Retrieve a single action map.
|
|
28967
29828
|
*
|
|
@@ -29762,6 +30623,36 @@ class JourneyApi {
|
|
|
29762
30623
|
);
|
|
29763
30624
|
}
|
|
29764
30625
|
|
|
30626
|
+
/**
|
|
30627
|
+
* Send a journey app event, used for tracking customer activity on an application.
|
|
30628
|
+
*
|
|
30629
|
+
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
30630
|
+
* @param {Object} opts Optional parameters
|
|
30631
|
+
* @param {Object} opts.body
|
|
30632
|
+
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30633
|
+
*/
|
|
30634
|
+
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
30635
|
+
opts = opts || {};
|
|
30636
|
+
|
|
30637
|
+
// verify the required parameter 'deploymentId' is set
|
|
30638
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
30639
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';
|
|
30640
|
+
}
|
|
30641
|
+
|
|
30642
|
+
return this.apiClient.callApi(
|
|
30643
|
+
'/api/v2/journey/deployments/{deploymentId}/appevents',
|
|
30644
|
+
'POST',
|
|
30645
|
+
{ 'deploymentId': deploymentId },
|
|
30646
|
+
{ },
|
|
30647
|
+
{ },
|
|
30648
|
+
{ },
|
|
30649
|
+
opts['body'],
|
|
30650
|
+
['PureCloud OAuth'],
|
|
30651
|
+
['application/json'],
|
|
30652
|
+
['application/json']
|
|
30653
|
+
);
|
|
30654
|
+
}
|
|
30655
|
+
|
|
29765
30656
|
/**
|
|
29766
30657
|
* Create an outcome.
|
|
29767
30658
|
*
|
|
@@ -29865,7 +30756,7 @@ class KnowledgeApi {
|
|
|
29865
30756
|
/**
|
|
29866
30757
|
* Knowledge service.
|
|
29867
30758
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29868
|
-
* @version
|
|
30759
|
+
* @version 175.0.0
|
|
29869
30760
|
*/
|
|
29870
30761
|
|
|
29871
30762
|
/**
|
|
@@ -30422,6 +31313,85 @@ class KnowledgeApi {
|
|
|
30422
31313
|
);
|
|
30423
31314
|
}
|
|
30424
31315
|
|
|
31316
|
+
/**
|
|
31317
|
+
* Get a list of feedback records given on a document
|
|
31318
|
+
*
|
|
31319
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31320
|
+
* @param {String} documentId Document ID.
|
|
31321
|
+
* @param {Object} opts Optional parameters
|
|
31322
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
31323
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
31324
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
31325
|
+
* @param {Boolean} opts.onlyCommented If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.
|
|
31326
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
31327
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
31328
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
31329
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
31330
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
31331
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
31332
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
31333
|
+
*/
|
|
31334
|
+
getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
31335
|
+
opts = opts || {};
|
|
31336
|
+
|
|
31337
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31338
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31339
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
31340
|
+
}
|
|
31341
|
+
// verify the required parameter 'documentId' is set
|
|
31342
|
+
if (documentId === undefined || documentId === null) {
|
|
31343
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
31344
|
+
}
|
|
31345
|
+
|
|
31346
|
+
return this.apiClient.callApi(
|
|
31347
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
31348
|
+
'GET',
|
|
31349
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31350
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'onlyCommented': opts['onlyCommented'],'documentVersionId': opts['documentVersionId'],'documentVariationId': opts['documentVariationId'],'appType': opts['appType'],'queryType': opts['queryType'],'userId': opts['userId'],'queueId': opts['queueId'],'state': opts['state'] },
|
|
31351
|
+
{ },
|
|
31352
|
+
{ },
|
|
31353
|
+
null,
|
|
31354
|
+
['PureCloud OAuth'],
|
|
31355
|
+
['application/json'],
|
|
31356
|
+
['application/json']
|
|
31357
|
+
);
|
|
31358
|
+
}
|
|
31359
|
+
|
|
31360
|
+
/**
|
|
31361
|
+
* Get a single feedback record given on a document
|
|
31362
|
+
*
|
|
31363
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31364
|
+
* @param {String} documentId Document ID.
|
|
31365
|
+
* @param {String} feedbackId Feedback ID.
|
|
31366
|
+
*/
|
|
31367
|
+
getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId) {
|
|
31368
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31369
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31370
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
31371
|
+
}
|
|
31372
|
+
// verify the required parameter 'documentId' is set
|
|
31373
|
+
if (documentId === undefined || documentId === null) {
|
|
31374
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
31375
|
+
}
|
|
31376
|
+
// verify the required parameter 'feedbackId' is set
|
|
31377
|
+
if (feedbackId === undefined || feedbackId === null) {
|
|
31378
|
+
throw 'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
31379
|
+
}
|
|
31380
|
+
|
|
31381
|
+
return this.apiClient.callApi(
|
|
31382
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
|
|
31383
|
+
'GET',
|
|
31384
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
|
|
31385
|
+
{ },
|
|
31386
|
+
{ },
|
|
31387
|
+
{ },
|
|
31388
|
+
null,
|
|
31389
|
+
['PureCloud OAuth'],
|
|
31390
|
+
['application/json'],
|
|
31391
|
+
['application/json']
|
|
31392
|
+
);
|
|
31393
|
+
}
|
|
31394
|
+
|
|
30425
31395
|
/**
|
|
30426
31396
|
* Get a variation for a document.
|
|
30427
31397
|
*
|
|
@@ -30729,8 +31699,12 @@ class KnowledgeApi {
|
|
|
30729
31699
|
*
|
|
30730
31700
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
30731
31701
|
* @param {String} importJobId Import job ID
|
|
31702
|
+
* @param {Object} opts Optional parameters
|
|
31703
|
+
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
30732
31704
|
*/
|
|
30733
|
-
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
31705
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, opts) {
|
|
31706
|
+
opts = opts || {};
|
|
31707
|
+
|
|
30734
31708
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
30735
31709
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
30736
31710
|
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
@@ -30744,7 +31718,7 @@ class KnowledgeApi {
|
|
|
30744
31718
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
30745
31719
|
'GET',
|
|
30746
31720
|
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
30747
|
-
{
|
|
31721
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
30748
31722
|
{ },
|
|
30749
31723
|
{ },
|
|
30750
31724
|
null,
|
|
@@ -31767,6 +32741,40 @@ class KnowledgeApi {
|
|
|
31767
32741
|
);
|
|
31768
32742
|
}
|
|
31769
32743
|
|
|
32744
|
+
/**
|
|
32745
|
+
* Give feedback on a document
|
|
32746
|
+
*
|
|
32747
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
32748
|
+
* @param {String} documentId Document ID.
|
|
32749
|
+
* @param {Object} opts Optional parameters
|
|
32750
|
+
* @param {Object} opts.body
|
|
32751
|
+
*/
|
|
32752
|
+
postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, opts) {
|
|
32753
|
+
opts = opts || {};
|
|
32754
|
+
|
|
32755
|
+
// verify the required parameter 'sessionId' is set
|
|
32756
|
+
if (sessionId === undefined || sessionId === null) {
|
|
32757
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
32758
|
+
}
|
|
32759
|
+
// verify the required parameter 'documentId' is set
|
|
32760
|
+
if (documentId === undefined || documentId === null) {
|
|
32761
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
32762
|
+
}
|
|
32763
|
+
|
|
32764
|
+
return this.apiClient.callApi(
|
|
32765
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback',
|
|
32766
|
+
'POST',
|
|
32767
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
32768
|
+
{ },
|
|
32769
|
+
{ },
|
|
32770
|
+
{ },
|
|
32771
|
+
opts['body'],
|
|
32772
|
+
['PureCloud OAuth'],
|
|
32773
|
+
['application/json'],
|
|
32774
|
+
['application/json']
|
|
32775
|
+
);
|
|
32776
|
+
}
|
|
32777
|
+
|
|
31770
32778
|
/**
|
|
31771
32779
|
* Search the documents in a guest session.
|
|
31772
32780
|
*
|
|
@@ -31881,6 +32889,40 @@ class KnowledgeApi {
|
|
|
31881
32889
|
);
|
|
31882
32890
|
}
|
|
31883
32891
|
|
|
32892
|
+
/**
|
|
32893
|
+
* Give feedback on a document
|
|
32894
|
+
*
|
|
32895
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
32896
|
+
* @param {String} documentId Document ID.
|
|
32897
|
+
* @param {Object} opts Optional parameters
|
|
32898
|
+
* @param {Object} opts.body
|
|
32899
|
+
*/
|
|
32900
|
+
postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
32901
|
+
opts = opts || {};
|
|
32902
|
+
|
|
32903
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32904
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
32905
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
32906
|
+
}
|
|
32907
|
+
// verify the required parameter 'documentId' is set
|
|
32908
|
+
if (documentId === undefined || documentId === null) {
|
|
32909
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
32910
|
+
}
|
|
32911
|
+
|
|
32912
|
+
return this.apiClient.callApi(
|
|
32913
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
32914
|
+
'POST',
|
|
32915
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
32916
|
+
{ },
|
|
32917
|
+
{ },
|
|
32918
|
+
{ },
|
|
32919
|
+
opts['body'],
|
|
32920
|
+
['PureCloud OAuth'],
|
|
32921
|
+
['application/json'],
|
|
32922
|
+
['application/json']
|
|
32923
|
+
);
|
|
32924
|
+
}
|
|
32925
|
+
|
|
31884
32926
|
/**
|
|
31885
32927
|
* Create a variation for a document.
|
|
31886
32928
|
*
|
|
@@ -31951,6 +32993,40 @@ class KnowledgeApi {
|
|
|
31951
32993
|
);
|
|
31952
32994
|
}
|
|
31953
32995
|
|
|
32996
|
+
/**
|
|
32997
|
+
* Create view for a document.
|
|
32998
|
+
*
|
|
32999
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
33000
|
+
* @param {String} documentId Document ID.
|
|
33001
|
+
* @param {Object} opts Optional parameters
|
|
33002
|
+
* @param {Object} opts.body
|
|
33003
|
+
*/
|
|
33004
|
+
postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, opts) {
|
|
33005
|
+
opts = opts || {};
|
|
33006
|
+
|
|
33007
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
33008
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33009
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
33010
|
+
}
|
|
33011
|
+
// verify the required parameter 'documentId' is set
|
|
33012
|
+
if (documentId === undefined || documentId === null) {
|
|
33013
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
33014
|
+
}
|
|
33015
|
+
|
|
33016
|
+
return this.apiClient.callApi(
|
|
33017
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views',
|
|
33018
|
+
'POST',
|
|
33019
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
33020
|
+
{ },
|
|
33021
|
+
{ },
|
|
33022
|
+
{ },
|
|
33023
|
+
opts['body'],
|
|
33024
|
+
['PureCloud OAuth'],
|
|
33025
|
+
['application/json'],
|
|
33026
|
+
['application/json']
|
|
33027
|
+
);
|
|
33028
|
+
}
|
|
33029
|
+
|
|
31954
33030
|
/**
|
|
31955
33031
|
* Create document.
|
|
31956
33032
|
*
|
|
@@ -32501,7 +33577,7 @@ class LanguageUnderstandingApi {
|
|
|
32501
33577
|
/**
|
|
32502
33578
|
* LanguageUnderstanding service.
|
|
32503
33579
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32504
|
-
* @version
|
|
33580
|
+
* @version 175.0.0
|
|
32505
33581
|
*/
|
|
32506
33582
|
|
|
32507
33583
|
/**
|
|
@@ -33514,7 +34590,7 @@ class LanguagesApi {
|
|
|
33514
34590
|
/**
|
|
33515
34591
|
* Languages service.
|
|
33516
34592
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33517
|
-
* @version
|
|
34593
|
+
* @version 175.0.0
|
|
33518
34594
|
*/
|
|
33519
34595
|
|
|
33520
34596
|
/**
|
|
@@ -33736,7 +34812,7 @@ class LearningApi {
|
|
|
33736
34812
|
/**
|
|
33737
34813
|
* Learning service.
|
|
33738
34814
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33739
|
-
* @version
|
|
34815
|
+
* @version 175.0.0
|
|
33740
34816
|
*/
|
|
33741
34817
|
|
|
33742
34818
|
/**
|
|
@@ -34379,8 +35455,12 @@ class LearningApi {
|
|
|
34379
35455
|
* Publish a Learning module
|
|
34380
35456
|
*
|
|
34381
35457
|
* @param {String} moduleId The ID of the learning module
|
|
35458
|
+
* @param {Object} opts Optional parameters
|
|
35459
|
+
* @param {Object} opts.body The request body
|
|
34382
35460
|
*/
|
|
34383
|
-
postLearningModulePublish(moduleId) {
|
|
35461
|
+
postLearningModulePublish(moduleId, opts) {
|
|
35462
|
+
opts = opts || {};
|
|
35463
|
+
|
|
34384
35464
|
// verify the required parameter 'moduleId' is set
|
|
34385
35465
|
if (moduleId === undefined || moduleId === null) {
|
|
34386
35466
|
throw 'Missing the required parameter "moduleId" when calling postLearningModulePublish';
|
|
@@ -34393,7 +35473,7 @@ class LearningApi {
|
|
|
34393
35473
|
{ },
|
|
34394
35474
|
{ },
|
|
34395
35475
|
{ },
|
|
34396
|
-
|
|
35476
|
+
opts['body'],
|
|
34397
35477
|
['PureCloud OAuth'],
|
|
34398
35478
|
['application/json'],
|
|
34399
35479
|
['application/json']
|
|
@@ -34551,7 +35631,7 @@ class LicenseApi {
|
|
|
34551
35631
|
/**
|
|
34552
35632
|
* License service.
|
|
34553
35633
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34554
|
-
* @version
|
|
35634
|
+
* @version 175.0.0
|
|
34555
35635
|
*/
|
|
34556
35636
|
|
|
34557
35637
|
/**
|
|
@@ -34789,7 +35869,7 @@ class LocationsApi {
|
|
|
34789
35869
|
/**
|
|
34790
35870
|
* Locations service.
|
|
34791
35871
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34792
|
-
* @version
|
|
35872
|
+
* @version 175.0.0
|
|
34793
35873
|
*/
|
|
34794
35874
|
|
|
34795
35875
|
/**
|
|
@@ -35025,7 +36105,7 @@ class MessagingApi {
|
|
|
35025
36105
|
/**
|
|
35026
36106
|
* Messaging service.
|
|
35027
36107
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
35028
|
-
* @version
|
|
36108
|
+
* @version 175.0.0
|
|
35029
36109
|
*/
|
|
35030
36110
|
|
|
35031
36111
|
/**
|
|
@@ -35384,7 +36464,7 @@ class MobileDevicesApi {
|
|
|
35384
36464
|
/**
|
|
35385
36465
|
* MobileDevices service.
|
|
35386
36466
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35387
|
-
* @version
|
|
36467
|
+
* @version 175.0.0
|
|
35388
36468
|
*/
|
|
35389
36469
|
|
|
35390
36470
|
/**
|
|
@@ -35535,7 +36615,7 @@ class NotificationsApi {
|
|
|
35535
36615
|
/**
|
|
35536
36616
|
* Notifications service.
|
|
35537
36617
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
35538
|
-
* @version
|
|
36618
|
+
* @version 175.0.0
|
|
35539
36619
|
*/
|
|
35540
36620
|
|
|
35541
36621
|
/**
|
|
@@ -35768,7 +36848,7 @@ class OAuthApi {
|
|
|
35768
36848
|
/**
|
|
35769
36849
|
* OAuth service.
|
|
35770
36850
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35771
|
-
* @version
|
|
36851
|
+
* @version 175.0.0
|
|
35772
36852
|
*/
|
|
35773
36853
|
|
|
35774
36854
|
/**
|
|
@@ -36134,7 +37214,7 @@ class ObjectsApi {
|
|
|
36134
37214
|
/**
|
|
36135
37215
|
* Objects service.
|
|
36136
37216
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
36137
|
-
* @version
|
|
37217
|
+
* @version 175.0.0
|
|
36138
37218
|
*/
|
|
36139
37219
|
|
|
36140
37220
|
/**
|
|
@@ -36405,7 +37485,7 @@ class OrganizationApi {
|
|
|
36405
37485
|
/**
|
|
36406
37486
|
* Organization service.
|
|
36407
37487
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36408
|
-
* @version
|
|
37488
|
+
* @version 175.0.0
|
|
36409
37489
|
*/
|
|
36410
37490
|
|
|
36411
37491
|
/**
|
|
@@ -36860,7 +37940,7 @@ class OrganizationAuthorizationApi {
|
|
|
36860
37940
|
/**
|
|
36861
37941
|
* OrganizationAuthorization service.
|
|
36862
37942
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
36863
|
-
* @version
|
|
37943
|
+
* @version 175.0.0
|
|
36864
37944
|
*/
|
|
36865
37945
|
|
|
36866
37946
|
/**
|
|
@@ -38207,7 +39287,7 @@ class OutboundApi {
|
|
|
38207
39287
|
/**
|
|
38208
39288
|
* Outbound service.
|
|
38209
39289
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38210
|
-
* @version
|
|
39290
|
+
* @version 175.0.0
|
|
38211
39291
|
*/
|
|
38212
39292
|
|
|
38213
39293
|
/**
|
|
@@ -41829,7 +42909,7 @@ class PresenceApi {
|
|
|
41829
42909
|
/**
|
|
41830
42910
|
* Presence service.
|
|
41831
42911
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
41832
|
-
* @version
|
|
42912
|
+
* @version 175.0.0
|
|
41833
42913
|
*/
|
|
41834
42914
|
|
|
41835
42915
|
/**
|
|
@@ -42568,7 +43648,7 @@ class ProcessAutomationApi {
|
|
|
42568
43648
|
/**
|
|
42569
43649
|
* ProcessAutomation service.
|
|
42570
43650
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
42571
|
-
* @version
|
|
43651
|
+
* @version 175.0.0
|
|
42572
43652
|
*/
|
|
42573
43653
|
|
|
42574
43654
|
/**
|
|
@@ -42807,7 +43887,7 @@ class QualityApi {
|
|
|
42807
43887
|
/**
|
|
42808
43888
|
* Quality service.
|
|
42809
43889
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
42810
|
-
* @version
|
|
43890
|
+
* @version 175.0.0
|
|
42811
43891
|
*/
|
|
42812
43892
|
|
|
42813
43893
|
/**
|
|
@@ -43090,6 +44170,7 @@ class QualityApi {
|
|
|
43090
44170
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
43091
44171
|
* @param {String} opts.name name
|
|
43092
44172
|
* @param {String} opts.group group id
|
|
44173
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
43093
44174
|
*/
|
|
43094
44175
|
getQualityAgentsActivity(opts) {
|
|
43095
44176
|
opts = opts || {};
|
|
@@ -43099,7 +44180,7 @@ class QualityApi {
|
|
|
43099
44180
|
'/api/v2/quality/agents/activity',
|
|
43100
44181
|
'GET',
|
|
43101
44182
|
{ },
|
|
43102
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'] },
|
|
44183
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'formContextId': opts['formContextId'] },
|
|
43103
44184
|
{ },
|
|
43104
44185
|
{ },
|
|
43105
44186
|
null,
|
|
@@ -43297,9 +44378,9 @@ class QualityApi {
|
|
|
43297
44378
|
* @param {Object} opts Optional parameters
|
|
43298
44379
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
43299
44380
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
43300
|
-
* @param {String} opts.sortBy
|
|
44381
|
+
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
43301
44382
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
43302
|
-
* @param {String} opts.nextPage
|
|
44383
|
+
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
43303
44384
|
* @param {String} opts.previousPage Previous page token
|
|
43304
44385
|
* @param {String} opts.conversationId conversationId specified
|
|
43305
44386
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -43308,12 +44389,13 @@ class QualityApi {
|
|
|
43308
44389
|
* @param {String} opts.queueId queue id
|
|
43309
44390
|
* @param {String} opts.startTime start time of the evaluation query
|
|
43310
44391
|
* @param {String} opts.endTime end time of the evaluation query
|
|
44392
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
43311
44393
|
* @param {Array.<String>} opts.evaluationState
|
|
43312
44394
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
43313
44395
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
43314
44396
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
43315
|
-
* @param {Number} opts.maximum maximum
|
|
43316
|
-
* @param {String} opts.sortOrder
|
|
44397
|
+
* @param {Number} opts.maximum the maximum number of results to return
|
|
44398
|
+
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
43317
44399
|
*/
|
|
43318
44400
|
getQualityEvaluationsQuery(opts) {
|
|
43319
44401
|
opts = opts || {};
|
|
@@ -43323,7 +44405,7 @@ class QualityApi {
|
|
|
43323
44405
|
'/api/v2/quality/evaluations/query',
|
|
43324
44406
|
'GET',
|
|
43325
44407
|
{ },
|
|
43326
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
44408
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
43327
44409
|
{ },
|
|
43328
44410
|
{ },
|
|
43329
44411
|
null,
|
|
@@ -44400,7 +45482,7 @@ class QualityApi {
|
|
|
44400
45482
|
* @param {String} evaluationId evaluationId
|
|
44401
45483
|
* @param {Object} body evaluation
|
|
44402
45484
|
* @param {Object} opts Optional parameters
|
|
44403
|
-
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
45485
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee, evaluator
|
|
44404
45486
|
*/
|
|
44405
45487
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
44406
45488
|
opts = opts || {};
|
|
@@ -44559,7 +45641,7 @@ class RecordingApi {
|
|
|
44559
45641
|
/**
|
|
44560
45642
|
* Recording service.
|
|
44561
45643
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44562
|
-
* @version
|
|
45644
|
+
* @version 175.0.0
|
|
44563
45645
|
*/
|
|
44564
45646
|
|
|
44565
45647
|
/**
|
|
@@ -46196,7 +47278,7 @@ class ResponseManagementApi {
|
|
|
46196
47278
|
/**
|
|
46197
47279
|
* ResponseManagement service.
|
|
46198
47280
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46199
|
-
* @version
|
|
47281
|
+
* @version 175.0.0
|
|
46200
47282
|
*/
|
|
46201
47283
|
|
|
46202
47284
|
/**
|
|
@@ -46681,7 +47763,7 @@ class RoutingApi {
|
|
|
46681
47763
|
/**
|
|
46682
47764
|
* Routing service.
|
|
46683
47765
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46684
|
-
* @version
|
|
47766
|
+
* @version 175.0.0
|
|
46685
47767
|
*/
|
|
46686
47768
|
|
|
46687
47769
|
/**
|
|
@@ -47688,6 +48770,7 @@ class RoutingApi {
|
|
|
47688
48770
|
*
|
|
47689
48771
|
* @param {Object} opts Optional parameters
|
|
47690
48772
|
* @param {Object} opts.messengerType Messenger Type
|
|
48773
|
+
* @param {String} opts.name Recipient Name
|
|
47691
48774
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47692
48775
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47693
48776
|
*/
|
|
@@ -47699,7 +48782,7 @@ class RoutingApi {
|
|
|
47699
48782
|
'/api/v2/routing/message/recipients',
|
|
47700
48783
|
'GET',
|
|
47701
48784
|
{ },
|
|
47702
|
-
{ 'messengerType': opts['messengerType'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
48785
|
+
{ 'messengerType': opts['messengerType'],'name': opts['name'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
47703
48786
|
{ },
|
|
47704
48787
|
{ },
|
|
47705
48788
|
null,
|
|
@@ -50388,7 +51471,7 @@ class SCIMApi {
|
|
|
50388
51471
|
/**
|
|
50389
51472
|
* SCIM service.
|
|
50390
51473
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50391
|
-
* @version
|
|
51474
|
+
* @version 175.0.0
|
|
50392
51475
|
*/
|
|
50393
51476
|
|
|
50394
51477
|
/**
|
|
@@ -51265,7 +52348,7 @@ class ScriptsApi {
|
|
|
51265
52348
|
/**
|
|
51266
52349
|
* Scripts service.
|
|
51267
52350
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51268
|
-
* @version
|
|
52351
|
+
* @version 175.0.0
|
|
51269
52352
|
*/
|
|
51270
52353
|
|
|
51271
52354
|
/**
|
|
@@ -51709,7 +52792,7 @@ class SearchApi {
|
|
|
51709
52792
|
/**
|
|
51710
52793
|
* Search service.
|
|
51711
52794
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51712
|
-
* @version
|
|
52795
|
+
* @version 175.0.0
|
|
51713
52796
|
*/
|
|
51714
52797
|
|
|
51715
52798
|
/**
|
|
@@ -52398,7 +53481,7 @@ class SettingsApi {
|
|
|
52398
53481
|
/**
|
|
52399
53482
|
* Settings service.
|
|
52400
53483
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
52401
|
-
* @version
|
|
53484
|
+
* @version 175.0.0
|
|
52402
53485
|
*/
|
|
52403
53486
|
|
|
52404
53487
|
/**
|
|
@@ -52463,7 +53546,7 @@ class SpeechTextAnalyticsApi {
|
|
|
52463
53546
|
/**
|
|
52464
53547
|
* SpeechTextAnalytics service.
|
|
52465
53548
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52466
|
-
* @version
|
|
53549
|
+
* @version 175.0.0
|
|
52467
53550
|
*/
|
|
52468
53551
|
|
|
52469
53552
|
/**
|
|
@@ -53446,7 +54529,7 @@ class StationsApi {
|
|
|
53446
54529
|
/**
|
|
53447
54530
|
* Stations service.
|
|
53448
54531
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
53449
|
-
* @version
|
|
54532
|
+
* @version 175.0.0
|
|
53450
54533
|
*/
|
|
53451
54534
|
|
|
53452
54535
|
/**
|
|
@@ -53548,7 +54631,7 @@ class SuggestApi {
|
|
|
53548
54631
|
/**
|
|
53549
54632
|
* Suggest service.
|
|
53550
54633
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53551
|
-
* @version
|
|
54634
|
+
* @version 175.0.0
|
|
53552
54635
|
*/
|
|
53553
54636
|
|
|
53554
54637
|
/**
|
|
@@ -53687,7 +54770,7 @@ class TaskManagementApi {
|
|
|
53687
54770
|
/**
|
|
53688
54771
|
* TaskManagement service.
|
|
53689
54772
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
53690
|
-
* @version
|
|
54773
|
+
* @version 175.0.0
|
|
53691
54774
|
*/
|
|
53692
54775
|
|
|
53693
54776
|
/**
|
|
@@ -54968,7 +56051,7 @@ class TeamsApi {
|
|
|
54968
56051
|
/**
|
|
54969
56052
|
* Teams service.
|
|
54970
56053
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
54971
|
-
* @version
|
|
56054
|
+
* @version 175.0.0
|
|
54972
56055
|
*/
|
|
54973
56056
|
|
|
54974
56057
|
/**
|
|
@@ -55270,7 +56353,7 @@ class TelephonyApi {
|
|
|
55270
56353
|
/**
|
|
55271
56354
|
* Telephony service.
|
|
55272
56355
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
55273
|
-
* @version
|
|
56356
|
+
* @version 175.0.0
|
|
55274
56357
|
*/
|
|
55275
56358
|
|
|
55276
56359
|
/**
|
|
@@ -55398,7 +56481,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
55398
56481
|
/**
|
|
55399
56482
|
* TelephonyProvidersEdge service.
|
|
55400
56483
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
55401
|
-
* @version
|
|
56484
|
+
* @version 175.0.0
|
|
55402
56485
|
*/
|
|
55403
56486
|
|
|
55404
56487
|
/**
|
|
@@ -57061,7 +58144,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
57061
58144
|
}
|
|
57062
58145
|
|
|
57063
58146
|
/**
|
|
57064
|
-
* Get a list of Phone Instances
|
|
58147
|
+
* Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.
|
|
57065
58148
|
*
|
|
57066
58149
|
* @param {Object} opts Optional parameters
|
|
57067
58150
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -58687,7 +59770,7 @@ class TextbotsApi {
|
|
|
58687
59770
|
/**
|
|
58688
59771
|
* Textbots service.
|
|
58689
59772
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
58690
|
-
* @version
|
|
59773
|
+
* @version 175.0.0
|
|
58691
59774
|
*/
|
|
58692
59775
|
|
|
58693
59776
|
/**
|
|
@@ -58815,7 +59898,7 @@ class TokensApi {
|
|
|
58815
59898
|
/**
|
|
58816
59899
|
* Tokens service.
|
|
58817
59900
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
58818
|
-
* @version
|
|
59901
|
+
* @version 175.0.0
|
|
58819
59902
|
*/
|
|
58820
59903
|
|
|
58821
59904
|
/**
|
|
@@ -58878,14 +59961,18 @@ class TokensApi {
|
|
|
58878
59961
|
/**
|
|
58879
59962
|
* Fetch information about the current token
|
|
58880
59963
|
*
|
|
59964
|
+
* @param {Object} opts Optional parameters
|
|
59965
|
+
* @param {Boolean} opts.preserveIdleTTL preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset.
|
|
58881
59966
|
*/
|
|
58882
|
-
getTokensMe() {
|
|
59967
|
+
getTokensMe(opts) {
|
|
59968
|
+
opts = opts || {};
|
|
59969
|
+
|
|
58883
59970
|
|
|
58884
59971
|
return this.apiClient.callApi(
|
|
58885
59972
|
'/api/v2/tokens/me',
|
|
58886
59973
|
'GET',
|
|
58887
59974
|
{ },
|
|
58888
|
-
{
|
|
59975
|
+
{ 'preserveIdleTTL': opts['preserveIdleTTL'] },
|
|
58889
59976
|
{ },
|
|
58890
59977
|
{ },
|
|
58891
59978
|
null,
|
|
@@ -58967,7 +60054,7 @@ class UploadsApi {
|
|
|
58967
60054
|
/**
|
|
58968
60055
|
* Uploads service.
|
|
58969
60056
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
58970
|
-
* @version
|
|
60057
|
+
* @version 175.0.0
|
|
58971
60058
|
*/
|
|
58972
60059
|
|
|
58973
60060
|
/**
|
|
@@ -59143,7 +60230,7 @@ class UsageApi {
|
|
|
59143
60230
|
/**
|
|
59144
60231
|
* Usage service.
|
|
59145
60232
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
59146
|
-
* @version
|
|
60233
|
+
* @version 175.0.0
|
|
59147
60234
|
*/
|
|
59148
60235
|
|
|
59149
60236
|
/**
|
|
@@ -59353,7 +60440,7 @@ class UserRecordingsApi {
|
|
|
59353
60440
|
/**
|
|
59354
60441
|
* UserRecordings service.
|
|
59355
60442
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
59356
|
-
* @version
|
|
60443
|
+
* @version 175.0.0
|
|
59357
60444
|
*/
|
|
59358
60445
|
|
|
59359
60446
|
/**
|
|
@@ -59538,7 +60625,7 @@ class UsersApi {
|
|
|
59538
60625
|
/**
|
|
59539
60626
|
* Users service.
|
|
59540
60627
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
59541
|
-
* @version
|
|
60628
|
+
* @version 175.0.0
|
|
59542
60629
|
*/
|
|
59543
60630
|
|
|
59544
60631
|
/**
|
|
@@ -62099,7 +63186,7 @@ class UtilitiesApi {
|
|
|
62099
63186
|
/**
|
|
62100
63187
|
* Utilities service.
|
|
62101
63188
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
62102
|
-
* @version
|
|
63189
|
+
* @version 175.0.0
|
|
62103
63190
|
*/
|
|
62104
63191
|
|
|
62105
63192
|
/**
|
|
@@ -62210,7 +63297,7 @@ class VoicemailApi {
|
|
|
62210
63297
|
/**
|
|
62211
63298
|
* Voicemail service.
|
|
62212
63299
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
62213
|
-
* @version
|
|
63300
|
+
* @version 175.0.0
|
|
62214
63301
|
*/
|
|
62215
63302
|
|
|
62216
63303
|
/**
|
|
@@ -62877,7 +63964,7 @@ class WebChatApi {
|
|
|
62877
63964
|
/**
|
|
62878
63965
|
* WebChat service.
|
|
62879
63966
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
62880
|
-
* @version
|
|
63967
|
+
* @version 175.0.0
|
|
62881
63968
|
*/
|
|
62882
63969
|
|
|
62883
63970
|
/**
|
|
@@ -63426,7 +64513,7 @@ class WebDeploymentsApi {
|
|
|
63426
64513
|
/**
|
|
63427
64514
|
* WebDeployments service.
|
|
63428
64515
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
63429
|
-
* @version
|
|
64516
|
+
* @version 175.0.0
|
|
63430
64517
|
*/
|
|
63431
64518
|
|
|
63432
64519
|
/**
|
|
@@ -63654,8 +64741,12 @@ class WebDeploymentsApi {
|
|
|
63654
64741
|
* Get a deployment
|
|
63655
64742
|
*
|
|
63656
64743
|
* @param {String} deploymentId The deployment ID
|
|
64744
|
+
* @param {Object} opts Optional parameters
|
|
64745
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
63657
64746
|
*/
|
|
63658
|
-
getWebdeploymentsDeployment(deploymentId) {
|
|
64747
|
+
getWebdeploymentsDeployment(deploymentId, opts) {
|
|
64748
|
+
opts = opts || {};
|
|
64749
|
+
|
|
63659
64750
|
// verify the required parameter 'deploymentId' is set
|
|
63660
64751
|
if (deploymentId === undefined || deploymentId === null) {
|
|
63661
64752
|
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';
|
|
@@ -63665,7 +64756,7 @@ class WebDeploymentsApi {
|
|
|
63665
64756
|
'/api/v2/webdeployments/deployments/{deploymentId}',
|
|
63666
64757
|
'GET',
|
|
63667
64758
|
{ 'deploymentId': deploymentId },
|
|
63668
|
-
{
|
|
64759
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63669
64760
|
{ },
|
|
63670
64761
|
{ },
|
|
63671
64762
|
null,
|
|
@@ -63711,6 +64802,7 @@ class WebDeploymentsApi {
|
|
|
63711
64802
|
* @param {String} deploymentId The deployment ID
|
|
63712
64803
|
* @param {Object} opts Optional parameters
|
|
63713
64804
|
* @param {String} opts.type Get active configuration on a deployment
|
|
64805
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value
|
|
63714
64806
|
*/
|
|
63715
64807
|
getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
|
|
63716
64808
|
opts = opts || {};
|
|
@@ -63724,7 +64816,7 @@ class WebDeploymentsApi {
|
|
|
63724
64816
|
'/api/v2/webdeployments/deployments/{deploymentId}/configurations',
|
|
63725
64817
|
'GET',
|
|
63726
64818
|
{ 'deploymentId': deploymentId },
|
|
63727
|
-
{ 'type': opts['type'] },
|
|
64819
|
+
{ 'type': opts['type'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63728
64820
|
{ },
|
|
63729
64821
|
{ },
|
|
63730
64822
|
null,
|
|
@@ -63738,7 +64830,7 @@ class WebDeploymentsApi {
|
|
|
63738
64830
|
* Get deployments
|
|
63739
64831
|
*
|
|
63740
64832
|
* @param {Object} opts Optional parameters
|
|
63741
|
-
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
64833
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
63742
64834
|
*/
|
|
63743
64835
|
getWebdeploymentsDeployments(opts) {
|
|
63744
64836
|
opts = opts || {};
|
|
@@ -63948,7 +65040,7 @@ class WebMessagingApi {
|
|
|
63948
65040
|
/**
|
|
63949
65041
|
* WebMessaging service.
|
|
63950
65042
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
63951
|
-
* @version
|
|
65043
|
+
* @version 175.0.0
|
|
63952
65044
|
*/
|
|
63953
65045
|
|
|
63954
65046
|
/**
|
|
@@ -63994,7 +65086,7 @@ class WidgetsApi {
|
|
|
63994
65086
|
/**
|
|
63995
65087
|
* Widgets service.
|
|
63996
65088
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
63997
|
-
* @version
|
|
65089
|
+
* @version 175.0.0
|
|
63998
65090
|
*/
|
|
63999
65091
|
|
|
64000
65092
|
/**
|
|
@@ -64140,7 +65232,7 @@ class WorkforceManagementApi {
|
|
|
64140
65232
|
/**
|
|
64141
65233
|
* WorkforceManagement service.
|
|
64142
65234
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
64143
|
-
* @version
|
|
65235
|
+
* @version 175.0.0
|
|
64144
65236
|
*/
|
|
64145
65237
|
|
|
64146
65238
|
/**
|
|
@@ -65059,8 +66151,12 @@ class WorkforceManagementApi {
|
|
|
65059
66151
|
*
|
|
65060
66152
|
* @param {String} businessUnitId The ID of the business unit.
|
|
65061
66153
|
* @param {String} serviceGoalTemplateId The ID of a service goal template to fetch
|
|
66154
|
+
* @param {Object} opts Optional parameters
|
|
66155
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
65062
66156
|
*/
|
|
65063
|
-
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId) {
|
|
66157
|
+
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, opts) {
|
|
66158
|
+
opts = opts || {};
|
|
66159
|
+
|
|
65064
66160
|
// verify the required parameter 'businessUnitId' is set
|
|
65065
66161
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
65066
66162
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
@@ -65074,7 +66170,7 @@ class WorkforceManagementApi {
|
|
|
65074
66170
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
65075
66171
|
'GET',
|
|
65076
66172
|
{ 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
|
|
65077
|
-
{
|
|
66173
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
65078
66174
|
{ },
|
|
65079
66175
|
{ },
|
|
65080
66176
|
null,
|
|
@@ -65088,8 +66184,12 @@ class WorkforceManagementApi {
|
|
|
65088
66184
|
* Gets list of service goal templates
|
|
65089
66185
|
*
|
|
65090
66186
|
* @param {String} businessUnitId The ID of the business unit.
|
|
66187
|
+
* @param {Object} opts Optional parameters
|
|
66188
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
65091
66189
|
*/
|
|
65092
|
-
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId) {
|
|
66190
|
+
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, opts) {
|
|
66191
|
+
opts = opts || {};
|
|
66192
|
+
|
|
65093
66193
|
// verify the required parameter 'businessUnitId' is set
|
|
65094
66194
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
65095
66195
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
@@ -65099,7 +66199,7 @@ class WorkforceManagementApi {
|
|
|
65099
66199
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
|
|
65100
66200
|
'GET',
|
|
65101
66201
|
{ 'businessUnitId': businessUnitId },
|
|
65102
|
-
{
|
|
66202
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
65103
66203
|
{ },
|
|
65104
66204
|
{ },
|
|
65105
66205
|
null,
|
|
@@ -65649,6 +66749,51 @@ class WorkforceManagementApi {
|
|
|
65649
66749
|
);
|
|
65650
66750
|
}
|
|
65651
66751
|
|
|
66752
|
+
/**
|
|
66753
|
+
* Get integrations
|
|
66754
|
+
*
|
|
66755
|
+
*/
|
|
66756
|
+
getWorkforcemanagementIntegrationsHris() {
|
|
66757
|
+
|
|
66758
|
+
return this.apiClient.callApi(
|
|
66759
|
+
'/api/v2/workforcemanagement/integrations/hris',
|
|
66760
|
+
'GET',
|
|
66761
|
+
{ },
|
|
66762
|
+
{ },
|
|
66763
|
+
{ },
|
|
66764
|
+
{ },
|
|
66765
|
+
null,
|
|
66766
|
+
['PureCloud OAuth'],
|
|
66767
|
+
['application/json'],
|
|
66768
|
+
['application/json']
|
|
66769
|
+
);
|
|
66770
|
+
}
|
|
66771
|
+
|
|
66772
|
+
/**
|
|
66773
|
+
* Query the results of time off types job
|
|
66774
|
+
*
|
|
66775
|
+
* @param {String} jobId The ID of the job.
|
|
66776
|
+
*/
|
|
66777
|
+
getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId) {
|
|
66778
|
+
// verify the required parameter 'jobId' is set
|
|
66779
|
+
if (jobId === undefined || jobId === null) {
|
|
66780
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';
|
|
66781
|
+
}
|
|
66782
|
+
|
|
66783
|
+
return this.apiClient.callApi(
|
|
66784
|
+
'/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}',
|
|
66785
|
+
'GET',
|
|
66786
|
+
{ 'jobId': jobId },
|
|
66787
|
+
{ },
|
|
66788
|
+
{ },
|
|
66789
|
+
{ },
|
|
66790
|
+
null,
|
|
66791
|
+
['PureCloud OAuth'],
|
|
66792
|
+
['application/json'],
|
|
66793
|
+
['application/json']
|
|
66794
|
+
);
|
|
66795
|
+
}
|
|
66796
|
+
|
|
65652
66797
|
/**
|
|
65653
66798
|
* Get management unit
|
|
65654
66799
|
* settings.shortTermForecasting is deprecated and now lives on the business unit
|
|
@@ -66462,6 +67607,31 @@ class WorkforceManagementApi {
|
|
|
66462
67607
|
);
|
|
66463
67608
|
}
|
|
66464
67609
|
|
|
67610
|
+
/**
|
|
67611
|
+
* Query the results of time off types job
|
|
67612
|
+
*
|
|
67613
|
+
* @param {String} jobId The ID of the job.
|
|
67614
|
+
*/
|
|
67615
|
+
getWorkforcemanagementTimeoffbalanceJob(jobId) {
|
|
67616
|
+
// verify the required parameter 'jobId' is set
|
|
67617
|
+
if (jobId === undefined || jobId === null) {
|
|
67618
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';
|
|
67619
|
+
}
|
|
67620
|
+
|
|
67621
|
+
return this.apiClient.callApi(
|
|
67622
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}',
|
|
67623
|
+
'GET',
|
|
67624
|
+
{ 'jobId': jobId },
|
|
67625
|
+
{ },
|
|
67626
|
+
{ },
|
|
67627
|
+
{ },
|
|
67628
|
+
null,
|
|
67629
|
+
['PureCloud OAuth'],
|
|
67630
|
+
['application/json'],
|
|
67631
|
+
['application/json']
|
|
67632
|
+
);
|
|
67633
|
+
}
|
|
67634
|
+
|
|
66465
67635
|
/**
|
|
66466
67636
|
* Get a time off request for the current user
|
|
66467
67637
|
*
|
|
@@ -66833,6 +68003,45 @@ class WorkforceManagementApi {
|
|
|
66833
68003
|
);
|
|
66834
68004
|
}
|
|
66835
68005
|
|
|
68006
|
+
/**
|
|
68007
|
+
* Set integration status for a time off request.
|
|
68008
|
+
*
|
|
68009
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
68010
|
+
* @param {String} timeOffRequestId The ID of the time off request.
|
|
68011
|
+
* @param {String} userId The ID of user to whom the time off request belongs.
|
|
68012
|
+
* @param {Object} opts Optional parameters
|
|
68013
|
+
* @param {Object} opts.body body
|
|
68014
|
+
*/
|
|
68015
|
+
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, opts) {
|
|
68016
|
+
opts = opts || {};
|
|
68017
|
+
|
|
68018
|
+
// verify the required parameter 'managementUnitId' is set
|
|
68019
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
68020
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
68021
|
+
}
|
|
68022
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
68023
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
68024
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
68025
|
+
}
|
|
68026
|
+
// verify the required parameter 'userId' is set
|
|
68027
|
+
if (userId === undefined || userId === null) {
|
|
68028
|
+
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
68029
|
+
}
|
|
68030
|
+
|
|
68031
|
+
return this.apiClient.callApi(
|
|
68032
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
|
|
68033
|
+
'PATCH',
|
|
68034
|
+
{ 'managementUnitId': managementUnitId,'timeOffRequestId': timeOffRequestId,'userId': userId },
|
|
68035
|
+
{ },
|
|
68036
|
+
{ },
|
|
68037
|
+
{ },
|
|
68038
|
+
opts['body'],
|
|
68039
|
+
['PureCloud OAuth'],
|
|
68040
|
+
['application/json'],
|
|
68041
|
+
['application/json']
|
|
68042
|
+
);
|
|
68043
|
+
}
|
|
68044
|
+
|
|
66836
68045
|
/**
|
|
66837
68046
|
* Update a time off request
|
|
66838
68047
|
*
|
|
@@ -67070,6 +68279,7 @@ class WorkforceManagementApi {
|
|
|
67070
68279
|
*
|
|
67071
68280
|
* @param {Object} opts Optional parameters
|
|
67072
68281
|
* @param {Object} opts.body body
|
|
68282
|
+
* @deprecated
|
|
67073
68283
|
*/
|
|
67074
68284
|
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
67075
68285
|
opts = opts || {};
|
|
@@ -67178,6 +68388,54 @@ class WorkforceManagementApi {
|
|
|
67178
68388
|
);
|
|
67179
68389
|
}
|
|
67180
68390
|
|
|
68391
|
+
/**
|
|
68392
|
+
* Move agents in and out of management unit
|
|
68393
|
+
*
|
|
68394
|
+
* @param {Object} opts Optional parameters
|
|
68395
|
+
* @param {Object} opts.body body
|
|
68396
|
+
*/
|
|
68397
|
+
postWorkforcemanagementAgents(opts) {
|
|
68398
|
+
opts = opts || {};
|
|
68399
|
+
|
|
68400
|
+
|
|
68401
|
+
return this.apiClient.callApi(
|
|
68402
|
+
'/api/v2/workforcemanagement/agents',
|
|
68403
|
+
'POST',
|
|
68404
|
+
{ },
|
|
68405
|
+
{ },
|
|
68406
|
+
{ },
|
|
68407
|
+
{ },
|
|
68408
|
+
opts['body'],
|
|
68409
|
+
['PureCloud OAuth'],
|
|
68410
|
+
['application/json'],
|
|
68411
|
+
['application/json']
|
|
68412
|
+
);
|
|
68413
|
+
}
|
|
68414
|
+
|
|
68415
|
+
/**
|
|
68416
|
+
* Query integrations for agents
|
|
68417
|
+
*
|
|
68418
|
+
* @param {Object} opts Optional parameters
|
|
68419
|
+
* @param {Object} opts.body body
|
|
68420
|
+
*/
|
|
68421
|
+
postWorkforcemanagementAgentsIntegrationsHrisQuery(opts) {
|
|
68422
|
+
opts = opts || {};
|
|
68423
|
+
|
|
68424
|
+
|
|
68425
|
+
return this.apiClient.callApi(
|
|
68426
|
+
'/api/v2/workforcemanagement/agents/integrations/hris/query',
|
|
68427
|
+
'POST',
|
|
68428
|
+
{ },
|
|
68429
|
+
{ },
|
|
68430
|
+
{ },
|
|
68431
|
+
{ },
|
|
68432
|
+
opts['body'],
|
|
68433
|
+
['PureCloud OAuth'],
|
|
68434
|
+
['application/json'],
|
|
68435
|
+
['application/json']
|
|
68436
|
+
);
|
|
68437
|
+
}
|
|
68438
|
+
|
|
67181
68439
|
/**
|
|
67182
68440
|
* Get agent possible work shifts for requested time frame
|
|
67183
68441
|
*
|
|
@@ -68000,6 +69258,31 @@ class WorkforceManagementApi {
|
|
|
68000
69258
|
);
|
|
68001
69259
|
}
|
|
68002
69260
|
|
|
69261
|
+
/**
|
|
69262
|
+
* Get list of time off types configured in integration
|
|
69263
|
+
*
|
|
69264
|
+
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
69265
|
+
*/
|
|
69266
|
+
postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId) {
|
|
69267
|
+
// verify the required parameter 'hrisIntegrationId' is set
|
|
69268
|
+
if (hrisIntegrationId === undefined || hrisIntegrationId === null) {
|
|
69269
|
+
throw 'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';
|
|
69270
|
+
}
|
|
69271
|
+
|
|
69272
|
+
return this.apiClient.callApi(
|
|
69273
|
+
'/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs',
|
|
69274
|
+
'POST',
|
|
69275
|
+
{ 'hrisIntegrationId': hrisIntegrationId },
|
|
69276
|
+
{ },
|
|
69277
|
+
{ },
|
|
69278
|
+
{ },
|
|
69279
|
+
null,
|
|
69280
|
+
['PureCloud OAuth'],
|
|
69281
|
+
['application/json'],
|
|
69282
|
+
['application/json']
|
|
69283
|
+
);
|
|
69284
|
+
}
|
|
69285
|
+
|
|
68003
69286
|
/**
|
|
68004
69287
|
* Query published schedules for given given time range for set of users
|
|
68005
69288
|
*
|
|
@@ -68264,6 +69547,35 @@ class WorkforceManagementApi {
|
|
|
68264
69547
|
);
|
|
68265
69548
|
}
|
|
68266
69549
|
|
|
69550
|
+
/**
|
|
69551
|
+
* Retrieves integration statuses for a list of time off requests
|
|
69552
|
+
*
|
|
69553
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
69554
|
+
* @param {Object} opts Optional parameters
|
|
69555
|
+
* @param {Object} opts.body body
|
|
69556
|
+
*/
|
|
69557
|
+
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, opts) {
|
|
69558
|
+
opts = opts || {};
|
|
69559
|
+
|
|
69560
|
+
// verify the required parameter 'managementUnitId' is set
|
|
69561
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
69562
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
69563
|
+
}
|
|
69564
|
+
|
|
69565
|
+
return this.apiClient.callApi(
|
|
69566
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
|
|
69567
|
+
'POST',
|
|
69568
|
+
{ 'managementUnitId': managementUnitId },
|
|
69569
|
+
{ },
|
|
69570
|
+
{ },
|
|
69571
|
+
{ },
|
|
69572
|
+
opts['body'],
|
|
69573
|
+
['PureCloud OAuth'],
|
|
69574
|
+
['application/json'],
|
|
69575
|
+
['application/json']
|
|
69576
|
+
);
|
|
69577
|
+
}
|
|
69578
|
+
|
|
68267
69579
|
/**
|
|
68268
69580
|
* Fetches time off requests matching the conditions specified in the request body
|
|
68269
69581
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
@@ -68392,6 +69704,40 @@ class WorkforceManagementApi {
|
|
|
68392
69704
|
);
|
|
68393
69705
|
}
|
|
68394
69706
|
|
|
69707
|
+
/**
|
|
69708
|
+
* Estimates available time off for an agent
|
|
69709
|
+
*
|
|
69710
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
69711
|
+
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
69712
|
+
* @param {Object} opts Optional parameters
|
|
69713
|
+
* @param {Object} opts.body body
|
|
69714
|
+
*/
|
|
69715
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, opts) {
|
|
69716
|
+
opts = opts || {};
|
|
69717
|
+
|
|
69718
|
+
// verify the required parameter 'managementUnitId' is set
|
|
69719
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
69720
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
69721
|
+
}
|
|
69722
|
+
// verify the required parameter 'userId' is set
|
|
69723
|
+
if (userId === undefined || userId === null) {
|
|
69724
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
69725
|
+
}
|
|
69726
|
+
|
|
69727
|
+
return this.apiClient.callApi(
|
|
69728
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
69729
|
+
'POST',
|
|
69730
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
69731
|
+
{ },
|
|
69732
|
+
{ },
|
|
69733
|
+
{ },
|
|
69734
|
+
opts['body'],
|
|
69735
|
+
['PureCloud OAuth'],
|
|
69736
|
+
['application/json'],
|
|
69737
|
+
['application/json']
|
|
69738
|
+
);
|
|
69739
|
+
}
|
|
69740
|
+
|
|
68395
69741
|
/**
|
|
68396
69742
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
68397
69743
|
*
|
|
@@ -68834,6 +70180,31 @@ class WorkforceManagementApi {
|
|
|
68834
70180
|
);
|
|
68835
70181
|
}
|
|
68836
70182
|
|
|
70183
|
+
/**
|
|
70184
|
+
* Query time off balances for the current user for specified activity code and dates
|
|
70185
|
+
*
|
|
70186
|
+
* @param {Object} body The request body
|
|
70187
|
+
*/
|
|
70188
|
+
postWorkforcemanagementTimeoffbalanceJobs(body) {
|
|
70189
|
+
// verify the required parameter 'body' is set
|
|
70190
|
+
if (body === undefined || body === null) {
|
|
70191
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';
|
|
70192
|
+
}
|
|
70193
|
+
|
|
70194
|
+
return this.apiClient.callApi(
|
|
70195
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs',
|
|
70196
|
+
'POST',
|
|
70197
|
+
{ },
|
|
70198
|
+
{ },
|
|
70199
|
+
{ },
|
|
70200
|
+
{ },
|
|
70201
|
+
body,
|
|
70202
|
+
['PureCloud OAuth'],
|
|
70203
|
+
['application/json'],
|
|
70204
|
+
['application/json']
|
|
70205
|
+
);
|
|
70206
|
+
}
|
|
70207
|
+
|
|
68837
70208
|
/**
|
|
68838
70209
|
* Queries available time off for the current user
|
|
68839
70210
|
*
|
|
@@ -68882,6 +70253,84 @@ class WorkforceManagementApi {
|
|
|
68882
70253
|
);
|
|
68883
70254
|
}
|
|
68884
70255
|
|
|
70256
|
+
/**
|
|
70257
|
+
* Estimates available time off for current user
|
|
70258
|
+
*
|
|
70259
|
+
* @param {Object} opts Optional parameters
|
|
70260
|
+
* @param {Object} opts.body body
|
|
70261
|
+
*/
|
|
70262
|
+
postWorkforcemanagementTimeoffrequestsEstimate(opts) {
|
|
70263
|
+
opts = opts || {};
|
|
70264
|
+
|
|
70265
|
+
|
|
70266
|
+
return this.apiClient.callApi(
|
|
70267
|
+
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
70268
|
+
'POST',
|
|
70269
|
+
{ },
|
|
70270
|
+
{ },
|
|
70271
|
+
{ },
|
|
70272
|
+
{ },
|
|
70273
|
+
opts['body'],
|
|
70274
|
+
['PureCloud OAuth'],
|
|
70275
|
+
['application/json'],
|
|
70276
|
+
['application/json']
|
|
70277
|
+
);
|
|
70278
|
+
}
|
|
70279
|
+
|
|
70280
|
+
/**
|
|
70281
|
+
* Retrieves integration statuses for a list of current user time off requests
|
|
70282
|
+
*
|
|
70283
|
+
* @param {Object} opts Optional parameters
|
|
70284
|
+
* @param {Object} opts.body body
|
|
70285
|
+
*/
|
|
70286
|
+
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(opts) {
|
|
70287
|
+
opts = opts || {};
|
|
70288
|
+
|
|
70289
|
+
|
|
70290
|
+
return this.apiClient.callApi(
|
|
70291
|
+
'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
|
|
70292
|
+
'POST',
|
|
70293
|
+
{ },
|
|
70294
|
+
{ },
|
|
70295
|
+
{ },
|
|
70296
|
+
{ },
|
|
70297
|
+
opts['body'],
|
|
70298
|
+
['PureCloud OAuth'],
|
|
70299
|
+
['application/json'],
|
|
70300
|
+
['application/json']
|
|
70301
|
+
);
|
|
70302
|
+
}
|
|
70303
|
+
|
|
70304
|
+
/**
|
|
70305
|
+
* Update integrations for agent
|
|
70306
|
+
*
|
|
70307
|
+
* @param {String} agentId The ID of the agent
|
|
70308
|
+
* @param {Object} body body
|
|
70309
|
+
*/
|
|
70310
|
+
putWorkforcemanagementAgentIntegrationsHris(agentId, body) {
|
|
70311
|
+
// verify the required parameter 'agentId' is set
|
|
70312
|
+
if (agentId === undefined || agentId === null) {
|
|
70313
|
+
throw 'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
70314
|
+
}
|
|
70315
|
+
// verify the required parameter 'body' is set
|
|
70316
|
+
if (body === undefined || body === null) {
|
|
70317
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
70318
|
+
}
|
|
70319
|
+
|
|
70320
|
+
return this.apiClient.callApi(
|
|
70321
|
+
'/api/v2/workforcemanagement/agents/{agentId}/integrations/hris',
|
|
70322
|
+
'PUT',
|
|
70323
|
+
{ 'agentId': agentId },
|
|
70324
|
+
{ },
|
|
70325
|
+
{ },
|
|
70326
|
+
{ },
|
|
70327
|
+
body,
|
|
70328
|
+
['PureCloud OAuth'],
|
|
70329
|
+
['application/json'],
|
|
70330
|
+
['application/json']
|
|
70331
|
+
);
|
|
70332
|
+
}
|
|
70333
|
+
|
|
68885
70334
|
/**
|
|
68886
70335
|
* Sets daily values for a date range of time off limit object
|
|
68887
70336
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
@@ -68947,7 +70396,7 @@ class WorkforceManagementApi {
|
|
|
68947
70396
|
* </pre>
|
|
68948
70397
|
* </p>
|
|
68949
70398
|
* @module purecloud-platform-client-v2/index
|
|
68950
|
-
* @version
|
|
70399
|
+
* @version 175.0.0
|
|
68951
70400
|
*/
|
|
68952
70401
|
class platformClient {
|
|
68953
70402
|
constructor() {
|