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
|
@@ -9336,7 +9336,7 @@ class Configuration {
|
|
|
9336
9336
|
|
|
9337
9337
|
/**
|
|
9338
9338
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9339
|
-
* @version
|
|
9339
|
+
* @version 175.0.0
|
|
9340
9340
|
*/
|
|
9341
9341
|
class ApiClient {
|
|
9342
9342
|
/**
|
|
@@ -10415,7 +10415,7 @@ class AlertingApi {
|
|
|
10415
10415
|
/**
|
|
10416
10416
|
* Alerting service.
|
|
10417
10417
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10418
|
-
* @version
|
|
10418
|
+
* @version 175.0.0
|
|
10419
10419
|
*/
|
|
10420
10420
|
|
|
10421
10421
|
/**
|
|
@@ -11065,7 +11065,7 @@ class AnalyticsApi {
|
|
|
11065
11065
|
/**
|
|
11066
11066
|
* Analytics service.
|
|
11067
11067
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
11068
|
-
* @version
|
|
11068
|
+
* @version 175.0.0
|
|
11069
11069
|
*/
|
|
11070
11070
|
|
|
11071
11071
|
/**
|
|
@@ -11213,13 +11213,14 @@ class AnalyticsApi {
|
|
|
11213
11213
|
|
|
11214
11214
|
/**
|
|
11215
11215
|
* Get Reporting Turns.
|
|
11216
|
-
* 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.
|
|
11216
|
+
* 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.
|
|
11217
11217
|
* @param {String} botFlowId ID of the bot flow.
|
|
11218
11218
|
* @param {Object} opts Optional parameters
|
|
11219
11219
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
11220
11220
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
11221
|
+
* @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
|
|
11221
11222
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
11222
|
-
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
11223
|
+
* @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.
|
|
11223
11224
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
11224
11225
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
11225
11226
|
*/
|
|
@@ -11235,7 +11236,7 @@ class AnalyticsApi {
|
|
|
11235
11236
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
11236
11237
|
'GET',
|
|
11237
11238
|
{ 'botFlowId': botFlowId },
|
|
11238
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
11239
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
11239
11240
|
{ },
|
|
11240
11241
|
{ },
|
|
11241
11242
|
null,
|
|
@@ -13510,7 +13511,7 @@ class ArchitectApi {
|
|
|
13510
13511
|
/**
|
|
13511
13512
|
* Architect service.
|
|
13512
13513
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
13513
|
-
* @version
|
|
13514
|
+
* @version 175.0.0
|
|
13514
13515
|
*/
|
|
13515
13516
|
|
|
13516
13517
|
/**
|
|
@@ -13550,6 +13551,125 @@ class ArchitectApi {
|
|
|
13550
13551
|
);
|
|
13551
13552
|
}
|
|
13552
13553
|
|
|
13554
|
+
/**
|
|
13555
|
+
* Delete a grammar.
|
|
13556
|
+
*
|
|
13557
|
+
* @param {String} grammarId grammar ID
|
|
13558
|
+
* deleteArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13559
|
+
*/
|
|
13560
|
+
deleteArchitectGrammar(grammarId) {
|
|
13561
|
+
// verify the required parameter 'grammarId' is set
|
|
13562
|
+
if (grammarId === undefined || grammarId === null) {
|
|
13563
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';
|
|
13564
|
+
}
|
|
13565
|
+
|
|
13566
|
+
return this.apiClient.callApi(
|
|
13567
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
13568
|
+
'DELETE',
|
|
13569
|
+
{ 'grammarId': grammarId },
|
|
13570
|
+
{ },
|
|
13571
|
+
{ },
|
|
13572
|
+
{ },
|
|
13573
|
+
null,
|
|
13574
|
+
['PureCloud OAuth'],
|
|
13575
|
+
['application/json'],
|
|
13576
|
+
['application/json']
|
|
13577
|
+
);
|
|
13578
|
+
}
|
|
13579
|
+
|
|
13580
|
+
/**
|
|
13581
|
+
* Delete specified grammar language
|
|
13582
|
+
*
|
|
13583
|
+
* @param {String} grammarId Grammar ID
|
|
13584
|
+
* @param {String} languageCode Language
|
|
13585
|
+
* deleteArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13586
|
+
*/
|
|
13587
|
+
deleteArchitectGrammarLanguage(grammarId, languageCode) {
|
|
13588
|
+
// verify the required parameter 'grammarId' is set
|
|
13589
|
+
if (grammarId === undefined || grammarId === null) {
|
|
13590
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';
|
|
13591
|
+
}
|
|
13592
|
+
// verify the required parameter 'languageCode' is set
|
|
13593
|
+
if (languageCode === undefined || languageCode === null) {
|
|
13594
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';
|
|
13595
|
+
}
|
|
13596
|
+
|
|
13597
|
+
return this.apiClient.callApi(
|
|
13598
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
13599
|
+
'DELETE',
|
|
13600
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
13601
|
+
{ },
|
|
13602
|
+
{ },
|
|
13603
|
+
{ },
|
|
13604
|
+
null,
|
|
13605
|
+
['PureCloud OAuth'],
|
|
13606
|
+
['application/json'],
|
|
13607
|
+
['application/json']
|
|
13608
|
+
);
|
|
13609
|
+
}
|
|
13610
|
+
|
|
13611
|
+
/**
|
|
13612
|
+
* Clear the DTMF mode file for the grammar language if there is one
|
|
13613
|
+
*
|
|
13614
|
+
* @param {String} grammarId Grammar ID
|
|
13615
|
+
* @param {String} languageCode Language
|
|
13616
|
+
* deleteArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13617
|
+
*/
|
|
13618
|
+
deleteArchitectGrammarLanguageFilesDtmf(grammarId, languageCode) {
|
|
13619
|
+
// verify the required parameter 'grammarId' is set
|
|
13620
|
+
if (grammarId === undefined || grammarId === null) {
|
|
13621
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
13622
|
+
}
|
|
13623
|
+
// verify the required parameter 'languageCode' is set
|
|
13624
|
+
if (languageCode === undefined || languageCode === null) {
|
|
13625
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
13626
|
+
}
|
|
13627
|
+
|
|
13628
|
+
return this.apiClient.callApi(
|
|
13629
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
13630
|
+
'DELETE',
|
|
13631
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
13632
|
+
{ },
|
|
13633
|
+
{ },
|
|
13634
|
+
{ },
|
|
13635
|
+
null,
|
|
13636
|
+
['PureCloud OAuth'],
|
|
13637
|
+
['application/json'],
|
|
13638
|
+
['application/json']
|
|
13639
|
+
);
|
|
13640
|
+
}
|
|
13641
|
+
|
|
13642
|
+
/**
|
|
13643
|
+
* Clear the voice mode file for the grammar language if there is one
|
|
13644
|
+
*
|
|
13645
|
+
* @param {String} grammarId Grammar ID
|
|
13646
|
+
* @param {String} languageCode Language
|
|
13647
|
+
* deleteArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13648
|
+
*/
|
|
13649
|
+
deleteArchitectGrammarLanguageFilesVoice(grammarId, languageCode) {
|
|
13650
|
+
// verify the required parameter 'grammarId' is set
|
|
13651
|
+
if (grammarId === undefined || grammarId === null) {
|
|
13652
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
13653
|
+
}
|
|
13654
|
+
// verify the required parameter 'languageCode' is set
|
|
13655
|
+
if (languageCode === undefined || languageCode === null) {
|
|
13656
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
13657
|
+
}
|
|
13658
|
+
|
|
13659
|
+
return this.apiClient.callApi(
|
|
13660
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
13661
|
+
'DELETE',
|
|
13662
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
13663
|
+
{ },
|
|
13664
|
+
{ },
|
|
13665
|
+
{ },
|
|
13666
|
+
null,
|
|
13667
|
+
['PureCloud OAuth'],
|
|
13668
|
+
['application/json'],
|
|
13669
|
+
['application/json']
|
|
13670
|
+
);
|
|
13671
|
+
}
|
|
13672
|
+
|
|
13553
13673
|
/**
|
|
13554
13674
|
* Delete an IVR Config.
|
|
13555
13675
|
*
|
|
@@ -14234,6 +14354,130 @@ class ArchitectApi {
|
|
|
14234
14354
|
);
|
|
14235
14355
|
}
|
|
14236
14356
|
|
|
14357
|
+
/**
|
|
14358
|
+
* Get a pageable list of basic emergency group objects filterable by query parameters.
|
|
14359
|
+
* 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.
|
|
14360
|
+
* @param {Object} opts Optional parameters
|
|
14361
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
14362
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
14363
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
14364
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
14365
|
+
* @param {Array.<String>} opts.id ID of the Emergency Groups to filter by.
|
|
14366
|
+
* @param {String} opts.name Name of the Emergency Group to filter by.
|
|
14367
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
14368
|
+
*/
|
|
14369
|
+
getArchitectEmergencygroupsDivisionviews(opts) {
|
|
14370
|
+
opts = opts || {};
|
|
14371
|
+
|
|
14372
|
+
|
|
14373
|
+
return this.apiClient.callApi(
|
|
14374
|
+
'/api/v2/architect/emergencygroups/divisionviews',
|
|
14375
|
+
'GET',
|
|
14376
|
+
{ },
|
|
14377
|
+
{ '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') },
|
|
14378
|
+
{ },
|
|
14379
|
+
{ },
|
|
14380
|
+
null,
|
|
14381
|
+
['PureCloud OAuth'],
|
|
14382
|
+
['application/json'],
|
|
14383
|
+
['application/json']
|
|
14384
|
+
);
|
|
14385
|
+
}
|
|
14386
|
+
|
|
14387
|
+
/**
|
|
14388
|
+
* Get a grammar
|
|
14389
|
+
* Returns a specified grammar
|
|
14390
|
+
* @param {String} grammarId grammar ID
|
|
14391
|
+
* @param {Object} opts Optional parameters
|
|
14392
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
14393
|
+
* getArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14394
|
+
*/
|
|
14395
|
+
getArchitectGrammar(grammarId, opts) {
|
|
14396
|
+
opts = opts || {};
|
|
14397
|
+
|
|
14398
|
+
// verify the required parameter 'grammarId' is set
|
|
14399
|
+
if (grammarId === undefined || grammarId === null) {
|
|
14400
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammar';
|
|
14401
|
+
}
|
|
14402
|
+
|
|
14403
|
+
return this.apiClient.callApi(
|
|
14404
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
14405
|
+
'GET',
|
|
14406
|
+
{ 'grammarId': grammarId },
|
|
14407
|
+
{ 'includeFileUrls': opts['includeFileUrls'] },
|
|
14408
|
+
{ },
|
|
14409
|
+
{ },
|
|
14410
|
+
null,
|
|
14411
|
+
['PureCloud OAuth'],
|
|
14412
|
+
['application/json'],
|
|
14413
|
+
['application/json']
|
|
14414
|
+
);
|
|
14415
|
+
}
|
|
14416
|
+
|
|
14417
|
+
/**
|
|
14418
|
+
* Get a grammar language.
|
|
14419
|
+
*
|
|
14420
|
+
* @param {String} grammarId Grammar ID
|
|
14421
|
+
* @param {String} languageCode Language
|
|
14422
|
+
* getArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14423
|
+
*/
|
|
14424
|
+
getArchitectGrammarLanguage(grammarId, languageCode) {
|
|
14425
|
+
// verify the required parameter 'grammarId' is set
|
|
14426
|
+
if (grammarId === undefined || grammarId === null) {
|
|
14427
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';
|
|
14428
|
+
}
|
|
14429
|
+
// verify the required parameter 'languageCode' is set
|
|
14430
|
+
if (languageCode === undefined || languageCode === null) {
|
|
14431
|
+
throw 'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';
|
|
14432
|
+
}
|
|
14433
|
+
|
|
14434
|
+
return this.apiClient.callApi(
|
|
14435
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
14436
|
+
'GET',
|
|
14437
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
14438
|
+
{ },
|
|
14439
|
+
{ },
|
|
14440
|
+
{ },
|
|
14441
|
+
null,
|
|
14442
|
+
['PureCloud OAuth'],
|
|
14443
|
+
['application/json'],
|
|
14444
|
+
['application/json']
|
|
14445
|
+
);
|
|
14446
|
+
}
|
|
14447
|
+
|
|
14448
|
+
/**
|
|
14449
|
+
* Get a pageable list of grammars, filtered by query parameters
|
|
14450
|
+
* Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
|
|
14451
|
+
* @param {Object} opts Optional parameters
|
|
14452
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
14453
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
14454
|
+
* @param {Object} opts.sortBy Sort by (default to id)
|
|
14455
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
14456
|
+
* @param {Array.<String>} opts.id ID
|
|
14457
|
+
* @param {String} opts.name Name
|
|
14458
|
+
* @param {String} opts.description Description
|
|
14459
|
+
* @param {String} opts.nameOrDescription Name or description
|
|
14460
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
14461
|
+
* getArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14462
|
+
*/
|
|
14463
|
+
getArchitectGrammars(opts) {
|
|
14464
|
+
opts = opts || {};
|
|
14465
|
+
|
|
14466
|
+
|
|
14467
|
+
return this.apiClient.callApi(
|
|
14468
|
+
'/api/v2/architect/grammars',
|
|
14469
|
+
'GET',
|
|
14470
|
+
{ },
|
|
14471
|
+
{ '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'] },
|
|
14472
|
+
{ },
|
|
14473
|
+
{ },
|
|
14474
|
+
null,
|
|
14475
|
+
['PureCloud OAuth'],
|
|
14476
|
+
['application/json'],
|
|
14477
|
+
['application/json']
|
|
14478
|
+
);
|
|
14479
|
+
}
|
|
14480
|
+
|
|
14237
14481
|
/**
|
|
14238
14482
|
* Get an IVR config.
|
|
14239
14483
|
*
|
|
@@ -14289,6 +14533,36 @@ class ArchitectApi {
|
|
|
14289
14533
|
);
|
|
14290
14534
|
}
|
|
14291
14535
|
|
|
14536
|
+
/**
|
|
14537
|
+
* Get a pageable list of basic ivr configuration information objects filterable by query parameters.
|
|
14538
|
+
*
|
|
14539
|
+
* @param {Object} opts Optional parameters
|
|
14540
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
14541
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
14542
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
14543
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
14544
|
+
* @param {Array.<String>} opts.id ID of the IVR to filter by.
|
|
14545
|
+
* @param {String} opts.name Name of the IVR to filter by.
|
|
14546
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
14547
|
+
*/
|
|
14548
|
+
getArchitectIvrsDivisionviews(opts) {
|
|
14549
|
+
opts = opts || {};
|
|
14550
|
+
|
|
14551
|
+
|
|
14552
|
+
return this.apiClient.callApi(
|
|
14553
|
+
'/api/v2/architect/ivrs/divisionviews',
|
|
14554
|
+
'GET',
|
|
14555
|
+
{ },
|
|
14556
|
+
{ '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') },
|
|
14557
|
+
{ },
|
|
14558
|
+
{ },
|
|
14559
|
+
null,
|
|
14560
|
+
['PureCloud OAuth'],
|
|
14561
|
+
['application/json'],
|
|
14562
|
+
['application/json']
|
|
14563
|
+
);
|
|
14564
|
+
}
|
|
14565
|
+
|
|
14292
14566
|
/**
|
|
14293
14567
|
* Get specified user prompt
|
|
14294
14568
|
*
|
|
@@ -14522,6 +14796,36 @@ class ArchitectApi {
|
|
|
14522
14796
|
);
|
|
14523
14797
|
}
|
|
14524
14798
|
|
|
14799
|
+
/**
|
|
14800
|
+
* Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
|
|
14801
|
+
*
|
|
14802
|
+
* @param {Object} opts Optional parameters
|
|
14803
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
14804
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
14805
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
14806
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
14807
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
14808
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
14809
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
14810
|
+
*/
|
|
14811
|
+
getArchitectSchedulegroupsDivisionviews(opts) {
|
|
14812
|
+
opts = opts || {};
|
|
14813
|
+
|
|
14814
|
+
|
|
14815
|
+
return this.apiClient.callApi(
|
|
14816
|
+
'/api/v2/architect/schedulegroups/divisionviews',
|
|
14817
|
+
'GET',
|
|
14818
|
+
{ },
|
|
14819
|
+
{ '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') },
|
|
14820
|
+
{ },
|
|
14821
|
+
{ },
|
|
14822
|
+
null,
|
|
14823
|
+
['PureCloud OAuth'],
|
|
14824
|
+
['application/json'],
|
|
14825
|
+
['application/json']
|
|
14826
|
+
);
|
|
14827
|
+
}
|
|
14828
|
+
|
|
14525
14829
|
/**
|
|
14526
14830
|
* Get a list of schedules.
|
|
14527
14831
|
*
|
|
@@ -14551,6 +14855,36 @@ class ArchitectApi {
|
|
|
14551
14855
|
);
|
|
14552
14856
|
}
|
|
14553
14857
|
|
|
14858
|
+
/**
|
|
14859
|
+
* Get a pageable list of basic schedule configuration information objects filterable by query parameters.
|
|
14860
|
+
*
|
|
14861
|
+
* @param {Object} opts Optional parameters
|
|
14862
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
14863
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
14864
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
14865
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
14866
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
14867
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
14868
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
14869
|
+
*/
|
|
14870
|
+
getArchitectSchedulesDivisionviews(opts) {
|
|
14871
|
+
opts = opts || {};
|
|
14872
|
+
|
|
14873
|
+
|
|
14874
|
+
return this.apiClient.callApi(
|
|
14875
|
+
'/api/v2/architect/schedules/divisionviews',
|
|
14876
|
+
'GET',
|
|
14877
|
+
{ },
|
|
14878
|
+
{ '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') },
|
|
14879
|
+
{ },
|
|
14880
|
+
{ },
|
|
14881
|
+
null,
|
|
14882
|
+
['PureCloud OAuth'],
|
|
14883
|
+
['application/json'],
|
|
14884
|
+
['application/json']
|
|
14885
|
+
);
|
|
14886
|
+
}
|
|
14887
|
+
|
|
14554
14888
|
/**
|
|
14555
14889
|
* Get a system prompt
|
|
14556
14890
|
*
|
|
@@ -14870,6 +15204,125 @@ class ArchitectApi {
|
|
|
14870
15204
|
);
|
|
14871
15205
|
}
|
|
14872
15206
|
|
|
15207
|
+
/**
|
|
15208
|
+
* Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
|
|
15209
|
+
*
|
|
15210
|
+
* @param {String} flowId Flow ID.
|
|
15211
|
+
* @param {String} versionId Version ID.
|
|
15212
|
+
* @param {Object} opts Optional parameters
|
|
15213
|
+
* @param {Object} opts.language Language to filter for
|
|
15214
|
+
*/
|
|
15215
|
+
getFlowVersionHealth(flowId, versionId, opts) {
|
|
15216
|
+
opts = opts || {};
|
|
15217
|
+
|
|
15218
|
+
// verify the required parameter 'flowId' is set
|
|
15219
|
+
if (flowId === undefined || flowId === null) {
|
|
15220
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionHealth';
|
|
15221
|
+
}
|
|
15222
|
+
// verify the required parameter 'versionId' is set
|
|
15223
|
+
if (versionId === undefined || versionId === null) {
|
|
15224
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionHealth';
|
|
15225
|
+
}
|
|
15226
|
+
|
|
15227
|
+
return this.apiClient.callApi(
|
|
15228
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/health',
|
|
15229
|
+
'GET',
|
|
15230
|
+
{ 'flowId': flowId,'versionId': versionId },
|
|
15231
|
+
{ 'language': opts['language'] },
|
|
15232
|
+
{ },
|
|
15233
|
+
{ },
|
|
15234
|
+
null,
|
|
15235
|
+
['PureCloud OAuth'],
|
|
15236
|
+
['application/json'],
|
|
15237
|
+
['application/json']
|
|
15238
|
+
);
|
|
15239
|
+
}
|
|
15240
|
+
|
|
15241
|
+
/**
|
|
15242
|
+
* Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.
|
|
15243
|
+
*
|
|
15244
|
+
* @param {String} flowId Flow ID.
|
|
15245
|
+
* @param {String} versionId Version ID.
|
|
15246
|
+
* @param {String} intentId Intent ID.
|
|
15247
|
+
* @param {Object} language Language to filter for
|
|
15248
|
+
*/
|
|
15249
|
+
getFlowVersionIntentHealth(flowId, versionId, intentId, language) {
|
|
15250
|
+
// verify the required parameter 'flowId' is set
|
|
15251
|
+
if (flowId === undefined || flowId === null) {
|
|
15252
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentHealth';
|
|
15253
|
+
}
|
|
15254
|
+
// verify the required parameter 'versionId' is set
|
|
15255
|
+
if (versionId === undefined || versionId === null) {
|
|
15256
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentHealth';
|
|
15257
|
+
}
|
|
15258
|
+
// verify the required parameter 'intentId' is set
|
|
15259
|
+
if (intentId === undefined || intentId === null) {
|
|
15260
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentHealth';
|
|
15261
|
+
}
|
|
15262
|
+
// verify the required parameter 'language' is set
|
|
15263
|
+
if (language === undefined || language === null) {
|
|
15264
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentHealth';
|
|
15265
|
+
}
|
|
15266
|
+
|
|
15267
|
+
return this.apiClient.callApi(
|
|
15268
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health',
|
|
15269
|
+
'GET',
|
|
15270
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId },
|
|
15271
|
+
{ 'language': language },
|
|
15272
|
+
{ },
|
|
15273
|
+
{ },
|
|
15274
|
+
null,
|
|
15275
|
+
['PureCloud OAuth'],
|
|
15276
|
+
['application/json'],
|
|
15277
|
+
['application/json']
|
|
15278
|
+
);
|
|
15279
|
+
}
|
|
15280
|
+
|
|
15281
|
+
/**
|
|
15282
|
+
* Get health metrics associated with a specific utterance of an intent.
|
|
15283
|
+
*
|
|
15284
|
+
* @param {String} flowId Flow ID.
|
|
15285
|
+
* @param {String} versionId Version ID.
|
|
15286
|
+
* @param {String} intentId Intent ID.
|
|
15287
|
+
* @param {String} utteranceId Utterance ID.
|
|
15288
|
+
* @param {Object} language Language to filter for
|
|
15289
|
+
*/
|
|
15290
|
+
getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language) {
|
|
15291
|
+
// verify the required parameter 'flowId' is set
|
|
15292
|
+
if (flowId === undefined || flowId === null) {
|
|
15293
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentUtteranceHealth';
|
|
15294
|
+
}
|
|
15295
|
+
// verify the required parameter 'versionId' is set
|
|
15296
|
+
if (versionId === undefined || versionId === null) {
|
|
15297
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentUtteranceHealth';
|
|
15298
|
+
}
|
|
15299
|
+
// verify the required parameter 'intentId' is set
|
|
15300
|
+
if (intentId === undefined || intentId === null) {
|
|
15301
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentUtteranceHealth';
|
|
15302
|
+
}
|
|
15303
|
+
// verify the required parameter 'utteranceId' is set
|
|
15304
|
+
if (utteranceId === undefined || utteranceId === null) {
|
|
15305
|
+
throw 'Missing the required parameter "utteranceId" when calling getFlowVersionIntentUtteranceHealth';
|
|
15306
|
+
}
|
|
15307
|
+
// verify the required parameter 'language' is set
|
|
15308
|
+
if (language === undefined || language === null) {
|
|
15309
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentUtteranceHealth';
|
|
15310
|
+
}
|
|
15311
|
+
|
|
15312
|
+
return this.apiClient.callApi(
|
|
15313
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health',
|
|
15314
|
+
'GET',
|
|
15315
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId,'utteranceId': utteranceId },
|
|
15316
|
+
{ 'language': language },
|
|
15317
|
+
{ },
|
|
15318
|
+
{ },
|
|
15319
|
+
null,
|
|
15320
|
+
['PureCloud OAuth'],
|
|
15321
|
+
['application/json'],
|
|
15322
|
+
['application/json']
|
|
15323
|
+
);
|
|
15324
|
+
}
|
|
15325
|
+
|
|
14873
15326
|
/**
|
|
14874
15327
|
* Get flow version list
|
|
14875
15328
|
*
|
|
@@ -15561,6 +16014,36 @@ class ArchitectApi {
|
|
|
15561
16014
|
);
|
|
15562
16015
|
}
|
|
15563
16016
|
|
|
16017
|
+
/**
|
|
16018
|
+
* Updates a grammar
|
|
16019
|
+
*
|
|
16020
|
+
* @param {String} grammarId grammar ID
|
|
16021
|
+
* @param {Object} opts Optional parameters
|
|
16022
|
+
* @param {Object} opts.body
|
|
16023
|
+
* patchArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16024
|
+
*/
|
|
16025
|
+
patchArchitectGrammar(grammarId, opts) {
|
|
16026
|
+
opts = opts || {};
|
|
16027
|
+
|
|
16028
|
+
// verify the required parameter 'grammarId' is set
|
|
16029
|
+
if (grammarId === undefined || grammarId === null) {
|
|
16030
|
+
throw 'Missing the required parameter "grammarId" when calling patchArchitectGrammar';
|
|
16031
|
+
}
|
|
16032
|
+
|
|
16033
|
+
return this.apiClient.callApi(
|
|
16034
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
16035
|
+
'PATCH',
|
|
16036
|
+
{ 'grammarId': grammarId },
|
|
16037
|
+
{ },
|
|
16038
|
+
{ },
|
|
16039
|
+
{ },
|
|
16040
|
+
opts['body'],
|
|
16041
|
+
['PureCloud OAuth'],
|
|
16042
|
+
['application/json'],
|
|
16043
|
+
['application/json']
|
|
16044
|
+
);
|
|
16045
|
+
}
|
|
16046
|
+
|
|
15564
16047
|
/**
|
|
15565
16048
|
* Rebuild Dependency Tracking data for an organization
|
|
15566
16049
|
* Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
|
@@ -15606,6 +16089,135 @@ class ArchitectApi {
|
|
|
15606
16089
|
);
|
|
15607
16090
|
}
|
|
15608
16091
|
|
|
16092
|
+
/**
|
|
16093
|
+
* Creates a presigned URL for uploading a grammar DTMF mode file
|
|
16094
|
+
*
|
|
16095
|
+
* @param {String} grammarId Grammar ID
|
|
16096
|
+
* @param {String} languageCode Language
|
|
16097
|
+
* @param {Object} body query
|
|
16098
|
+
* postArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16099
|
+
*/
|
|
16100
|
+
postArchitectGrammarLanguageFilesDtmf(grammarId, languageCode, body) {
|
|
16101
|
+
// verify the required parameter 'grammarId' is set
|
|
16102
|
+
if (grammarId === undefined || grammarId === null) {
|
|
16103
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
16104
|
+
}
|
|
16105
|
+
// verify the required parameter 'languageCode' is set
|
|
16106
|
+
if (languageCode === undefined || languageCode === null) {
|
|
16107
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
16108
|
+
}
|
|
16109
|
+
// verify the required parameter 'body' is set
|
|
16110
|
+
if (body === undefined || body === null) {
|
|
16111
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
16112
|
+
}
|
|
16113
|
+
|
|
16114
|
+
return this.apiClient.callApi(
|
|
16115
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
16116
|
+
'POST',
|
|
16117
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
16118
|
+
{ },
|
|
16119
|
+
{ },
|
|
16120
|
+
{ },
|
|
16121
|
+
body,
|
|
16122
|
+
['PureCloud OAuth'],
|
|
16123
|
+
['application/json'],
|
|
16124
|
+
['application/json']
|
|
16125
|
+
);
|
|
16126
|
+
}
|
|
16127
|
+
|
|
16128
|
+
/**
|
|
16129
|
+
* Creates a presigned URL for uploading a grammar voice mode file
|
|
16130
|
+
*
|
|
16131
|
+
* @param {String} grammarId Grammar ID
|
|
16132
|
+
* @param {String} languageCode Language
|
|
16133
|
+
* @param {Object} body query
|
|
16134
|
+
* postArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16135
|
+
*/
|
|
16136
|
+
postArchitectGrammarLanguageFilesVoice(grammarId, languageCode, body) {
|
|
16137
|
+
// verify the required parameter 'grammarId' is set
|
|
16138
|
+
if (grammarId === undefined || grammarId === null) {
|
|
16139
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';
|
|
16140
|
+
}
|
|
16141
|
+
// verify the required parameter 'languageCode' is set
|
|
16142
|
+
if (languageCode === undefined || languageCode === null) {
|
|
16143
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';
|
|
16144
|
+
}
|
|
16145
|
+
// verify the required parameter 'body' is set
|
|
16146
|
+
if (body === undefined || body === null) {
|
|
16147
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';
|
|
16148
|
+
}
|
|
16149
|
+
|
|
16150
|
+
return this.apiClient.callApi(
|
|
16151
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
16152
|
+
'POST',
|
|
16153
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
16154
|
+
{ },
|
|
16155
|
+
{ },
|
|
16156
|
+
{ },
|
|
16157
|
+
body,
|
|
16158
|
+
['PureCloud OAuth'],
|
|
16159
|
+
['application/json'],
|
|
16160
|
+
['application/json']
|
|
16161
|
+
);
|
|
16162
|
+
}
|
|
16163
|
+
|
|
16164
|
+
/**
|
|
16165
|
+
* Create a new language for a given grammar
|
|
16166
|
+
*
|
|
16167
|
+
* @param {String} grammarId Grammar ID
|
|
16168
|
+
* @param {Object} body
|
|
16169
|
+
* postArchitectGrammarLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16170
|
+
*/
|
|
16171
|
+
postArchitectGrammarLanguages(grammarId, body) {
|
|
16172
|
+
// verify the required parameter 'grammarId' is set
|
|
16173
|
+
if (grammarId === undefined || grammarId === null) {
|
|
16174
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';
|
|
16175
|
+
}
|
|
16176
|
+
// verify the required parameter 'body' is set
|
|
16177
|
+
if (body === undefined || body === null) {
|
|
16178
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguages';
|
|
16179
|
+
}
|
|
16180
|
+
|
|
16181
|
+
return this.apiClient.callApi(
|
|
16182
|
+
'/api/v2/architect/grammars/{grammarId}/languages',
|
|
16183
|
+
'POST',
|
|
16184
|
+
{ 'grammarId': grammarId },
|
|
16185
|
+
{ },
|
|
16186
|
+
{ },
|
|
16187
|
+
{ },
|
|
16188
|
+
body,
|
|
16189
|
+
['PureCloud OAuth'],
|
|
16190
|
+
['application/json'],
|
|
16191
|
+
['application/json']
|
|
16192
|
+
);
|
|
16193
|
+
}
|
|
16194
|
+
|
|
16195
|
+
/**
|
|
16196
|
+
* Create a new grammar
|
|
16197
|
+
*
|
|
16198
|
+
* @param {Object} body
|
|
16199
|
+
* postArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16200
|
+
*/
|
|
16201
|
+
postArchitectGrammars(body) {
|
|
16202
|
+
// verify the required parameter 'body' is set
|
|
16203
|
+
if (body === undefined || body === null) {
|
|
16204
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammars';
|
|
16205
|
+
}
|
|
16206
|
+
|
|
16207
|
+
return this.apiClient.callApi(
|
|
16208
|
+
'/api/v2/architect/grammars',
|
|
16209
|
+
'POST',
|
|
16210
|
+
{ },
|
|
16211
|
+
{ },
|
|
16212
|
+
{ },
|
|
16213
|
+
{ },
|
|
16214
|
+
body,
|
|
16215
|
+
['PureCloud OAuth'],
|
|
16216
|
+
['application/json'],
|
|
16217
|
+
['application/json']
|
|
16218
|
+
);
|
|
16219
|
+
}
|
|
16220
|
+
|
|
15609
16221
|
/**
|
|
15610
16222
|
* Create IVR config.
|
|
15611
16223
|
*
|
|
@@ -16699,7 +17311,7 @@ class AuditApi {
|
|
|
16699
17311
|
/**
|
|
16700
17312
|
* Audit service.
|
|
16701
17313
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
16702
|
-
* @version
|
|
17314
|
+
* @version 175.0.0
|
|
16703
17315
|
*/
|
|
16704
17316
|
|
|
16705
17317
|
/**
|
|
@@ -16870,7 +17482,7 @@ class AuthorizationApi {
|
|
|
16870
17482
|
/**
|
|
16871
17483
|
* Authorization service.
|
|
16872
17484
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
16873
|
-
* @version
|
|
17485
|
+
* @version 175.0.0
|
|
16874
17486
|
*/
|
|
16875
17487
|
|
|
16876
17488
|
/**
|
|
@@ -18101,7 +18713,7 @@ class BillingApi {
|
|
|
18101
18713
|
/**
|
|
18102
18714
|
* Billing service.
|
|
18103
18715
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
18104
|
-
* @version
|
|
18716
|
+
* @version 175.0.0
|
|
18105
18717
|
*/
|
|
18106
18718
|
|
|
18107
18719
|
/**
|
|
@@ -18181,7 +18793,7 @@ class CarrierServicesApi {
|
|
|
18181
18793
|
/**
|
|
18182
18794
|
* CarrierServices service.
|
|
18183
18795
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
18184
|
-
* @version
|
|
18796
|
+
* @version 175.0.0
|
|
18185
18797
|
*/
|
|
18186
18798
|
|
|
18187
18799
|
/**
|
|
@@ -18251,7 +18863,7 @@ class ChatApi {
|
|
|
18251
18863
|
/**
|
|
18252
18864
|
* Chat service.
|
|
18253
18865
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18254
|
-
* @version
|
|
18866
|
+
* @version 175.0.0
|
|
18255
18867
|
*/
|
|
18256
18868
|
|
|
18257
18869
|
/**
|
|
@@ -18415,7 +19027,7 @@ class CoachingApi {
|
|
|
18415
19027
|
/**
|
|
18416
19028
|
* Coaching service.
|
|
18417
19029
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
18418
|
-
* @version
|
|
19030
|
+
* @version 175.0.0
|
|
18419
19031
|
*/
|
|
18420
19032
|
|
|
18421
19033
|
/**
|
|
@@ -18992,7 +19604,7 @@ class ContentManagementApi {
|
|
|
18992
19604
|
/**
|
|
18993
19605
|
* ContentManagement service.
|
|
18994
19606
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
18995
|
-
* @version
|
|
19607
|
+
* @version 175.0.0
|
|
18996
19608
|
*/
|
|
18997
19609
|
|
|
18998
19610
|
/**
|
|
@@ -20135,7 +20747,7 @@ class ConversationsApi {
|
|
|
20135
20747
|
/**
|
|
20136
20748
|
* Conversations service.
|
|
20137
20749
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
20138
|
-
* @version
|
|
20750
|
+
* @version 175.0.0
|
|
20139
20751
|
*/
|
|
20140
20752
|
|
|
20141
20753
|
/**
|
|
@@ -20300,6 +20912,31 @@ class ConversationsApi {
|
|
|
20300
20912
|
);
|
|
20301
20913
|
}
|
|
20302
20914
|
|
|
20915
|
+
/**
|
|
20916
|
+
* Remove a cached media item asychronously
|
|
20917
|
+
*
|
|
20918
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
20919
|
+
*/
|
|
20920
|
+
deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
20921
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
20922
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
20923
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';
|
|
20924
|
+
}
|
|
20925
|
+
|
|
20926
|
+
return this.apiClient.callApi(
|
|
20927
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
20928
|
+
'DELETE',
|
|
20929
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
20930
|
+
{ },
|
|
20931
|
+
{ },
|
|
20932
|
+
{ },
|
|
20933
|
+
null,
|
|
20934
|
+
['PureCloud OAuth'],
|
|
20935
|
+
['application/json'],
|
|
20936
|
+
['application/json']
|
|
20937
|
+
);
|
|
20938
|
+
}
|
|
20939
|
+
|
|
20303
20940
|
/**
|
|
20304
20941
|
* Delete a Facebook messaging integration
|
|
20305
20942
|
*
|
|
@@ -22101,7 +22738,7 @@ class ConversationsApi {
|
|
|
22101
22738
|
/**
|
|
22102
22739
|
* Get list of wrapup codes for this conversation participant
|
|
22103
22740
|
*
|
|
22104
|
-
* @param {String} conversationId
|
|
22741
|
+
* @param {String} conversationId conversationId
|
|
22105
22742
|
* @param {String} participantId participantId
|
|
22106
22743
|
*/
|
|
22107
22744
|
getConversationsMessageParticipantWrapupcodes(conversationId, participantId) {
|
|
@@ -22148,6 +22785,57 @@ class ConversationsApi {
|
|
|
22148
22785
|
);
|
|
22149
22786
|
}
|
|
22150
22787
|
|
|
22788
|
+
/**
|
|
22789
|
+
* Get a list of cached media items
|
|
22790
|
+
*
|
|
22791
|
+
* @param {Object} opts Optional parameters
|
|
22792
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
22793
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
22794
|
+
* @param {String} opts.url URL to search for
|
|
22795
|
+
*/
|
|
22796
|
+
getConversationsMessagesCachedmedia(opts) {
|
|
22797
|
+
opts = opts || {};
|
|
22798
|
+
|
|
22799
|
+
|
|
22800
|
+
return this.apiClient.callApi(
|
|
22801
|
+
'/api/v2/conversations/messages/cachedmedia',
|
|
22802
|
+
'GET',
|
|
22803
|
+
{ },
|
|
22804
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'url': opts['url'] },
|
|
22805
|
+
{ },
|
|
22806
|
+
{ },
|
|
22807
|
+
null,
|
|
22808
|
+
['PureCloud OAuth'],
|
|
22809
|
+
['application/json'],
|
|
22810
|
+
['application/json']
|
|
22811
|
+
);
|
|
22812
|
+
}
|
|
22813
|
+
|
|
22814
|
+
/**
|
|
22815
|
+
* Get a cached media item
|
|
22816
|
+
*
|
|
22817
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
22818
|
+
*/
|
|
22819
|
+
getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
22820
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
22821
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
22822
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';
|
|
22823
|
+
}
|
|
22824
|
+
|
|
22825
|
+
return this.apiClient.callApi(
|
|
22826
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
22827
|
+
'GET',
|
|
22828
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
22829
|
+
{ },
|
|
22830
|
+
{ },
|
|
22831
|
+
{ },
|
|
22832
|
+
null,
|
|
22833
|
+
['PureCloud OAuth'],
|
|
22834
|
+
['application/json'],
|
|
22835
|
+
['application/json']
|
|
22836
|
+
);
|
|
22837
|
+
}
|
|
22838
|
+
|
|
22151
22839
|
/**
|
|
22152
22840
|
* Get Genesys Facebook App Id
|
|
22153
22841
|
*
|
|
@@ -22891,6 +23579,32 @@ class ConversationsApi {
|
|
|
22891
23579
|
);
|
|
22892
23580
|
}
|
|
22893
23581
|
|
|
23582
|
+
/**
|
|
23583
|
+
* Gets a record for a given meetingId
|
|
23584
|
+
*
|
|
23585
|
+
* @param {String} meetingId meetingId
|
|
23586
|
+
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23587
|
+
*/
|
|
23588
|
+
getConversationsVideosMeeting(meetingId) {
|
|
23589
|
+
// verify the required parameter 'meetingId' is set
|
|
23590
|
+
if (meetingId === undefined || meetingId === null) {
|
|
23591
|
+
throw 'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';
|
|
23592
|
+
}
|
|
23593
|
+
|
|
23594
|
+
return this.apiClient.callApi(
|
|
23595
|
+
'/api/v2/conversations/videos/meetings/{meetingId}',
|
|
23596
|
+
'GET',
|
|
23597
|
+
{ 'meetingId': meetingId },
|
|
23598
|
+
{ },
|
|
23599
|
+
{ },
|
|
23600
|
+
{ },
|
|
23601
|
+
null,
|
|
23602
|
+
['PureCloud OAuth'],
|
|
23603
|
+
['application/json'],
|
|
23604
|
+
['application/json']
|
|
23605
|
+
);
|
|
23606
|
+
}
|
|
23607
|
+
|
|
22894
23608
|
/**
|
|
22895
23609
|
* Update a participant.
|
|
22896
23610
|
* Update conversation participant.
|
|
@@ -23853,7 +24567,7 @@ class ConversationsApi {
|
|
|
23853
24567
|
/**
|
|
23854
24568
|
* Update conversation participant
|
|
23855
24569
|
*
|
|
23856
|
-
* @param {String} conversationId
|
|
24570
|
+
* @param {String} conversationId conversationId
|
|
23857
24571
|
* @param {String} participantId participantId
|
|
23858
24572
|
* @param {Object} opts Optional parameters
|
|
23859
24573
|
* @param {Object} opts.body
|
|
@@ -23887,7 +24601,7 @@ class ConversationsApi {
|
|
|
23887
24601
|
/**
|
|
23888
24602
|
* Update the attributes on a conversation participant.
|
|
23889
24603
|
*
|
|
23890
|
-
* @param {String} conversationId
|
|
24604
|
+
* @param {String} conversationId conversationId
|
|
23891
24605
|
* @param {String} participantId participantId
|
|
23892
24606
|
* @param {Object} opts Optional parameters
|
|
23893
24607
|
* @param {Object} opts.body
|
|
@@ -23921,7 +24635,7 @@ class ConversationsApi {
|
|
|
23921
24635
|
/**
|
|
23922
24636
|
* Update conversation participant's communication by disconnecting it.
|
|
23923
24637
|
*
|
|
23924
|
-
* @param {String} conversationId
|
|
24638
|
+
* @param {String} conversationId conversationId
|
|
23925
24639
|
* @param {String} participantId participantId
|
|
23926
24640
|
* @param {String} communicationId communicationId
|
|
23927
24641
|
* @param {Object} body Participant
|
|
@@ -25878,6 +26592,96 @@ class ConversationsApi {
|
|
|
25878
26592
|
);
|
|
25879
26593
|
}
|
|
25880
26594
|
|
|
26595
|
+
/**
|
|
26596
|
+
* Send an inbound Open Event Message
|
|
26597
|
+
* 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.
|
|
26598
|
+
* @param {String} integrationId integrationId
|
|
26599
|
+
* @param {Object} body NormalizedMessage
|
|
26600
|
+
*/
|
|
26601
|
+
postConversationsMessageInboundOpenEvent(integrationId, body) {
|
|
26602
|
+
// verify the required parameter 'integrationId' is set
|
|
26603
|
+
if (integrationId === undefined || integrationId === null) {
|
|
26604
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';
|
|
26605
|
+
}
|
|
26606
|
+
// verify the required parameter 'body' is set
|
|
26607
|
+
if (body === undefined || body === null) {
|
|
26608
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';
|
|
26609
|
+
}
|
|
26610
|
+
|
|
26611
|
+
return this.apiClient.callApi(
|
|
26612
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/event',
|
|
26613
|
+
'POST',
|
|
26614
|
+
{ 'integrationId': integrationId },
|
|
26615
|
+
{ },
|
|
26616
|
+
{ },
|
|
26617
|
+
{ },
|
|
26618
|
+
body,
|
|
26619
|
+
['PureCloud OAuth'],
|
|
26620
|
+
['application/json'],
|
|
26621
|
+
['application/json']
|
|
26622
|
+
);
|
|
26623
|
+
}
|
|
26624
|
+
|
|
26625
|
+
/**
|
|
26626
|
+
* Send inbound Open Message
|
|
26627
|
+
* 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.
|
|
26628
|
+
* @param {String} integrationId integrationId
|
|
26629
|
+
* @param {Object} body NormalizedMessage
|
|
26630
|
+
*/
|
|
26631
|
+
postConversationsMessageInboundOpenMessage(integrationId, body) {
|
|
26632
|
+
// verify the required parameter 'integrationId' is set
|
|
26633
|
+
if (integrationId === undefined || integrationId === null) {
|
|
26634
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
|
|
26635
|
+
}
|
|
26636
|
+
// verify the required parameter 'body' is set
|
|
26637
|
+
if (body === undefined || body === null) {
|
|
26638
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';
|
|
26639
|
+
}
|
|
26640
|
+
|
|
26641
|
+
return this.apiClient.callApi(
|
|
26642
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/message',
|
|
26643
|
+
'POST',
|
|
26644
|
+
{ 'integrationId': integrationId },
|
|
26645
|
+
{ },
|
|
26646
|
+
{ },
|
|
26647
|
+
{ },
|
|
26648
|
+
body,
|
|
26649
|
+
['PureCloud OAuth'],
|
|
26650
|
+
['application/json'],
|
|
26651
|
+
['application/json']
|
|
26652
|
+
);
|
|
26653
|
+
}
|
|
26654
|
+
|
|
26655
|
+
/**
|
|
26656
|
+
* Send an inbound Open Receipt Message
|
|
26657
|
+
* 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.
|
|
26658
|
+
* @param {String} integrationId integrationId
|
|
26659
|
+
* @param {Object} body NormalizedMessage
|
|
26660
|
+
*/
|
|
26661
|
+
postConversationsMessageInboundOpenReceipt(integrationId, body) {
|
|
26662
|
+
// verify the required parameter 'integrationId' is set
|
|
26663
|
+
if (integrationId === undefined || integrationId === null) {
|
|
26664
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';
|
|
26665
|
+
}
|
|
26666
|
+
// verify the required parameter 'body' is set
|
|
26667
|
+
if (body === undefined || body === null) {
|
|
26668
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';
|
|
26669
|
+
}
|
|
26670
|
+
|
|
26671
|
+
return this.apiClient.callApi(
|
|
26672
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/receipt',
|
|
26673
|
+
'POST',
|
|
26674
|
+
{ 'integrationId': integrationId },
|
|
26675
|
+
{ },
|
|
26676
|
+
{ },
|
|
26677
|
+
{ },
|
|
26678
|
+
body,
|
|
26679
|
+
['PureCloud OAuth'],
|
|
26680
|
+
['application/json'],
|
|
26681
|
+
['application/json']
|
|
26682
|
+
);
|
|
26683
|
+
}
|
|
26684
|
+
|
|
25881
26685
|
/**
|
|
25882
26686
|
* Get messages in batch
|
|
25883
26687
|
* 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"]
|
|
@@ -26361,24 +27165,63 @@ class ConversationsApi {
|
|
|
26361
27165
|
* @param {Object} opts Optional parameters
|
|
26362
27166
|
* @param {Object} opts.body Wrap-up
|
|
26363
27167
|
*/
|
|
26364
|
-
postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
27168
|
+
postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
27169
|
+
opts = opts || {};
|
|
27170
|
+
|
|
27171
|
+
// verify the required parameter 'conversationId' is set
|
|
27172
|
+
if (conversationId === undefined || conversationId === null) {
|
|
27173
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
27174
|
+
}
|
|
27175
|
+
// verify the required parameter 'participantId' is set
|
|
27176
|
+
if (participantId === undefined || participantId === null) {
|
|
27177
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
27178
|
+
}
|
|
27179
|
+
// verify the required parameter 'communicationId' is set
|
|
27180
|
+
if (communicationId === undefined || communicationId === null) {
|
|
27181
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
27182
|
+
}
|
|
27183
|
+
|
|
27184
|
+
return this.apiClient.callApi(
|
|
27185
|
+
'/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup',
|
|
27186
|
+
'POST',
|
|
27187
|
+
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
27188
|
+
{ },
|
|
27189
|
+
{ },
|
|
27190
|
+
{ },
|
|
27191
|
+
opts['body'],
|
|
27192
|
+
['PureCloud OAuth'],
|
|
27193
|
+
['application/json'],
|
|
27194
|
+
['application/json']
|
|
27195
|
+
);
|
|
27196
|
+
}
|
|
27197
|
+
|
|
27198
|
+
/**
|
|
27199
|
+
* Apply wrap-up for this conversation communication
|
|
27200
|
+
*
|
|
27201
|
+
* @param {String} conversationId conversationId
|
|
27202
|
+
* @param {String} participantId participantId
|
|
27203
|
+
* @param {String} communicationId communicationId
|
|
27204
|
+
* @param {Object} opts Optional parameters
|
|
27205
|
+
* @param {Object} opts.body Wrap-up
|
|
27206
|
+
*/
|
|
27207
|
+
postConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
26365
27208
|
opts = opts || {};
|
|
26366
27209
|
|
|
26367
27210
|
// verify the required parameter 'conversationId' is set
|
|
26368
27211
|
if (conversationId === undefined || conversationId === null) {
|
|
26369
|
-
throw 'Missing the required parameter "conversationId" when calling
|
|
27212
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
26370
27213
|
}
|
|
26371
27214
|
// verify the required parameter 'participantId' is set
|
|
26372
27215
|
if (participantId === undefined || participantId === null) {
|
|
26373
|
-
throw 'Missing the required parameter "participantId" when calling
|
|
27216
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
26374
27217
|
}
|
|
26375
27218
|
// verify the required parameter 'communicationId' is set
|
|
26376
27219
|
if (communicationId === undefined || communicationId === null) {
|
|
26377
|
-
throw 'Missing the required parameter "communicationId" when calling
|
|
27220
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
26378
27221
|
}
|
|
26379
27222
|
|
|
26380
27223
|
return this.apiClient.callApi(
|
|
26381
|
-
'/api/v2/conversations/
|
|
27224
|
+
'/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup',
|
|
26382
27225
|
'POST',
|
|
26383
27226
|
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
26384
27227
|
{ },
|
|
@@ -26392,38 +27235,25 @@ class ConversationsApi {
|
|
|
26392
27235
|
}
|
|
26393
27236
|
|
|
26394
27237
|
/**
|
|
26395
|
-
*
|
|
27238
|
+
* Generate a meetingId for a given conferenceId
|
|
26396
27239
|
*
|
|
26397
|
-
* @param {
|
|
26398
|
-
*
|
|
26399
|
-
* @param {String} communicationId communicationId
|
|
26400
|
-
* @param {Object} opts Optional parameters
|
|
26401
|
-
* @param {Object} opts.body Wrap-up
|
|
27240
|
+
* @param {Object} body MeetingIdRequest
|
|
27241
|
+
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26402
27242
|
*/
|
|
26403
|
-
|
|
26404
|
-
|
|
26405
|
-
|
|
26406
|
-
|
|
26407
|
-
if (conversationId === undefined || conversationId === null) {
|
|
26408
|
-
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
26409
|
-
}
|
|
26410
|
-
// verify the required parameter 'participantId' is set
|
|
26411
|
-
if (participantId === undefined || participantId === null) {
|
|
26412
|
-
throw 'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
26413
|
-
}
|
|
26414
|
-
// verify the required parameter 'communicationId' is set
|
|
26415
|
-
if (communicationId === undefined || communicationId === null) {
|
|
26416
|
-
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
27243
|
+
postConversationsVideosMeetings(body) {
|
|
27244
|
+
// verify the required parameter 'body' is set
|
|
27245
|
+
if (body === undefined || body === null) {
|
|
27246
|
+
throw 'Missing the required parameter "body" when calling postConversationsVideosMeetings';
|
|
26417
27247
|
}
|
|
26418
27248
|
|
|
26419
27249
|
return this.apiClient.callApi(
|
|
26420
|
-
'/api/v2/conversations/videos/
|
|
27250
|
+
'/api/v2/conversations/videos/meetings',
|
|
26421
27251
|
'POST',
|
|
26422
|
-
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
26423
27252
|
{ },
|
|
26424
27253
|
{ },
|
|
26425
27254
|
{ },
|
|
26426
|
-
|
|
27255
|
+
{ },
|
|
27256
|
+
body,
|
|
26427
27257
|
['PureCloud OAuth'],
|
|
26428
27258
|
['application/json'],
|
|
26429
27259
|
['application/json']
|
|
@@ -27001,7 +27831,7 @@ class DataExtensionsApi {
|
|
|
27001
27831
|
/**
|
|
27002
27832
|
* DataExtensions service.
|
|
27003
27833
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
27004
|
-
* @version
|
|
27834
|
+
* @version 175.0.0
|
|
27005
27835
|
*/
|
|
27006
27836
|
|
|
27007
27837
|
/**
|
|
@@ -27087,7 +27917,7 @@ class DownloadsApi {
|
|
|
27087
27917
|
/**
|
|
27088
27918
|
* Downloads service.
|
|
27089
27919
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
27090
|
-
* @version
|
|
27920
|
+
* @version 175.0.0
|
|
27091
27921
|
*/
|
|
27092
27922
|
|
|
27093
27923
|
/**
|
|
@@ -27139,7 +27969,7 @@ class EmailsApi {
|
|
|
27139
27969
|
/**
|
|
27140
27970
|
* Emails service.
|
|
27141
27971
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
27142
|
-
* @version
|
|
27972
|
+
* @version 175.0.0
|
|
27143
27973
|
*/
|
|
27144
27974
|
|
|
27145
27975
|
/**
|
|
@@ -27204,7 +28034,7 @@ class EventsApi {
|
|
|
27204
28034
|
/**
|
|
27205
28035
|
* Events service.
|
|
27206
28036
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
27207
|
-
* @version
|
|
28037
|
+
* @version 175.0.0
|
|
27208
28038
|
*/
|
|
27209
28039
|
|
|
27210
28040
|
/**
|
|
@@ -27300,7 +28130,7 @@ class ExternalContactsApi {
|
|
|
27300
28130
|
/**
|
|
27301
28131
|
* ExternalContacts service.
|
|
27302
28132
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
27303
|
-
* @version
|
|
28133
|
+
* @version 175.0.0
|
|
27304
28134
|
*/
|
|
27305
28135
|
|
|
27306
28136
|
/**
|
|
@@ -29258,7 +30088,7 @@ class FaxApi {
|
|
|
29258
30088
|
/**
|
|
29259
30089
|
* Fax service.
|
|
29260
30090
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29261
|
-
* @version
|
|
30091
|
+
* @version 175.0.0
|
|
29262
30092
|
*/
|
|
29263
30093
|
|
|
29264
30094
|
/**
|
|
@@ -29429,7 +30259,7 @@ class FlowsApi {
|
|
|
29429
30259
|
/**
|
|
29430
30260
|
* Flows service.
|
|
29431
30261
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
29432
|
-
* @version
|
|
30262
|
+
* @version 175.0.0
|
|
29433
30263
|
*/
|
|
29434
30264
|
|
|
29435
30265
|
/**
|
|
@@ -29613,7 +30443,7 @@ class GamificationApi {
|
|
|
29613
30443
|
/**
|
|
29614
30444
|
* Gamification service.
|
|
29615
30445
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
29616
|
-
* @version
|
|
30446
|
+
* @version 175.0.0
|
|
29617
30447
|
*/
|
|
29618
30448
|
|
|
29619
30449
|
/**
|
|
@@ -31699,7 +32529,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
31699
32529
|
/**
|
|
31700
32530
|
* GeneralDataProtectionRegulation service.
|
|
31701
32531
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
31702
|
-
* @version
|
|
32532
|
+
* @version 175.0.0
|
|
31703
32533
|
*/
|
|
31704
32534
|
|
|
31705
32535
|
/**
|
|
@@ -31829,7 +32659,7 @@ class GeolocationApi {
|
|
|
31829
32659
|
/**
|
|
31830
32660
|
* Geolocation service.
|
|
31831
32661
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
31832
|
-
* @version
|
|
32662
|
+
* @version 175.0.0
|
|
31833
32663
|
*/
|
|
31834
32664
|
|
|
31835
32665
|
/**
|
|
@@ -31960,7 +32790,7 @@ class GreetingsApi {
|
|
|
31960
32790
|
/**
|
|
31961
32791
|
* Greetings service.
|
|
31962
32792
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
31963
|
-
* @version
|
|
32793
|
+
* @version 175.0.0
|
|
31964
32794
|
*/
|
|
31965
32795
|
|
|
31966
32796
|
/**
|
|
@@ -32415,7 +33245,7 @@ class GroupsApi {
|
|
|
32415
33245
|
/**
|
|
32416
33246
|
* Groups service.
|
|
32417
33247
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
32418
|
-
* @version
|
|
33248
|
+
* @version 175.0.0
|
|
32419
33249
|
*/
|
|
32420
33250
|
|
|
32421
33251
|
/**
|
|
@@ -32934,7 +33764,7 @@ class IdentityProviderApi {
|
|
|
32934
33764
|
/**
|
|
32935
33765
|
* IdentityProvider service.
|
|
32936
33766
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
32937
|
-
* @version
|
|
33767
|
+
* @version 175.0.0
|
|
32938
33768
|
*/
|
|
32939
33769
|
|
|
32940
33770
|
/**
|
|
@@ -33690,7 +34520,7 @@ class InfrastructureAsCodeApi {
|
|
|
33690
34520
|
/**
|
|
33691
34521
|
* InfrastructureAsCode service.
|
|
33692
34522
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
33693
|
-
* @version
|
|
34523
|
+
* @version 175.0.0
|
|
33694
34524
|
*/
|
|
33695
34525
|
|
|
33696
34526
|
/**
|
|
@@ -33857,7 +34687,7 @@ class IntegrationsApi {
|
|
|
33857
34687
|
/**
|
|
33858
34688
|
* Integrations service.
|
|
33859
34689
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
33860
|
-
* @version
|
|
34690
|
+
* @version 175.0.0
|
|
33861
34691
|
*/
|
|
33862
34692
|
|
|
33863
34693
|
/**
|
|
@@ -35819,7 +36649,7 @@ class JourneyApi {
|
|
|
35819
36649
|
/**
|
|
35820
36650
|
* Journey service.
|
|
35821
36651
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
35822
|
-
* @version
|
|
36652
|
+
* @version 175.0.0
|
|
35823
36653
|
*/
|
|
35824
36654
|
|
|
35825
36655
|
/**
|
|
@@ -36019,6 +36849,37 @@ class JourneyApi {
|
|
|
36019
36849
|
);
|
|
36020
36850
|
}
|
|
36021
36851
|
|
|
36852
|
+
/**
|
|
36853
|
+
* Retrieve all sessions for a given external contact.
|
|
36854
|
+
*
|
|
36855
|
+
* @param {String} contactId ExternalContact ID
|
|
36856
|
+
* @param {Object} opts Optional parameters
|
|
36857
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
36858
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
36859
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
36860
|
+
*/
|
|
36861
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
36862
|
+
opts = opts || {};
|
|
36863
|
+
|
|
36864
|
+
// verify the required parameter 'contactId' is set
|
|
36865
|
+
if (contactId === undefined || contactId === null) {
|
|
36866
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
36867
|
+
}
|
|
36868
|
+
|
|
36869
|
+
return this.apiClient.callApi(
|
|
36870
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
36871
|
+
'GET',
|
|
36872
|
+
{ 'contactId': contactId },
|
|
36873
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
36874
|
+
{ },
|
|
36875
|
+
{ },
|
|
36876
|
+
null,
|
|
36877
|
+
['PureCloud OAuth'],
|
|
36878
|
+
['application/json'],
|
|
36879
|
+
['application/json']
|
|
36880
|
+
);
|
|
36881
|
+
}
|
|
36882
|
+
|
|
36022
36883
|
/**
|
|
36023
36884
|
* Retrieve a single action map.
|
|
36024
36885
|
*
|
|
@@ -36819,6 +37680,36 @@ class JourneyApi {
|
|
|
36819
37680
|
);
|
|
36820
37681
|
}
|
|
36821
37682
|
|
|
37683
|
+
/**
|
|
37684
|
+
* Send a journey app event, used for tracking customer activity on an application.
|
|
37685
|
+
*
|
|
37686
|
+
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
37687
|
+
* @param {Object} opts Optional parameters
|
|
37688
|
+
* @param {Object} opts.body
|
|
37689
|
+
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37690
|
+
*/
|
|
37691
|
+
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
37692
|
+
opts = opts || {};
|
|
37693
|
+
|
|
37694
|
+
// verify the required parameter 'deploymentId' is set
|
|
37695
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
37696
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';
|
|
37697
|
+
}
|
|
37698
|
+
|
|
37699
|
+
return this.apiClient.callApi(
|
|
37700
|
+
'/api/v2/journey/deployments/{deploymentId}/appevents',
|
|
37701
|
+
'POST',
|
|
37702
|
+
{ 'deploymentId': deploymentId },
|
|
37703
|
+
{ },
|
|
37704
|
+
{ },
|
|
37705
|
+
{ },
|
|
37706
|
+
opts['body'],
|
|
37707
|
+
['PureCloud OAuth'],
|
|
37708
|
+
['application/json'],
|
|
37709
|
+
['application/json']
|
|
37710
|
+
);
|
|
37711
|
+
}
|
|
37712
|
+
|
|
36822
37713
|
/**
|
|
36823
37714
|
* Create an outcome.
|
|
36824
37715
|
*
|
|
@@ -36922,7 +37813,7 @@ class KnowledgeApi {
|
|
|
36922
37813
|
/**
|
|
36923
37814
|
* Knowledge service.
|
|
36924
37815
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
36925
|
-
* @version
|
|
37816
|
+
* @version 175.0.0
|
|
36926
37817
|
*/
|
|
36927
37818
|
|
|
36928
37819
|
/**
|
|
@@ -37479,6 +38370,85 @@ class KnowledgeApi {
|
|
|
37479
38370
|
);
|
|
37480
38371
|
}
|
|
37481
38372
|
|
|
38373
|
+
/**
|
|
38374
|
+
* Get a list of feedback records given on a document
|
|
38375
|
+
*
|
|
38376
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
38377
|
+
* @param {String} documentId Document ID.
|
|
38378
|
+
* @param {Object} opts Optional parameters
|
|
38379
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
38380
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
38381
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
38382
|
+
* @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.
|
|
38383
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
38384
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
38385
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
38386
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
38387
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
38388
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
38389
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
38390
|
+
*/
|
|
38391
|
+
getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
38392
|
+
opts = opts || {};
|
|
38393
|
+
|
|
38394
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
38395
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
38396
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
38397
|
+
}
|
|
38398
|
+
// verify the required parameter 'documentId' is set
|
|
38399
|
+
if (documentId === undefined || documentId === null) {
|
|
38400
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
38401
|
+
}
|
|
38402
|
+
|
|
38403
|
+
return this.apiClient.callApi(
|
|
38404
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
38405
|
+
'GET',
|
|
38406
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
38407
|
+
{ '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'] },
|
|
38408
|
+
{ },
|
|
38409
|
+
{ },
|
|
38410
|
+
null,
|
|
38411
|
+
['PureCloud OAuth'],
|
|
38412
|
+
['application/json'],
|
|
38413
|
+
['application/json']
|
|
38414
|
+
);
|
|
38415
|
+
}
|
|
38416
|
+
|
|
38417
|
+
/**
|
|
38418
|
+
* Get a single feedback record given on a document
|
|
38419
|
+
*
|
|
38420
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
38421
|
+
* @param {String} documentId Document ID.
|
|
38422
|
+
* @param {String} feedbackId Feedback ID.
|
|
38423
|
+
*/
|
|
38424
|
+
getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId) {
|
|
38425
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
38426
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
38427
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
38428
|
+
}
|
|
38429
|
+
// verify the required parameter 'documentId' is set
|
|
38430
|
+
if (documentId === undefined || documentId === null) {
|
|
38431
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
38432
|
+
}
|
|
38433
|
+
// verify the required parameter 'feedbackId' is set
|
|
38434
|
+
if (feedbackId === undefined || feedbackId === null) {
|
|
38435
|
+
throw 'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
38436
|
+
}
|
|
38437
|
+
|
|
38438
|
+
return this.apiClient.callApi(
|
|
38439
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
|
|
38440
|
+
'GET',
|
|
38441
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
|
|
38442
|
+
{ },
|
|
38443
|
+
{ },
|
|
38444
|
+
{ },
|
|
38445
|
+
null,
|
|
38446
|
+
['PureCloud OAuth'],
|
|
38447
|
+
['application/json'],
|
|
38448
|
+
['application/json']
|
|
38449
|
+
);
|
|
38450
|
+
}
|
|
38451
|
+
|
|
37482
38452
|
/**
|
|
37483
38453
|
* Get a variation for a document.
|
|
37484
38454
|
*
|
|
@@ -37786,8 +38756,12 @@ class KnowledgeApi {
|
|
|
37786
38756
|
*
|
|
37787
38757
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
37788
38758
|
* @param {String} importJobId Import job ID
|
|
38759
|
+
* @param {Object} opts Optional parameters
|
|
38760
|
+
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
37789
38761
|
*/
|
|
37790
|
-
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
38762
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, opts) {
|
|
38763
|
+
opts = opts || {};
|
|
38764
|
+
|
|
37791
38765
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
37792
38766
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
37793
38767
|
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
@@ -37801,7 +38775,7 @@ class KnowledgeApi {
|
|
|
37801
38775
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
37802
38776
|
'GET',
|
|
37803
38777
|
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
37804
|
-
{
|
|
38778
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
37805
38779
|
{ },
|
|
37806
38780
|
{ },
|
|
37807
38781
|
null,
|
|
@@ -38824,6 +39798,40 @@ class KnowledgeApi {
|
|
|
38824
39798
|
);
|
|
38825
39799
|
}
|
|
38826
39800
|
|
|
39801
|
+
/**
|
|
39802
|
+
* Give feedback on a document
|
|
39803
|
+
*
|
|
39804
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
39805
|
+
* @param {String} documentId Document ID.
|
|
39806
|
+
* @param {Object} opts Optional parameters
|
|
39807
|
+
* @param {Object} opts.body
|
|
39808
|
+
*/
|
|
39809
|
+
postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, opts) {
|
|
39810
|
+
opts = opts || {};
|
|
39811
|
+
|
|
39812
|
+
// verify the required parameter 'sessionId' is set
|
|
39813
|
+
if (sessionId === undefined || sessionId === null) {
|
|
39814
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
39815
|
+
}
|
|
39816
|
+
// verify the required parameter 'documentId' is set
|
|
39817
|
+
if (documentId === undefined || documentId === null) {
|
|
39818
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
39819
|
+
}
|
|
39820
|
+
|
|
39821
|
+
return this.apiClient.callApi(
|
|
39822
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback',
|
|
39823
|
+
'POST',
|
|
39824
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
39825
|
+
{ },
|
|
39826
|
+
{ },
|
|
39827
|
+
{ },
|
|
39828
|
+
opts['body'],
|
|
39829
|
+
['PureCloud OAuth'],
|
|
39830
|
+
['application/json'],
|
|
39831
|
+
['application/json']
|
|
39832
|
+
);
|
|
39833
|
+
}
|
|
39834
|
+
|
|
38827
39835
|
/**
|
|
38828
39836
|
* Search the documents in a guest session.
|
|
38829
39837
|
*
|
|
@@ -38938,6 +39946,40 @@ class KnowledgeApi {
|
|
|
38938
39946
|
);
|
|
38939
39947
|
}
|
|
38940
39948
|
|
|
39949
|
+
/**
|
|
39950
|
+
* Give feedback on a document
|
|
39951
|
+
*
|
|
39952
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
39953
|
+
* @param {String} documentId Document ID.
|
|
39954
|
+
* @param {Object} opts Optional parameters
|
|
39955
|
+
* @param {Object} opts.body
|
|
39956
|
+
*/
|
|
39957
|
+
postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
39958
|
+
opts = opts || {};
|
|
39959
|
+
|
|
39960
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
39961
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
39962
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
39963
|
+
}
|
|
39964
|
+
// verify the required parameter 'documentId' is set
|
|
39965
|
+
if (documentId === undefined || documentId === null) {
|
|
39966
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
39967
|
+
}
|
|
39968
|
+
|
|
39969
|
+
return this.apiClient.callApi(
|
|
39970
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
39971
|
+
'POST',
|
|
39972
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
39973
|
+
{ },
|
|
39974
|
+
{ },
|
|
39975
|
+
{ },
|
|
39976
|
+
opts['body'],
|
|
39977
|
+
['PureCloud OAuth'],
|
|
39978
|
+
['application/json'],
|
|
39979
|
+
['application/json']
|
|
39980
|
+
);
|
|
39981
|
+
}
|
|
39982
|
+
|
|
38941
39983
|
/**
|
|
38942
39984
|
* Create a variation for a document.
|
|
38943
39985
|
*
|
|
@@ -39008,6 +40050,40 @@ class KnowledgeApi {
|
|
|
39008
40050
|
);
|
|
39009
40051
|
}
|
|
39010
40052
|
|
|
40053
|
+
/**
|
|
40054
|
+
* Create view for a document.
|
|
40055
|
+
*
|
|
40056
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
40057
|
+
* @param {String} documentId Document ID.
|
|
40058
|
+
* @param {Object} opts Optional parameters
|
|
40059
|
+
* @param {Object} opts.body
|
|
40060
|
+
*/
|
|
40061
|
+
postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, opts) {
|
|
40062
|
+
opts = opts || {};
|
|
40063
|
+
|
|
40064
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
40065
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
40066
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
40067
|
+
}
|
|
40068
|
+
// verify the required parameter 'documentId' is set
|
|
40069
|
+
if (documentId === undefined || documentId === null) {
|
|
40070
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
40071
|
+
}
|
|
40072
|
+
|
|
40073
|
+
return this.apiClient.callApi(
|
|
40074
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views',
|
|
40075
|
+
'POST',
|
|
40076
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
40077
|
+
{ },
|
|
40078
|
+
{ },
|
|
40079
|
+
{ },
|
|
40080
|
+
opts['body'],
|
|
40081
|
+
['PureCloud OAuth'],
|
|
40082
|
+
['application/json'],
|
|
40083
|
+
['application/json']
|
|
40084
|
+
);
|
|
40085
|
+
}
|
|
40086
|
+
|
|
39011
40087
|
/**
|
|
39012
40088
|
* Create document.
|
|
39013
40089
|
*
|
|
@@ -39558,7 +40634,7 @@ class LanguageUnderstandingApi {
|
|
|
39558
40634
|
/**
|
|
39559
40635
|
* LanguageUnderstanding service.
|
|
39560
40636
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
39561
|
-
* @version
|
|
40637
|
+
* @version 175.0.0
|
|
39562
40638
|
*/
|
|
39563
40639
|
|
|
39564
40640
|
/**
|
|
@@ -40571,7 +41647,7 @@ class LanguagesApi {
|
|
|
40571
41647
|
/**
|
|
40572
41648
|
* Languages service.
|
|
40573
41649
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
40574
|
-
* @version
|
|
41650
|
+
* @version 175.0.0
|
|
40575
41651
|
*/
|
|
40576
41652
|
|
|
40577
41653
|
/**
|
|
@@ -40793,7 +41869,7 @@ class LearningApi {
|
|
|
40793
41869
|
/**
|
|
40794
41870
|
* Learning service.
|
|
40795
41871
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
40796
|
-
* @version
|
|
41872
|
+
* @version 175.0.0
|
|
40797
41873
|
*/
|
|
40798
41874
|
|
|
40799
41875
|
/**
|
|
@@ -41436,8 +42512,12 @@ class LearningApi {
|
|
|
41436
42512
|
* Publish a Learning module
|
|
41437
42513
|
*
|
|
41438
42514
|
* @param {String} moduleId The ID of the learning module
|
|
42515
|
+
* @param {Object} opts Optional parameters
|
|
42516
|
+
* @param {Object} opts.body The request body
|
|
41439
42517
|
*/
|
|
41440
|
-
postLearningModulePublish(moduleId) {
|
|
42518
|
+
postLearningModulePublish(moduleId, opts) {
|
|
42519
|
+
opts = opts || {};
|
|
42520
|
+
|
|
41441
42521
|
// verify the required parameter 'moduleId' is set
|
|
41442
42522
|
if (moduleId === undefined || moduleId === null) {
|
|
41443
42523
|
throw 'Missing the required parameter "moduleId" when calling postLearningModulePublish';
|
|
@@ -41450,7 +42530,7 @@ class LearningApi {
|
|
|
41450
42530
|
{ },
|
|
41451
42531
|
{ },
|
|
41452
42532
|
{ },
|
|
41453
|
-
|
|
42533
|
+
opts['body'],
|
|
41454
42534
|
['PureCloud OAuth'],
|
|
41455
42535
|
['application/json'],
|
|
41456
42536
|
['application/json']
|
|
@@ -41608,7 +42688,7 @@ class LicenseApi {
|
|
|
41608
42688
|
/**
|
|
41609
42689
|
* License service.
|
|
41610
42690
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
41611
|
-
* @version
|
|
42691
|
+
* @version 175.0.0
|
|
41612
42692
|
*/
|
|
41613
42693
|
|
|
41614
42694
|
/**
|
|
@@ -41846,7 +42926,7 @@ class LocationsApi {
|
|
|
41846
42926
|
/**
|
|
41847
42927
|
* Locations service.
|
|
41848
42928
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
41849
|
-
* @version
|
|
42929
|
+
* @version 175.0.0
|
|
41850
42930
|
*/
|
|
41851
42931
|
|
|
41852
42932
|
/**
|
|
@@ -42082,7 +43162,7 @@ class MessagingApi {
|
|
|
42082
43162
|
/**
|
|
42083
43163
|
* Messaging service.
|
|
42084
43164
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
42085
|
-
* @version
|
|
43165
|
+
* @version 175.0.0
|
|
42086
43166
|
*/
|
|
42087
43167
|
|
|
42088
43168
|
/**
|
|
@@ -42441,7 +43521,7 @@ class MobileDevicesApi {
|
|
|
42441
43521
|
/**
|
|
42442
43522
|
* MobileDevices service.
|
|
42443
43523
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
42444
|
-
* @version
|
|
43524
|
+
* @version 175.0.0
|
|
42445
43525
|
*/
|
|
42446
43526
|
|
|
42447
43527
|
/**
|
|
@@ -42592,7 +43672,7 @@ class NotificationsApi {
|
|
|
42592
43672
|
/**
|
|
42593
43673
|
* Notifications service.
|
|
42594
43674
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
42595
|
-
* @version
|
|
43675
|
+
* @version 175.0.0
|
|
42596
43676
|
*/
|
|
42597
43677
|
|
|
42598
43678
|
/**
|
|
@@ -42825,7 +43905,7 @@ class OAuthApi {
|
|
|
42825
43905
|
/**
|
|
42826
43906
|
* OAuth service.
|
|
42827
43907
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
42828
|
-
* @version
|
|
43908
|
+
* @version 175.0.0
|
|
42829
43909
|
*/
|
|
42830
43910
|
|
|
42831
43911
|
/**
|
|
@@ -43191,7 +44271,7 @@ class ObjectsApi {
|
|
|
43191
44271
|
/**
|
|
43192
44272
|
* Objects service.
|
|
43193
44273
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
43194
|
-
* @version
|
|
44274
|
+
* @version 175.0.0
|
|
43195
44275
|
*/
|
|
43196
44276
|
|
|
43197
44277
|
/**
|
|
@@ -43462,7 +44542,7 @@ class OrganizationApi {
|
|
|
43462
44542
|
/**
|
|
43463
44543
|
* Organization service.
|
|
43464
44544
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
43465
|
-
* @version
|
|
44545
|
+
* @version 175.0.0
|
|
43466
44546
|
*/
|
|
43467
44547
|
|
|
43468
44548
|
/**
|
|
@@ -43917,7 +44997,7 @@ class OrganizationAuthorizationApi {
|
|
|
43917
44997
|
/**
|
|
43918
44998
|
* OrganizationAuthorization service.
|
|
43919
44999
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
43920
|
-
* @version
|
|
45000
|
+
* @version 175.0.0
|
|
43921
45001
|
*/
|
|
43922
45002
|
|
|
43923
45003
|
/**
|
|
@@ -45264,7 +46344,7 @@ class OutboundApi {
|
|
|
45264
46344
|
/**
|
|
45265
46345
|
* Outbound service.
|
|
45266
46346
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
45267
|
-
* @version
|
|
46347
|
+
* @version 175.0.0
|
|
45268
46348
|
*/
|
|
45269
46349
|
|
|
45270
46350
|
/**
|
|
@@ -48886,7 +49966,7 @@ class PresenceApi {
|
|
|
48886
49966
|
/**
|
|
48887
49967
|
* Presence service.
|
|
48888
49968
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
48889
|
-
* @version
|
|
49969
|
+
* @version 175.0.0
|
|
48890
49970
|
*/
|
|
48891
49971
|
|
|
48892
49972
|
/**
|
|
@@ -49625,7 +50705,7 @@ class ProcessAutomationApi {
|
|
|
49625
50705
|
/**
|
|
49626
50706
|
* ProcessAutomation service.
|
|
49627
50707
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
49628
|
-
* @version
|
|
50708
|
+
* @version 175.0.0
|
|
49629
50709
|
*/
|
|
49630
50710
|
|
|
49631
50711
|
/**
|
|
@@ -49864,7 +50944,7 @@ class QualityApi {
|
|
|
49864
50944
|
/**
|
|
49865
50945
|
* Quality service.
|
|
49866
50946
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
49867
|
-
* @version
|
|
50947
|
+
* @version 175.0.0
|
|
49868
50948
|
*/
|
|
49869
50949
|
|
|
49870
50950
|
/**
|
|
@@ -50147,6 +51227,7 @@ class QualityApi {
|
|
|
50147
51227
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
50148
51228
|
* @param {String} opts.name name
|
|
50149
51229
|
* @param {String} opts.group group id
|
|
51230
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
50150
51231
|
*/
|
|
50151
51232
|
getQualityAgentsActivity(opts) {
|
|
50152
51233
|
opts = opts || {};
|
|
@@ -50156,7 +51237,7 @@ class QualityApi {
|
|
|
50156
51237
|
'/api/v2/quality/agents/activity',
|
|
50157
51238
|
'GET',
|
|
50158
51239
|
{ },
|
|
50159
|
-
{ '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'] },
|
|
51240
|
+
{ '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'] },
|
|
50160
51241
|
{ },
|
|
50161
51242
|
{ },
|
|
50162
51243
|
null,
|
|
@@ -50354,9 +51435,9 @@ class QualityApi {
|
|
|
50354
51435
|
* @param {Object} opts Optional parameters
|
|
50355
51436
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
50356
51437
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
50357
|
-
* @param {String} opts.sortBy
|
|
51438
|
+
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
50358
51439
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
50359
|
-
* @param {String} opts.nextPage
|
|
51440
|
+
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
50360
51441
|
* @param {String} opts.previousPage Previous page token
|
|
50361
51442
|
* @param {String} opts.conversationId conversationId specified
|
|
50362
51443
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -50365,12 +51446,13 @@ class QualityApi {
|
|
|
50365
51446
|
* @param {String} opts.queueId queue id
|
|
50366
51447
|
* @param {String} opts.startTime start time of the evaluation query
|
|
50367
51448
|
* @param {String} opts.endTime end time of the evaluation query
|
|
51449
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
50368
51450
|
* @param {Array.<String>} opts.evaluationState
|
|
50369
51451
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
50370
51452
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
50371
51453
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
50372
|
-
* @param {Number} opts.maximum maximum
|
|
50373
|
-
* @param {String} opts.sortOrder
|
|
51454
|
+
* @param {Number} opts.maximum the maximum number of results to return
|
|
51455
|
+
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
50374
51456
|
*/
|
|
50375
51457
|
getQualityEvaluationsQuery(opts) {
|
|
50376
51458
|
opts = opts || {};
|
|
@@ -50380,7 +51462,7 @@ class QualityApi {
|
|
|
50380
51462
|
'/api/v2/quality/evaluations/query',
|
|
50381
51463
|
'GET',
|
|
50382
51464
|
{ },
|
|
50383
|
-
{ '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'] },
|
|
51465
|
+
{ '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'] },
|
|
50384
51466
|
{ },
|
|
50385
51467
|
{ },
|
|
50386
51468
|
null,
|
|
@@ -51457,7 +52539,7 @@ class QualityApi {
|
|
|
51457
52539
|
* @param {String} evaluationId evaluationId
|
|
51458
52540
|
* @param {Object} body evaluation
|
|
51459
52541
|
* @param {Object} opts Optional parameters
|
|
51460
|
-
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
52542
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee, evaluator
|
|
51461
52543
|
*/
|
|
51462
52544
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
51463
52545
|
opts = opts || {};
|
|
@@ -51616,7 +52698,7 @@ class RecordingApi {
|
|
|
51616
52698
|
/**
|
|
51617
52699
|
* Recording service.
|
|
51618
52700
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
51619
|
-
* @version
|
|
52701
|
+
* @version 175.0.0
|
|
51620
52702
|
*/
|
|
51621
52703
|
|
|
51622
52704
|
/**
|
|
@@ -53253,7 +54335,7 @@ class ResponseManagementApi {
|
|
|
53253
54335
|
/**
|
|
53254
54336
|
* ResponseManagement service.
|
|
53255
54337
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
53256
|
-
* @version
|
|
54338
|
+
* @version 175.0.0
|
|
53257
54339
|
*/
|
|
53258
54340
|
|
|
53259
54341
|
/**
|
|
@@ -53738,7 +54820,7 @@ class RoutingApi {
|
|
|
53738
54820
|
/**
|
|
53739
54821
|
* Routing service.
|
|
53740
54822
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
53741
|
-
* @version
|
|
54823
|
+
* @version 175.0.0
|
|
53742
54824
|
*/
|
|
53743
54825
|
|
|
53744
54826
|
/**
|
|
@@ -54745,6 +55827,7 @@ class RoutingApi {
|
|
|
54745
55827
|
*
|
|
54746
55828
|
* @param {Object} opts Optional parameters
|
|
54747
55829
|
* @param {Object} opts.messengerType Messenger Type
|
|
55830
|
+
* @param {String} opts.name Recipient Name
|
|
54748
55831
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
54749
55832
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
54750
55833
|
*/
|
|
@@ -54756,7 +55839,7 @@ class RoutingApi {
|
|
|
54756
55839
|
'/api/v2/routing/message/recipients',
|
|
54757
55840
|
'GET',
|
|
54758
55841
|
{ },
|
|
54759
|
-
{ 'messengerType': opts['messengerType'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
55842
|
+
{ 'messengerType': opts['messengerType'],'name': opts['name'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
54760
55843
|
{ },
|
|
54761
55844
|
{ },
|
|
54762
55845
|
null,
|
|
@@ -57445,7 +58528,7 @@ class SCIMApi {
|
|
|
57445
58528
|
/**
|
|
57446
58529
|
* SCIM service.
|
|
57447
58530
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
57448
|
-
* @version
|
|
58531
|
+
* @version 175.0.0
|
|
57449
58532
|
*/
|
|
57450
58533
|
|
|
57451
58534
|
/**
|
|
@@ -58322,7 +59405,7 @@ class ScriptsApi {
|
|
|
58322
59405
|
/**
|
|
58323
59406
|
* Scripts service.
|
|
58324
59407
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
58325
|
-
* @version
|
|
59408
|
+
* @version 175.0.0
|
|
58326
59409
|
*/
|
|
58327
59410
|
|
|
58328
59411
|
/**
|
|
@@ -58766,7 +59849,7 @@ class SearchApi {
|
|
|
58766
59849
|
/**
|
|
58767
59850
|
* Search service.
|
|
58768
59851
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
58769
|
-
* @version
|
|
59852
|
+
* @version 175.0.0
|
|
58770
59853
|
*/
|
|
58771
59854
|
|
|
58772
59855
|
/**
|
|
@@ -59455,7 +60538,7 @@ class SettingsApi {
|
|
|
59455
60538
|
/**
|
|
59456
60539
|
* Settings service.
|
|
59457
60540
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
59458
|
-
* @version
|
|
60541
|
+
* @version 175.0.0
|
|
59459
60542
|
*/
|
|
59460
60543
|
|
|
59461
60544
|
/**
|
|
@@ -59520,7 +60603,7 @@ class SpeechTextAnalyticsApi {
|
|
|
59520
60603
|
/**
|
|
59521
60604
|
* SpeechTextAnalytics service.
|
|
59522
60605
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
59523
|
-
* @version
|
|
60606
|
+
* @version 175.0.0
|
|
59524
60607
|
*/
|
|
59525
60608
|
|
|
59526
60609
|
/**
|
|
@@ -60503,7 +61586,7 @@ class StationsApi {
|
|
|
60503
61586
|
/**
|
|
60504
61587
|
* Stations service.
|
|
60505
61588
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
60506
|
-
* @version
|
|
61589
|
+
* @version 175.0.0
|
|
60507
61590
|
*/
|
|
60508
61591
|
|
|
60509
61592
|
/**
|
|
@@ -60605,7 +61688,7 @@ class SuggestApi {
|
|
|
60605
61688
|
/**
|
|
60606
61689
|
* Suggest service.
|
|
60607
61690
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
60608
|
-
* @version
|
|
61691
|
+
* @version 175.0.0
|
|
60609
61692
|
*/
|
|
60610
61693
|
|
|
60611
61694
|
/**
|
|
@@ -60744,7 +61827,7 @@ class TaskManagementApi {
|
|
|
60744
61827
|
/**
|
|
60745
61828
|
* TaskManagement service.
|
|
60746
61829
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
60747
|
-
* @version
|
|
61830
|
+
* @version 175.0.0
|
|
60748
61831
|
*/
|
|
60749
61832
|
|
|
60750
61833
|
/**
|
|
@@ -62025,7 +63108,7 @@ class TeamsApi {
|
|
|
62025
63108
|
/**
|
|
62026
63109
|
* Teams service.
|
|
62027
63110
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
62028
|
-
* @version
|
|
63111
|
+
* @version 175.0.0
|
|
62029
63112
|
*/
|
|
62030
63113
|
|
|
62031
63114
|
/**
|
|
@@ -62327,7 +63410,7 @@ class TelephonyApi {
|
|
|
62327
63410
|
/**
|
|
62328
63411
|
* Telephony service.
|
|
62329
63412
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
62330
|
-
* @version
|
|
63413
|
+
* @version 175.0.0
|
|
62331
63414
|
*/
|
|
62332
63415
|
|
|
62333
63416
|
/**
|
|
@@ -62455,7 +63538,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
62455
63538
|
/**
|
|
62456
63539
|
* TelephonyProvidersEdge service.
|
|
62457
63540
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
62458
|
-
* @version
|
|
63541
|
+
* @version 175.0.0
|
|
62459
63542
|
*/
|
|
62460
63543
|
|
|
62461
63544
|
/**
|
|
@@ -64118,7 +65201,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
64118
65201
|
}
|
|
64119
65202
|
|
|
64120
65203
|
/**
|
|
64121
|
-
* Get a list of Phone Instances
|
|
65204
|
+
* 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.
|
|
64122
65205
|
*
|
|
64123
65206
|
* @param {Object} opts Optional parameters
|
|
64124
65207
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -65744,7 +66827,7 @@ class TextbotsApi {
|
|
|
65744
66827
|
/**
|
|
65745
66828
|
* Textbots service.
|
|
65746
66829
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
65747
|
-
* @version
|
|
66830
|
+
* @version 175.0.0
|
|
65748
66831
|
*/
|
|
65749
66832
|
|
|
65750
66833
|
/**
|
|
@@ -65872,7 +66955,7 @@ class TokensApi {
|
|
|
65872
66955
|
/**
|
|
65873
66956
|
* Tokens service.
|
|
65874
66957
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
65875
|
-
* @version
|
|
66958
|
+
* @version 175.0.0
|
|
65876
66959
|
*/
|
|
65877
66960
|
|
|
65878
66961
|
/**
|
|
@@ -65935,14 +67018,18 @@ class TokensApi {
|
|
|
65935
67018
|
/**
|
|
65936
67019
|
* Fetch information about the current token
|
|
65937
67020
|
*
|
|
67021
|
+
* @param {Object} opts Optional parameters
|
|
67022
|
+
* @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.
|
|
65938
67023
|
*/
|
|
65939
|
-
getTokensMe() {
|
|
67024
|
+
getTokensMe(opts) {
|
|
67025
|
+
opts = opts || {};
|
|
67026
|
+
|
|
65940
67027
|
|
|
65941
67028
|
return this.apiClient.callApi(
|
|
65942
67029
|
'/api/v2/tokens/me',
|
|
65943
67030
|
'GET',
|
|
65944
67031
|
{ },
|
|
65945
|
-
{
|
|
67032
|
+
{ 'preserveIdleTTL': opts['preserveIdleTTL'] },
|
|
65946
67033
|
{ },
|
|
65947
67034
|
{ },
|
|
65948
67035
|
null,
|
|
@@ -66024,7 +67111,7 @@ class UploadsApi {
|
|
|
66024
67111
|
/**
|
|
66025
67112
|
* Uploads service.
|
|
66026
67113
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
66027
|
-
* @version
|
|
67114
|
+
* @version 175.0.0
|
|
66028
67115
|
*/
|
|
66029
67116
|
|
|
66030
67117
|
/**
|
|
@@ -66200,7 +67287,7 @@ class UsageApi {
|
|
|
66200
67287
|
/**
|
|
66201
67288
|
* Usage service.
|
|
66202
67289
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
66203
|
-
* @version
|
|
67290
|
+
* @version 175.0.0
|
|
66204
67291
|
*/
|
|
66205
67292
|
|
|
66206
67293
|
/**
|
|
@@ -66410,7 +67497,7 @@ class UserRecordingsApi {
|
|
|
66410
67497
|
/**
|
|
66411
67498
|
* UserRecordings service.
|
|
66412
67499
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
66413
|
-
* @version
|
|
67500
|
+
* @version 175.0.0
|
|
66414
67501
|
*/
|
|
66415
67502
|
|
|
66416
67503
|
/**
|
|
@@ -66595,7 +67682,7 @@ class UsersApi {
|
|
|
66595
67682
|
/**
|
|
66596
67683
|
* Users service.
|
|
66597
67684
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
66598
|
-
* @version
|
|
67685
|
+
* @version 175.0.0
|
|
66599
67686
|
*/
|
|
66600
67687
|
|
|
66601
67688
|
/**
|
|
@@ -69156,7 +70243,7 @@ class UtilitiesApi {
|
|
|
69156
70243
|
/**
|
|
69157
70244
|
* Utilities service.
|
|
69158
70245
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
69159
|
-
* @version
|
|
70246
|
+
* @version 175.0.0
|
|
69160
70247
|
*/
|
|
69161
70248
|
|
|
69162
70249
|
/**
|
|
@@ -69267,7 +70354,7 @@ class VoicemailApi {
|
|
|
69267
70354
|
/**
|
|
69268
70355
|
* Voicemail service.
|
|
69269
70356
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
69270
|
-
* @version
|
|
70357
|
+
* @version 175.0.0
|
|
69271
70358
|
*/
|
|
69272
70359
|
|
|
69273
70360
|
/**
|
|
@@ -69934,7 +71021,7 @@ class WebChatApi {
|
|
|
69934
71021
|
/**
|
|
69935
71022
|
* WebChat service.
|
|
69936
71023
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
69937
|
-
* @version
|
|
71024
|
+
* @version 175.0.0
|
|
69938
71025
|
*/
|
|
69939
71026
|
|
|
69940
71027
|
/**
|
|
@@ -70483,7 +71570,7 @@ class WebDeploymentsApi {
|
|
|
70483
71570
|
/**
|
|
70484
71571
|
* WebDeployments service.
|
|
70485
71572
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
70486
|
-
* @version
|
|
71573
|
+
* @version 175.0.0
|
|
70487
71574
|
*/
|
|
70488
71575
|
|
|
70489
71576
|
/**
|
|
@@ -70711,8 +71798,12 @@ class WebDeploymentsApi {
|
|
|
70711
71798
|
* Get a deployment
|
|
70712
71799
|
*
|
|
70713
71800
|
* @param {String} deploymentId The deployment ID
|
|
71801
|
+
* @param {Object} opts Optional parameters
|
|
71802
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
70714
71803
|
*/
|
|
70715
|
-
getWebdeploymentsDeployment(deploymentId) {
|
|
71804
|
+
getWebdeploymentsDeployment(deploymentId, opts) {
|
|
71805
|
+
opts = opts || {};
|
|
71806
|
+
|
|
70716
71807
|
// verify the required parameter 'deploymentId' is set
|
|
70717
71808
|
if (deploymentId === undefined || deploymentId === null) {
|
|
70718
71809
|
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';
|
|
@@ -70722,7 +71813,7 @@ class WebDeploymentsApi {
|
|
|
70722
71813
|
'/api/v2/webdeployments/deployments/{deploymentId}',
|
|
70723
71814
|
'GET',
|
|
70724
71815
|
{ 'deploymentId': deploymentId },
|
|
70725
|
-
{
|
|
71816
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70726
71817
|
{ },
|
|
70727
71818
|
{ },
|
|
70728
71819
|
null,
|
|
@@ -70768,6 +71859,7 @@ class WebDeploymentsApi {
|
|
|
70768
71859
|
* @param {String} deploymentId The deployment ID
|
|
70769
71860
|
* @param {Object} opts Optional parameters
|
|
70770
71861
|
* @param {String} opts.type Get active configuration on a deployment
|
|
71862
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value
|
|
70771
71863
|
*/
|
|
70772
71864
|
getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
|
|
70773
71865
|
opts = opts || {};
|
|
@@ -70781,7 +71873,7 @@ class WebDeploymentsApi {
|
|
|
70781
71873
|
'/api/v2/webdeployments/deployments/{deploymentId}/configurations',
|
|
70782
71874
|
'GET',
|
|
70783
71875
|
{ 'deploymentId': deploymentId },
|
|
70784
|
-
{ 'type': opts['type'] },
|
|
71876
|
+
{ 'type': opts['type'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
70785
71877
|
{ },
|
|
70786
71878
|
{ },
|
|
70787
71879
|
null,
|
|
@@ -70795,7 +71887,7 @@ class WebDeploymentsApi {
|
|
|
70795
71887
|
* Get deployments
|
|
70796
71888
|
*
|
|
70797
71889
|
* @param {Object} opts Optional parameters
|
|
70798
|
-
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
71890
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
70799
71891
|
*/
|
|
70800
71892
|
getWebdeploymentsDeployments(opts) {
|
|
70801
71893
|
opts = opts || {};
|
|
@@ -71005,7 +72097,7 @@ class WebMessagingApi {
|
|
|
71005
72097
|
/**
|
|
71006
72098
|
* WebMessaging service.
|
|
71007
72099
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
71008
|
-
* @version
|
|
72100
|
+
* @version 175.0.0
|
|
71009
72101
|
*/
|
|
71010
72102
|
|
|
71011
72103
|
/**
|
|
@@ -71051,7 +72143,7 @@ class WidgetsApi {
|
|
|
71051
72143
|
/**
|
|
71052
72144
|
* Widgets service.
|
|
71053
72145
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
71054
|
-
* @version
|
|
72146
|
+
* @version 175.0.0
|
|
71055
72147
|
*/
|
|
71056
72148
|
|
|
71057
72149
|
/**
|
|
@@ -71197,7 +72289,7 @@ class WorkforceManagementApi {
|
|
|
71197
72289
|
/**
|
|
71198
72290
|
* WorkforceManagement service.
|
|
71199
72291
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
71200
|
-
* @version
|
|
72292
|
+
* @version 175.0.0
|
|
71201
72293
|
*/
|
|
71202
72294
|
|
|
71203
72295
|
/**
|
|
@@ -72116,8 +73208,12 @@ class WorkforceManagementApi {
|
|
|
72116
73208
|
*
|
|
72117
73209
|
* @param {String} businessUnitId The ID of the business unit.
|
|
72118
73210
|
* @param {String} serviceGoalTemplateId The ID of a service goal template to fetch
|
|
73211
|
+
* @param {Object} opts Optional parameters
|
|
73212
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
72119
73213
|
*/
|
|
72120
|
-
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId) {
|
|
73214
|
+
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, opts) {
|
|
73215
|
+
opts = opts || {};
|
|
73216
|
+
|
|
72121
73217
|
// verify the required parameter 'businessUnitId' is set
|
|
72122
73218
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72123
73219
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
@@ -72131,7 +73227,7 @@ class WorkforceManagementApi {
|
|
|
72131
73227
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
72132
73228
|
'GET',
|
|
72133
73229
|
{ 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
|
|
72134
|
-
{
|
|
73230
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
72135
73231
|
{ },
|
|
72136
73232
|
{ },
|
|
72137
73233
|
null,
|
|
@@ -72145,8 +73241,12 @@ class WorkforceManagementApi {
|
|
|
72145
73241
|
* Gets list of service goal templates
|
|
72146
73242
|
*
|
|
72147
73243
|
* @param {String} businessUnitId The ID of the business unit.
|
|
73244
|
+
* @param {Object} opts Optional parameters
|
|
73245
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
72148
73246
|
*/
|
|
72149
|
-
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId) {
|
|
73247
|
+
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, opts) {
|
|
73248
|
+
opts = opts || {};
|
|
73249
|
+
|
|
72150
73250
|
// verify the required parameter 'businessUnitId' is set
|
|
72151
73251
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72152
73252
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
@@ -72156,7 +73256,7 @@ class WorkforceManagementApi {
|
|
|
72156
73256
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
|
|
72157
73257
|
'GET',
|
|
72158
73258
|
{ 'businessUnitId': businessUnitId },
|
|
72159
|
-
{
|
|
73259
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
72160
73260
|
{ },
|
|
72161
73261
|
{ },
|
|
72162
73262
|
null,
|
|
@@ -72706,6 +73806,51 @@ class WorkforceManagementApi {
|
|
|
72706
73806
|
);
|
|
72707
73807
|
}
|
|
72708
73808
|
|
|
73809
|
+
/**
|
|
73810
|
+
* Get integrations
|
|
73811
|
+
*
|
|
73812
|
+
*/
|
|
73813
|
+
getWorkforcemanagementIntegrationsHris() {
|
|
73814
|
+
|
|
73815
|
+
return this.apiClient.callApi(
|
|
73816
|
+
'/api/v2/workforcemanagement/integrations/hris',
|
|
73817
|
+
'GET',
|
|
73818
|
+
{ },
|
|
73819
|
+
{ },
|
|
73820
|
+
{ },
|
|
73821
|
+
{ },
|
|
73822
|
+
null,
|
|
73823
|
+
['PureCloud OAuth'],
|
|
73824
|
+
['application/json'],
|
|
73825
|
+
['application/json']
|
|
73826
|
+
);
|
|
73827
|
+
}
|
|
73828
|
+
|
|
73829
|
+
/**
|
|
73830
|
+
* Query the results of time off types job
|
|
73831
|
+
*
|
|
73832
|
+
* @param {String} jobId The ID of the job.
|
|
73833
|
+
*/
|
|
73834
|
+
getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId) {
|
|
73835
|
+
// verify the required parameter 'jobId' is set
|
|
73836
|
+
if (jobId === undefined || jobId === null) {
|
|
73837
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';
|
|
73838
|
+
}
|
|
73839
|
+
|
|
73840
|
+
return this.apiClient.callApi(
|
|
73841
|
+
'/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}',
|
|
73842
|
+
'GET',
|
|
73843
|
+
{ 'jobId': jobId },
|
|
73844
|
+
{ },
|
|
73845
|
+
{ },
|
|
73846
|
+
{ },
|
|
73847
|
+
null,
|
|
73848
|
+
['PureCloud OAuth'],
|
|
73849
|
+
['application/json'],
|
|
73850
|
+
['application/json']
|
|
73851
|
+
);
|
|
73852
|
+
}
|
|
73853
|
+
|
|
72709
73854
|
/**
|
|
72710
73855
|
* Get management unit
|
|
72711
73856
|
* settings.shortTermForecasting is deprecated and now lives on the business unit
|
|
@@ -73519,6 +74664,31 @@ class WorkforceManagementApi {
|
|
|
73519
74664
|
);
|
|
73520
74665
|
}
|
|
73521
74666
|
|
|
74667
|
+
/**
|
|
74668
|
+
* Query the results of time off types job
|
|
74669
|
+
*
|
|
74670
|
+
* @param {String} jobId The ID of the job.
|
|
74671
|
+
*/
|
|
74672
|
+
getWorkforcemanagementTimeoffbalanceJob(jobId) {
|
|
74673
|
+
// verify the required parameter 'jobId' is set
|
|
74674
|
+
if (jobId === undefined || jobId === null) {
|
|
74675
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';
|
|
74676
|
+
}
|
|
74677
|
+
|
|
74678
|
+
return this.apiClient.callApi(
|
|
74679
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}',
|
|
74680
|
+
'GET',
|
|
74681
|
+
{ 'jobId': jobId },
|
|
74682
|
+
{ },
|
|
74683
|
+
{ },
|
|
74684
|
+
{ },
|
|
74685
|
+
null,
|
|
74686
|
+
['PureCloud OAuth'],
|
|
74687
|
+
['application/json'],
|
|
74688
|
+
['application/json']
|
|
74689
|
+
);
|
|
74690
|
+
}
|
|
74691
|
+
|
|
73522
74692
|
/**
|
|
73523
74693
|
* Get a time off request for the current user
|
|
73524
74694
|
*
|
|
@@ -73890,6 +75060,45 @@ class WorkforceManagementApi {
|
|
|
73890
75060
|
);
|
|
73891
75061
|
}
|
|
73892
75062
|
|
|
75063
|
+
/**
|
|
75064
|
+
* Set integration status for a time off request.
|
|
75065
|
+
*
|
|
75066
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
75067
|
+
* @param {String} timeOffRequestId The ID of the time off request.
|
|
75068
|
+
* @param {String} userId The ID of user to whom the time off request belongs.
|
|
75069
|
+
* @param {Object} opts Optional parameters
|
|
75070
|
+
* @param {Object} opts.body body
|
|
75071
|
+
*/
|
|
75072
|
+
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, opts) {
|
|
75073
|
+
opts = opts || {};
|
|
75074
|
+
|
|
75075
|
+
// verify the required parameter 'managementUnitId' is set
|
|
75076
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
75077
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
75078
|
+
}
|
|
75079
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
75080
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
75081
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
75082
|
+
}
|
|
75083
|
+
// verify the required parameter 'userId' is set
|
|
75084
|
+
if (userId === undefined || userId === null) {
|
|
75085
|
+
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
75086
|
+
}
|
|
75087
|
+
|
|
75088
|
+
return this.apiClient.callApi(
|
|
75089
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
|
|
75090
|
+
'PATCH',
|
|
75091
|
+
{ 'managementUnitId': managementUnitId,'timeOffRequestId': timeOffRequestId,'userId': userId },
|
|
75092
|
+
{ },
|
|
75093
|
+
{ },
|
|
75094
|
+
{ },
|
|
75095
|
+
opts['body'],
|
|
75096
|
+
['PureCloud OAuth'],
|
|
75097
|
+
['application/json'],
|
|
75098
|
+
['application/json']
|
|
75099
|
+
);
|
|
75100
|
+
}
|
|
75101
|
+
|
|
73893
75102
|
/**
|
|
73894
75103
|
* Update a time off request
|
|
73895
75104
|
*
|
|
@@ -74127,6 +75336,7 @@ class WorkforceManagementApi {
|
|
|
74127
75336
|
*
|
|
74128
75337
|
* @param {Object} opts Optional parameters
|
|
74129
75338
|
* @param {Object} opts.body body
|
|
75339
|
+
* @deprecated
|
|
74130
75340
|
*/
|
|
74131
75341
|
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
74132
75342
|
opts = opts || {};
|
|
@@ -74235,6 +75445,54 @@ class WorkforceManagementApi {
|
|
|
74235
75445
|
);
|
|
74236
75446
|
}
|
|
74237
75447
|
|
|
75448
|
+
/**
|
|
75449
|
+
* Move agents in and out of management unit
|
|
75450
|
+
*
|
|
75451
|
+
* @param {Object} opts Optional parameters
|
|
75452
|
+
* @param {Object} opts.body body
|
|
75453
|
+
*/
|
|
75454
|
+
postWorkforcemanagementAgents(opts) {
|
|
75455
|
+
opts = opts || {};
|
|
75456
|
+
|
|
75457
|
+
|
|
75458
|
+
return this.apiClient.callApi(
|
|
75459
|
+
'/api/v2/workforcemanagement/agents',
|
|
75460
|
+
'POST',
|
|
75461
|
+
{ },
|
|
75462
|
+
{ },
|
|
75463
|
+
{ },
|
|
75464
|
+
{ },
|
|
75465
|
+
opts['body'],
|
|
75466
|
+
['PureCloud OAuth'],
|
|
75467
|
+
['application/json'],
|
|
75468
|
+
['application/json']
|
|
75469
|
+
);
|
|
75470
|
+
}
|
|
75471
|
+
|
|
75472
|
+
/**
|
|
75473
|
+
* Query integrations for agents
|
|
75474
|
+
*
|
|
75475
|
+
* @param {Object} opts Optional parameters
|
|
75476
|
+
* @param {Object} opts.body body
|
|
75477
|
+
*/
|
|
75478
|
+
postWorkforcemanagementAgentsIntegrationsHrisQuery(opts) {
|
|
75479
|
+
opts = opts || {};
|
|
75480
|
+
|
|
75481
|
+
|
|
75482
|
+
return this.apiClient.callApi(
|
|
75483
|
+
'/api/v2/workforcemanagement/agents/integrations/hris/query',
|
|
75484
|
+
'POST',
|
|
75485
|
+
{ },
|
|
75486
|
+
{ },
|
|
75487
|
+
{ },
|
|
75488
|
+
{ },
|
|
75489
|
+
opts['body'],
|
|
75490
|
+
['PureCloud OAuth'],
|
|
75491
|
+
['application/json'],
|
|
75492
|
+
['application/json']
|
|
75493
|
+
);
|
|
75494
|
+
}
|
|
75495
|
+
|
|
74238
75496
|
/**
|
|
74239
75497
|
* Get agent possible work shifts for requested time frame
|
|
74240
75498
|
*
|
|
@@ -75057,6 +76315,31 @@ class WorkforceManagementApi {
|
|
|
75057
76315
|
);
|
|
75058
76316
|
}
|
|
75059
76317
|
|
|
76318
|
+
/**
|
|
76319
|
+
* Get list of time off types configured in integration
|
|
76320
|
+
*
|
|
76321
|
+
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
76322
|
+
*/
|
|
76323
|
+
postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId) {
|
|
76324
|
+
// verify the required parameter 'hrisIntegrationId' is set
|
|
76325
|
+
if (hrisIntegrationId === undefined || hrisIntegrationId === null) {
|
|
76326
|
+
throw 'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';
|
|
76327
|
+
}
|
|
76328
|
+
|
|
76329
|
+
return this.apiClient.callApi(
|
|
76330
|
+
'/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs',
|
|
76331
|
+
'POST',
|
|
76332
|
+
{ 'hrisIntegrationId': hrisIntegrationId },
|
|
76333
|
+
{ },
|
|
76334
|
+
{ },
|
|
76335
|
+
{ },
|
|
76336
|
+
null,
|
|
76337
|
+
['PureCloud OAuth'],
|
|
76338
|
+
['application/json'],
|
|
76339
|
+
['application/json']
|
|
76340
|
+
);
|
|
76341
|
+
}
|
|
76342
|
+
|
|
75060
76343
|
/**
|
|
75061
76344
|
* Query published schedules for given given time range for set of users
|
|
75062
76345
|
*
|
|
@@ -75321,6 +76604,35 @@ class WorkforceManagementApi {
|
|
|
75321
76604
|
);
|
|
75322
76605
|
}
|
|
75323
76606
|
|
|
76607
|
+
/**
|
|
76608
|
+
* Retrieves integration statuses for a list of time off requests
|
|
76609
|
+
*
|
|
76610
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
76611
|
+
* @param {Object} opts Optional parameters
|
|
76612
|
+
* @param {Object} opts.body body
|
|
76613
|
+
*/
|
|
76614
|
+
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, opts) {
|
|
76615
|
+
opts = opts || {};
|
|
76616
|
+
|
|
76617
|
+
// verify the required parameter 'managementUnitId' is set
|
|
76618
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
76619
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
76620
|
+
}
|
|
76621
|
+
|
|
76622
|
+
return this.apiClient.callApi(
|
|
76623
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
|
|
76624
|
+
'POST',
|
|
76625
|
+
{ 'managementUnitId': managementUnitId },
|
|
76626
|
+
{ },
|
|
76627
|
+
{ },
|
|
76628
|
+
{ },
|
|
76629
|
+
opts['body'],
|
|
76630
|
+
['PureCloud OAuth'],
|
|
76631
|
+
['application/json'],
|
|
76632
|
+
['application/json']
|
|
76633
|
+
);
|
|
76634
|
+
}
|
|
76635
|
+
|
|
75324
76636
|
/**
|
|
75325
76637
|
* Fetches time off requests matching the conditions specified in the request body
|
|
75326
76638
|
* 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
|
|
@@ -75449,6 +76761,40 @@ class WorkforceManagementApi {
|
|
|
75449
76761
|
);
|
|
75450
76762
|
}
|
|
75451
76763
|
|
|
76764
|
+
/**
|
|
76765
|
+
* Estimates available time off for an agent
|
|
76766
|
+
*
|
|
76767
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
76768
|
+
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
76769
|
+
* @param {Object} opts Optional parameters
|
|
76770
|
+
* @param {Object} opts.body body
|
|
76771
|
+
*/
|
|
76772
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, opts) {
|
|
76773
|
+
opts = opts || {};
|
|
76774
|
+
|
|
76775
|
+
// verify the required parameter 'managementUnitId' is set
|
|
76776
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
76777
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
76778
|
+
}
|
|
76779
|
+
// verify the required parameter 'userId' is set
|
|
76780
|
+
if (userId === undefined || userId === null) {
|
|
76781
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
76782
|
+
}
|
|
76783
|
+
|
|
76784
|
+
return this.apiClient.callApi(
|
|
76785
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
76786
|
+
'POST',
|
|
76787
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
76788
|
+
{ },
|
|
76789
|
+
{ },
|
|
76790
|
+
{ },
|
|
76791
|
+
opts['body'],
|
|
76792
|
+
['PureCloud OAuth'],
|
|
76793
|
+
['application/json'],
|
|
76794
|
+
['application/json']
|
|
76795
|
+
);
|
|
76796
|
+
}
|
|
76797
|
+
|
|
75452
76798
|
/**
|
|
75453
76799
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
75454
76800
|
*
|
|
@@ -75891,6 +77237,31 @@ class WorkforceManagementApi {
|
|
|
75891
77237
|
);
|
|
75892
77238
|
}
|
|
75893
77239
|
|
|
77240
|
+
/**
|
|
77241
|
+
* Query time off balances for the current user for specified activity code and dates
|
|
77242
|
+
*
|
|
77243
|
+
* @param {Object} body The request body
|
|
77244
|
+
*/
|
|
77245
|
+
postWorkforcemanagementTimeoffbalanceJobs(body) {
|
|
77246
|
+
// verify the required parameter 'body' is set
|
|
77247
|
+
if (body === undefined || body === null) {
|
|
77248
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';
|
|
77249
|
+
}
|
|
77250
|
+
|
|
77251
|
+
return this.apiClient.callApi(
|
|
77252
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs',
|
|
77253
|
+
'POST',
|
|
77254
|
+
{ },
|
|
77255
|
+
{ },
|
|
77256
|
+
{ },
|
|
77257
|
+
{ },
|
|
77258
|
+
body,
|
|
77259
|
+
['PureCloud OAuth'],
|
|
77260
|
+
['application/json'],
|
|
77261
|
+
['application/json']
|
|
77262
|
+
);
|
|
77263
|
+
}
|
|
77264
|
+
|
|
75894
77265
|
/**
|
|
75895
77266
|
* Queries available time off for the current user
|
|
75896
77267
|
*
|
|
@@ -75939,6 +77310,84 @@ class WorkforceManagementApi {
|
|
|
75939
77310
|
);
|
|
75940
77311
|
}
|
|
75941
77312
|
|
|
77313
|
+
/**
|
|
77314
|
+
* Estimates available time off for current user
|
|
77315
|
+
*
|
|
77316
|
+
* @param {Object} opts Optional parameters
|
|
77317
|
+
* @param {Object} opts.body body
|
|
77318
|
+
*/
|
|
77319
|
+
postWorkforcemanagementTimeoffrequestsEstimate(opts) {
|
|
77320
|
+
opts = opts || {};
|
|
77321
|
+
|
|
77322
|
+
|
|
77323
|
+
return this.apiClient.callApi(
|
|
77324
|
+
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
77325
|
+
'POST',
|
|
77326
|
+
{ },
|
|
77327
|
+
{ },
|
|
77328
|
+
{ },
|
|
77329
|
+
{ },
|
|
77330
|
+
opts['body'],
|
|
77331
|
+
['PureCloud OAuth'],
|
|
77332
|
+
['application/json'],
|
|
77333
|
+
['application/json']
|
|
77334
|
+
);
|
|
77335
|
+
}
|
|
77336
|
+
|
|
77337
|
+
/**
|
|
77338
|
+
* Retrieves integration statuses for a list of current user time off requests
|
|
77339
|
+
*
|
|
77340
|
+
* @param {Object} opts Optional parameters
|
|
77341
|
+
* @param {Object} opts.body body
|
|
77342
|
+
*/
|
|
77343
|
+
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(opts) {
|
|
77344
|
+
opts = opts || {};
|
|
77345
|
+
|
|
77346
|
+
|
|
77347
|
+
return this.apiClient.callApi(
|
|
77348
|
+
'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
|
|
77349
|
+
'POST',
|
|
77350
|
+
{ },
|
|
77351
|
+
{ },
|
|
77352
|
+
{ },
|
|
77353
|
+
{ },
|
|
77354
|
+
opts['body'],
|
|
77355
|
+
['PureCloud OAuth'],
|
|
77356
|
+
['application/json'],
|
|
77357
|
+
['application/json']
|
|
77358
|
+
);
|
|
77359
|
+
}
|
|
77360
|
+
|
|
77361
|
+
/**
|
|
77362
|
+
* Update integrations for agent
|
|
77363
|
+
*
|
|
77364
|
+
* @param {String} agentId The ID of the agent
|
|
77365
|
+
* @param {Object} body body
|
|
77366
|
+
*/
|
|
77367
|
+
putWorkforcemanagementAgentIntegrationsHris(agentId, body) {
|
|
77368
|
+
// verify the required parameter 'agentId' is set
|
|
77369
|
+
if (agentId === undefined || agentId === null) {
|
|
77370
|
+
throw 'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
77371
|
+
}
|
|
77372
|
+
// verify the required parameter 'body' is set
|
|
77373
|
+
if (body === undefined || body === null) {
|
|
77374
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
77375
|
+
}
|
|
77376
|
+
|
|
77377
|
+
return this.apiClient.callApi(
|
|
77378
|
+
'/api/v2/workforcemanagement/agents/{agentId}/integrations/hris',
|
|
77379
|
+
'PUT',
|
|
77380
|
+
{ 'agentId': agentId },
|
|
77381
|
+
{ },
|
|
77382
|
+
{ },
|
|
77383
|
+
{ },
|
|
77384
|
+
body,
|
|
77385
|
+
['PureCloud OAuth'],
|
|
77386
|
+
['application/json'],
|
|
77387
|
+
['application/json']
|
|
77388
|
+
);
|
|
77389
|
+
}
|
|
77390
|
+
|
|
75942
77391
|
/**
|
|
75943
77392
|
* Sets daily values for a date range of time off limit object
|
|
75944
77393
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
@@ -76004,7 +77453,7 @@ class WorkforceManagementApi {
|
|
|
76004
77453
|
* </pre>
|
|
76005
77454
|
* </p>
|
|
76006
77455
|
* @module purecloud-platform-client-v2/index
|
|
76007
|
-
* @version
|
|
77456
|
+
* @version 175.0.0
|
|
76008
77457
|
*/
|
|
76009
77458
|
class platformClient {
|
|
76010
77459
|
constructor() {
|