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
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 175.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1488,7 +1488,7 @@ class AlertingApi {
|
|
|
1488
1488
|
/**
|
|
1489
1489
|
* Alerting service.
|
|
1490
1490
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1491
|
-
* @version
|
|
1491
|
+
* @version 175.0.0
|
|
1492
1492
|
*/
|
|
1493
1493
|
|
|
1494
1494
|
/**
|
|
@@ -2138,7 +2138,7 @@ class AnalyticsApi {
|
|
|
2138
2138
|
/**
|
|
2139
2139
|
* Analytics service.
|
|
2140
2140
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2141
|
-
* @version
|
|
2141
|
+
* @version 175.0.0
|
|
2142
2142
|
*/
|
|
2143
2143
|
|
|
2144
2144
|
/**
|
|
@@ -2286,13 +2286,14 @@ class AnalyticsApi {
|
|
|
2286
2286
|
|
|
2287
2287
|
/**
|
|
2288
2288
|
* Get Reporting Turns.
|
|
2289
|
-
* 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.
|
|
2289
|
+
* 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.
|
|
2290
2290
|
* @param {String} botFlowId ID of the bot flow.
|
|
2291
2291
|
* @param {Object} opts Optional parameters
|
|
2292
2292
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
2293
2293
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
2294
|
+
* @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
|
|
2294
2295
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
2295
|
-
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
2296
|
+
* @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.
|
|
2296
2297
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
2297
2298
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
2298
2299
|
*/
|
|
@@ -2308,7 +2309,7 @@ class AnalyticsApi {
|
|
|
2308
2309
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
2309
2310
|
'GET',
|
|
2310
2311
|
{ 'botFlowId': botFlowId },
|
|
2311
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
2312
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
2312
2313
|
{ },
|
|
2313
2314
|
{ },
|
|
2314
2315
|
null,
|
|
@@ -4583,7 +4584,7 @@ class ArchitectApi {
|
|
|
4583
4584
|
/**
|
|
4584
4585
|
* Architect service.
|
|
4585
4586
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4586
|
-
* @version
|
|
4587
|
+
* @version 175.0.0
|
|
4587
4588
|
*/
|
|
4588
4589
|
|
|
4589
4590
|
/**
|
|
@@ -4623,6 +4624,125 @@ class ArchitectApi {
|
|
|
4623
4624
|
);
|
|
4624
4625
|
}
|
|
4625
4626
|
|
|
4627
|
+
/**
|
|
4628
|
+
* Delete a grammar.
|
|
4629
|
+
*
|
|
4630
|
+
* @param {String} grammarId grammar ID
|
|
4631
|
+
* deleteArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4632
|
+
*/
|
|
4633
|
+
deleteArchitectGrammar(grammarId) {
|
|
4634
|
+
// verify the required parameter 'grammarId' is set
|
|
4635
|
+
if (grammarId === undefined || grammarId === null) {
|
|
4636
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';
|
|
4637
|
+
}
|
|
4638
|
+
|
|
4639
|
+
return this.apiClient.callApi(
|
|
4640
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
4641
|
+
'DELETE',
|
|
4642
|
+
{ 'grammarId': grammarId },
|
|
4643
|
+
{ },
|
|
4644
|
+
{ },
|
|
4645
|
+
{ },
|
|
4646
|
+
null,
|
|
4647
|
+
['PureCloud OAuth'],
|
|
4648
|
+
['application/json'],
|
|
4649
|
+
['application/json']
|
|
4650
|
+
);
|
|
4651
|
+
}
|
|
4652
|
+
|
|
4653
|
+
/**
|
|
4654
|
+
* Delete specified grammar language
|
|
4655
|
+
*
|
|
4656
|
+
* @param {String} grammarId Grammar ID
|
|
4657
|
+
* @param {String} languageCode Language
|
|
4658
|
+
* deleteArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4659
|
+
*/
|
|
4660
|
+
deleteArchitectGrammarLanguage(grammarId, languageCode) {
|
|
4661
|
+
// verify the required parameter 'grammarId' is set
|
|
4662
|
+
if (grammarId === undefined || grammarId === null) {
|
|
4663
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';
|
|
4664
|
+
}
|
|
4665
|
+
// verify the required parameter 'languageCode' is set
|
|
4666
|
+
if (languageCode === undefined || languageCode === null) {
|
|
4667
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';
|
|
4668
|
+
}
|
|
4669
|
+
|
|
4670
|
+
return this.apiClient.callApi(
|
|
4671
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
4672
|
+
'DELETE',
|
|
4673
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
4674
|
+
{ },
|
|
4675
|
+
{ },
|
|
4676
|
+
{ },
|
|
4677
|
+
null,
|
|
4678
|
+
['PureCloud OAuth'],
|
|
4679
|
+
['application/json'],
|
|
4680
|
+
['application/json']
|
|
4681
|
+
);
|
|
4682
|
+
}
|
|
4683
|
+
|
|
4684
|
+
/**
|
|
4685
|
+
* Clear the DTMF mode file for the grammar language if there is one
|
|
4686
|
+
*
|
|
4687
|
+
* @param {String} grammarId Grammar ID
|
|
4688
|
+
* @param {String} languageCode Language
|
|
4689
|
+
* deleteArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4690
|
+
*/
|
|
4691
|
+
deleteArchitectGrammarLanguageFilesDtmf(grammarId, languageCode) {
|
|
4692
|
+
// verify the required parameter 'grammarId' is set
|
|
4693
|
+
if (grammarId === undefined || grammarId === null) {
|
|
4694
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
4695
|
+
}
|
|
4696
|
+
// verify the required parameter 'languageCode' is set
|
|
4697
|
+
if (languageCode === undefined || languageCode === null) {
|
|
4698
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';
|
|
4699
|
+
}
|
|
4700
|
+
|
|
4701
|
+
return this.apiClient.callApi(
|
|
4702
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
4703
|
+
'DELETE',
|
|
4704
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
4705
|
+
{ },
|
|
4706
|
+
{ },
|
|
4707
|
+
{ },
|
|
4708
|
+
null,
|
|
4709
|
+
['PureCloud OAuth'],
|
|
4710
|
+
['application/json'],
|
|
4711
|
+
['application/json']
|
|
4712
|
+
);
|
|
4713
|
+
}
|
|
4714
|
+
|
|
4715
|
+
/**
|
|
4716
|
+
* Clear the voice mode file for the grammar language if there is one
|
|
4717
|
+
*
|
|
4718
|
+
* @param {String} grammarId Grammar ID
|
|
4719
|
+
* @param {String} languageCode Language
|
|
4720
|
+
* deleteArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4721
|
+
*/
|
|
4722
|
+
deleteArchitectGrammarLanguageFilesVoice(grammarId, languageCode) {
|
|
4723
|
+
// verify the required parameter 'grammarId' is set
|
|
4724
|
+
if (grammarId === undefined || grammarId === null) {
|
|
4725
|
+
throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
4726
|
+
}
|
|
4727
|
+
// verify the required parameter 'languageCode' is set
|
|
4728
|
+
if (languageCode === undefined || languageCode === null) {
|
|
4729
|
+
throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';
|
|
4730
|
+
}
|
|
4731
|
+
|
|
4732
|
+
return this.apiClient.callApi(
|
|
4733
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
4734
|
+
'DELETE',
|
|
4735
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
4736
|
+
{ },
|
|
4737
|
+
{ },
|
|
4738
|
+
{ },
|
|
4739
|
+
null,
|
|
4740
|
+
['PureCloud OAuth'],
|
|
4741
|
+
['application/json'],
|
|
4742
|
+
['application/json']
|
|
4743
|
+
);
|
|
4744
|
+
}
|
|
4745
|
+
|
|
4626
4746
|
/**
|
|
4627
4747
|
* Delete an IVR Config.
|
|
4628
4748
|
*
|
|
@@ -5307,6 +5427,130 @@ class ArchitectApi {
|
|
|
5307
5427
|
);
|
|
5308
5428
|
}
|
|
5309
5429
|
|
|
5430
|
+
/**
|
|
5431
|
+
* Get a pageable list of basic emergency group objects filterable by query parameters.
|
|
5432
|
+
* 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.
|
|
5433
|
+
* @param {Object} opts Optional parameters
|
|
5434
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5435
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5436
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
5437
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5438
|
+
* @param {Array.<String>} opts.id ID of the Emergency Groups to filter by.
|
|
5439
|
+
* @param {String} opts.name Name of the Emergency Group to filter by.
|
|
5440
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
5441
|
+
*/
|
|
5442
|
+
getArchitectEmergencygroupsDivisionviews(opts) {
|
|
5443
|
+
opts = opts || {};
|
|
5444
|
+
|
|
5445
|
+
|
|
5446
|
+
return this.apiClient.callApi(
|
|
5447
|
+
'/api/v2/architect/emergencygroups/divisionviews',
|
|
5448
|
+
'GET',
|
|
5449
|
+
{ },
|
|
5450
|
+
{ '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') },
|
|
5451
|
+
{ },
|
|
5452
|
+
{ },
|
|
5453
|
+
null,
|
|
5454
|
+
['PureCloud OAuth'],
|
|
5455
|
+
['application/json'],
|
|
5456
|
+
['application/json']
|
|
5457
|
+
);
|
|
5458
|
+
}
|
|
5459
|
+
|
|
5460
|
+
/**
|
|
5461
|
+
* Get a grammar
|
|
5462
|
+
* Returns a specified grammar
|
|
5463
|
+
* @param {String} grammarId grammar ID
|
|
5464
|
+
* @param {Object} opts Optional parameters
|
|
5465
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
5466
|
+
* getArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5467
|
+
*/
|
|
5468
|
+
getArchitectGrammar(grammarId, opts) {
|
|
5469
|
+
opts = opts || {};
|
|
5470
|
+
|
|
5471
|
+
// verify the required parameter 'grammarId' is set
|
|
5472
|
+
if (grammarId === undefined || grammarId === null) {
|
|
5473
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammar';
|
|
5474
|
+
}
|
|
5475
|
+
|
|
5476
|
+
return this.apiClient.callApi(
|
|
5477
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
5478
|
+
'GET',
|
|
5479
|
+
{ 'grammarId': grammarId },
|
|
5480
|
+
{ 'includeFileUrls': opts['includeFileUrls'] },
|
|
5481
|
+
{ },
|
|
5482
|
+
{ },
|
|
5483
|
+
null,
|
|
5484
|
+
['PureCloud OAuth'],
|
|
5485
|
+
['application/json'],
|
|
5486
|
+
['application/json']
|
|
5487
|
+
);
|
|
5488
|
+
}
|
|
5489
|
+
|
|
5490
|
+
/**
|
|
5491
|
+
* Get a grammar language.
|
|
5492
|
+
*
|
|
5493
|
+
* @param {String} grammarId Grammar ID
|
|
5494
|
+
* @param {String} languageCode Language
|
|
5495
|
+
* getArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5496
|
+
*/
|
|
5497
|
+
getArchitectGrammarLanguage(grammarId, languageCode) {
|
|
5498
|
+
// verify the required parameter 'grammarId' is set
|
|
5499
|
+
if (grammarId === undefined || grammarId === null) {
|
|
5500
|
+
throw 'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';
|
|
5501
|
+
}
|
|
5502
|
+
// verify the required parameter 'languageCode' is set
|
|
5503
|
+
if (languageCode === undefined || languageCode === null) {
|
|
5504
|
+
throw 'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';
|
|
5505
|
+
}
|
|
5506
|
+
|
|
5507
|
+
return this.apiClient.callApi(
|
|
5508
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
|
|
5509
|
+
'GET',
|
|
5510
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
5511
|
+
{ },
|
|
5512
|
+
{ },
|
|
5513
|
+
{ },
|
|
5514
|
+
null,
|
|
5515
|
+
['PureCloud OAuth'],
|
|
5516
|
+
['application/json'],
|
|
5517
|
+
['application/json']
|
|
5518
|
+
);
|
|
5519
|
+
}
|
|
5520
|
+
|
|
5521
|
+
/**
|
|
5522
|
+
* Get a pageable list of grammars, filtered by query parameters
|
|
5523
|
+
* Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
|
|
5524
|
+
* @param {Object} opts Optional parameters
|
|
5525
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5526
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5527
|
+
* @param {Object} opts.sortBy Sort by (default to id)
|
|
5528
|
+
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
5529
|
+
* @param {Array.<String>} opts.id ID
|
|
5530
|
+
* @param {String} opts.name Name
|
|
5531
|
+
* @param {String} opts.description Description
|
|
5532
|
+
* @param {String} opts.nameOrDescription Name or description
|
|
5533
|
+
* @param {Boolean} opts.includeFileUrls Include grammar language file URLs
|
|
5534
|
+
* getArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5535
|
+
*/
|
|
5536
|
+
getArchitectGrammars(opts) {
|
|
5537
|
+
opts = opts || {};
|
|
5538
|
+
|
|
5539
|
+
|
|
5540
|
+
return this.apiClient.callApi(
|
|
5541
|
+
'/api/v2/architect/grammars',
|
|
5542
|
+
'GET',
|
|
5543
|
+
{ },
|
|
5544
|
+
{ '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'] },
|
|
5545
|
+
{ },
|
|
5546
|
+
{ },
|
|
5547
|
+
null,
|
|
5548
|
+
['PureCloud OAuth'],
|
|
5549
|
+
['application/json'],
|
|
5550
|
+
['application/json']
|
|
5551
|
+
);
|
|
5552
|
+
}
|
|
5553
|
+
|
|
5310
5554
|
/**
|
|
5311
5555
|
* Get an IVR config.
|
|
5312
5556
|
*
|
|
@@ -5362,6 +5606,36 @@ class ArchitectApi {
|
|
|
5362
5606
|
);
|
|
5363
5607
|
}
|
|
5364
5608
|
|
|
5609
|
+
/**
|
|
5610
|
+
* Get a pageable list of basic ivr configuration information objects filterable by query parameters.
|
|
5611
|
+
*
|
|
5612
|
+
* @param {Object} opts Optional parameters
|
|
5613
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5614
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5615
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
5616
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5617
|
+
* @param {Array.<String>} opts.id ID of the IVR to filter by.
|
|
5618
|
+
* @param {String} opts.name Name of the IVR to filter by.
|
|
5619
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
5620
|
+
*/
|
|
5621
|
+
getArchitectIvrsDivisionviews(opts) {
|
|
5622
|
+
opts = opts || {};
|
|
5623
|
+
|
|
5624
|
+
|
|
5625
|
+
return this.apiClient.callApi(
|
|
5626
|
+
'/api/v2/architect/ivrs/divisionviews',
|
|
5627
|
+
'GET',
|
|
5628
|
+
{ },
|
|
5629
|
+
{ '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') },
|
|
5630
|
+
{ },
|
|
5631
|
+
{ },
|
|
5632
|
+
null,
|
|
5633
|
+
['PureCloud OAuth'],
|
|
5634
|
+
['application/json'],
|
|
5635
|
+
['application/json']
|
|
5636
|
+
);
|
|
5637
|
+
}
|
|
5638
|
+
|
|
5365
5639
|
/**
|
|
5366
5640
|
* Get specified user prompt
|
|
5367
5641
|
*
|
|
@@ -5595,6 +5869,36 @@ class ArchitectApi {
|
|
|
5595
5869
|
);
|
|
5596
5870
|
}
|
|
5597
5871
|
|
|
5872
|
+
/**
|
|
5873
|
+
* Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
|
|
5874
|
+
*
|
|
5875
|
+
* @param {Object} opts Optional parameters
|
|
5876
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5877
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5878
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
5879
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5880
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
5881
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
5882
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
5883
|
+
*/
|
|
5884
|
+
getArchitectSchedulegroupsDivisionviews(opts) {
|
|
5885
|
+
opts = opts || {};
|
|
5886
|
+
|
|
5887
|
+
|
|
5888
|
+
return this.apiClient.callApi(
|
|
5889
|
+
'/api/v2/architect/schedulegroups/divisionviews',
|
|
5890
|
+
'GET',
|
|
5891
|
+
{ },
|
|
5892
|
+
{ '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') },
|
|
5893
|
+
{ },
|
|
5894
|
+
{ },
|
|
5895
|
+
null,
|
|
5896
|
+
['PureCloud OAuth'],
|
|
5897
|
+
['application/json'],
|
|
5898
|
+
['application/json']
|
|
5899
|
+
);
|
|
5900
|
+
}
|
|
5901
|
+
|
|
5598
5902
|
/**
|
|
5599
5903
|
* Get a list of schedules.
|
|
5600
5904
|
*
|
|
@@ -5624,6 +5928,36 @@ class ArchitectApi {
|
|
|
5624
5928
|
);
|
|
5625
5929
|
}
|
|
5626
5930
|
|
|
5931
|
+
/**
|
|
5932
|
+
* Get a pageable list of basic schedule configuration information objects filterable by query parameters.
|
|
5933
|
+
*
|
|
5934
|
+
* @param {Object} opts Optional parameters
|
|
5935
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5936
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5937
|
+
* @param {String} opts.sortBy Sort by (default to name)
|
|
5938
|
+
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
5939
|
+
* @param {Array.<String>} opts.id ID of the schedule group to filter by.
|
|
5940
|
+
* @param {String} opts.name Name of the schedule group to filter by.
|
|
5941
|
+
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
5942
|
+
*/
|
|
5943
|
+
getArchitectSchedulesDivisionviews(opts) {
|
|
5944
|
+
opts = opts || {};
|
|
5945
|
+
|
|
5946
|
+
|
|
5947
|
+
return this.apiClient.callApi(
|
|
5948
|
+
'/api/v2/architect/schedules/divisionviews',
|
|
5949
|
+
'GET',
|
|
5950
|
+
{ },
|
|
5951
|
+
{ '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') },
|
|
5952
|
+
{ },
|
|
5953
|
+
{ },
|
|
5954
|
+
null,
|
|
5955
|
+
['PureCloud OAuth'],
|
|
5956
|
+
['application/json'],
|
|
5957
|
+
['application/json']
|
|
5958
|
+
);
|
|
5959
|
+
}
|
|
5960
|
+
|
|
5627
5961
|
/**
|
|
5628
5962
|
* Get a system prompt
|
|
5629
5963
|
*
|
|
@@ -5943,6 +6277,125 @@ class ArchitectApi {
|
|
|
5943
6277
|
);
|
|
5944
6278
|
}
|
|
5945
6279
|
|
|
6280
|
+
/**
|
|
6281
|
+
* Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
|
|
6282
|
+
*
|
|
6283
|
+
* @param {String} flowId Flow ID.
|
|
6284
|
+
* @param {String} versionId Version ID.
|
|
6285
|
+
* @param {Object} opts Optional parameters
|
|
6286
|
+
* @param {Object} opts.language Language to filter for
|
|
6287
|
+
*/
|
|
6288
|
+
getFlowVersionHealth(flowId, versionId, opts) {
|
|
6289
|
+
opts = opts || {};
|
|
6290
|
+
|
|
6291
|
+
// verify the required parameter 'flowId' is set
|
|
6292
|
+
if (flowId === undefined || flowId === null) {
|
|
6293
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionHealth';
|
|
6294
|
+
}
|
|
6295
|
+
// verify the required parameter 'versionId' is set
|
|
6296
|
+
if (versionId === undefined || versionId === null) {
|
|
6297
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionHealth';
|
|
6298
|
+
}
|
|
6299
|
+
|
|
6300
|
+
return this.apiClient.callApi(
|
|
6301
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/health',
|
|
6302
|
+
'GET',
|
|
6303
|
+
{ 'flowId': flowId,'versionId': versionId },
|
|
6304
|
+
{ 'language': opts['language'] },
|
|
6305
|
+
{ },
|
|
6306
|
+
{ },
|
|
6307
|
+
null,
|
|
6308
|
+
['PureCloud OAuth'],
|
|
6309
|
+
['application/json'],
|
|
6310
|
+
['application/json']
|
|
6311
|
+
);
|
|
6312
|
+
}
|
|
6313
|
+
|
|
6314
|
+
/**
|
|
6315
|
+
* Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.
|
|
6316
|
+
*
|
|
6317
|
+
* @param {String} flowId Flow ID.
|
|
6318
|
+
* @param {String} versionId Version ID.
|
|
6319
|
+
* @param {String} intentId Intent ID.
|
|
6320
|
+
* @param {Object} language Language to filter for
|
|
6321
|
+
*/
|
|
6322
|
+
getFlowVersionIntentHealth(flowId, versionId, intentId, language) {
|
|
6323
|
+
// verify the required parameter 'flowId' is set
|
|
6324
|
+
if (flowId === undefined || flowId === null) {
|
|
6325
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentHealth';
|
|
6326
|
+
}
|
|
6327
|
+
// verify the required parameter 'versionId' is set
|
|
6328
|
+
if (versionId === undefined || versionId === null) {
|
|
6329
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentHealth';
|
|
6330
|
+
}
|
|
6331
|
+
// verify the required parameter 'intentId' is set
|
|
6332
|
+
if (intentId === undefined || intentId === null) {
|
|
6333
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentHealth';
|
|
6334
|
+
}
|
|
6335
|
+
// verify the required parameter 'language' is set
|
|
6336
|
+
if (language === undefined || language === null) {
|
|
6337
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentHealth';
|
|
6338
|
+
}
|
|
6339
|
+
|
|
6340
|
+
return this.apiClient.callApi(
|
|
6341
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health',
|
|
6342
|
+
'GET',
|
|
6343
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId },
|
|
6344
|
+
{ 'language': language },
|
|
6345
|
+
{ },
|
|
6346
|
+
{ },
|
|
6347
|
+
null,
|
|
6348
|
+
['PureCloud OAuth'],
|
|
6349
|
+
['application/json'],
|
|
6350
|
+
['application/json']
|
|
6351
|
+
);
|
|
6352
|
+
}
|
|
6353
|
+
|
|
6354
|
+
/**
|
|
6355
|
+
* Get health metrics associated with a specific utterance of an intent.
|
|
6356
|
+
*
|
|
6357
|
+
* @param {String} flowId Flow ID.
|
|
6358
|
+
* @param {String} versionId Version ID.
|
|
6359
|
+
* @param {String} intentId Intent ID.
|
|
6360
|
+
* @param {String} utteranceId Utterance ID.
|
|
6361
|
+
* @param {Object} language Language to filter for
|
|
6362
|
+
*/
|
|
6363
|
+
getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language) {
|
|
6364
|
+
// verify the required parameter 'flowId' is set
|
|
6365
|
+
if (flowId === undefined || flowId === null) {
|
|
6366
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6367
|
+
}
|
|
6368
|
+
// verify the required parameter 'versionId' is set
|
|
6369
|
+
if (versionId === undefined || versionId === null) {
|
|
6370
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6371
|
+
}
|
|
6372
|
+
// verify the required parameter 'intentId' is set
|
|
6373
|
+
if (intentId === undefined || intentId === null) {
|
|
6374
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6375
|
+
}
|
|
6376
|
+
// verify the required parameter 'utteranceId' is set
|
|
6377
|
+
if (utteranceId === undefined || utteranceId === null) {
|
|
6378
|
+
throw 'Missing the required parameter "utteranceId" when calling getFlowVersionIntentUtteranceHealth';
|
|
6379
|
+
}
|
|
6380
|
+
// verify the required parameter 'language' is set
|
|
6381
|
+
if (language === undefined || language === null) {
|
|
6382
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentUtteranceHealth';
|
|
6383
|
+
}
|
|
6384
|
+
|
|
6385
|
+
return this.apiClient.callApi(
|
|
6386
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health',
|
|
6387
|
+
'GET',
|
|
6388
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId,'utteranceId': utteranceId },
|
|
6389
|
+
{ 'language': language },
|
|
6390
|
+
{ },
|
|
6391
|
+
{ },
|
|
6392
|
+
null,
|
|
6393
|
+
['PureCloud OAuth'],
|
|
6394
|
+
['application/json'],
|
|
6395
|
+
['application/json']
|
|
6396
|
+
);
|
|
6397
|
+
}
|
|
6398
|
+
|
|
5946
6399
|
/**
|
|
5947
6400
|
* Get flow version list
|
|
5948
6401
|
*
|
|
@@ -6634,6 +7087,36 @@ class ArchitectApi {
|
|
|
6634
7087
|
);
|
|
6635
7088
|
}
|
|
6636
7089
|
|
|
7090
|
+
/**
|
|
7091
|
+
* Updates a grammar
|
|
7092
|
+
*
|
|
7093
|
+
* @param {String} grammarId grammar ID
|
|
7094
|
+
* @param {Object} opts Optional parameters
|
|
7095
|
+
* @param {Object} opts.body
|
|
7096
|
+
* patchArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7097
|
+
*/
|
|
7098
|
+
patchArchitectGrammar(grammarId, opts) {
|
|
7099
|
+
opts = opts || {};
|
|
7100
|
+
|
|
7101
|
+
// verify the required parameter 'grammarId' is set
|
|
7102
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7103
|
+
throw 'Missing the required parameter "grammarId" when calling patchArchitectGrammar';
|
|
7104
|
+
}
|
|
7105
|
+
|
|
7106
|
+
return this.apiClient.callApi(
|
|
7107
|
+
'/api/v2/architect/grammars/{grammarId}',
|
|
7108
|
+
'PATCH',
|
|
7109
|
+
{ 'grammarId': grammarId },
|
|
7110
|
+
{ },
|
|
7111
|
+
{ },
|
|
7112
|
+
{ },
|
|
7113
|
+
opts['body'],
|
|
7114
|
+
['PureCloud OAuth'],
|
|
7115
|
+
['application/json'],
|
|
7116
|
+
['application/json']
|
|
7117
|
+
);
|
|
7118
|
+
}
|
|
7119
|
+
|
|
6637
7120
|
/**
|
|
6638
7121
|
* Rebuild Dependency Tracking data for an organization
|
|
6639
7122
|
* Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
|
@@ -6679,6 +7162,135 @@ class ArchitectApi {
|
|
|
6679
7162
|
);
|
|
6680
7163
|
}
|
|
6681
7164
|
|
|
7165
|
+
/**
|
|
7166
|
+
* Creates a presigned URL for uploading a grammar DTMF mode file
|
|
7167
|
+
*
|
|
7168
|
+
* @param {String} grammarId Grammar ID
|
|
7169
|
+
* @param {String} languageCode Language
|
|
7170
|
+
* @param {Object} body query
|
|
7171
|
+
* postArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7172
|
+
*/
|
|
7173
|
+
postArchitectGrammarLanguageFilesDtmf(grammarId, languageCode, body) {
|
|
7174
|
+
// verify the required parameter 'grammarId' is set
|
|
7175
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7176
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
7177
|
+
}
|
|
7178
|
+
// verify the required parameter 'languageCode' is set
|
|
7179
|
+
if (languageCode === undefined || languageCode === null) {
|
|
7180
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
7181
|
+
}
|
|
7182
|
+
// verify the required parameter 'body' is set
|
|
7183
|
+
if (body === undefined || body === null) {
|
|
7184
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';
|
|
7185
|
+
}
|
|
7186
|
+
|
|
7187
|
+
return this.apiClient.callApi(
|
|
7188
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
|
|
7189
|
+
'POST',
|
|
7190
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
7191
|
+
{ },
|
|
7192
|
+
{ },
|
|
7193
|
+
{ },
|
|
7194
|
+
body,
|
|
7195
|
+
['PureCloud OAuth'],
|
|
7196
|
+
['application/json'],
|
|
7197
|
+
['application/json']
|
|
7198
|
+
);
|
|
7199
|
+
}
|
|
7200
|
+
|
|
7201
|
+
/**
|
|
7202
|
+
* Creates a presigned URL for uploading a grammar voice mode file
|
|
7203
|
+
*
|
|
7204
|
+
* @param {String} grammarId Grammar ID
|
|
7205
|
+
* @param {String} languageCode Language
|
|
7206
|
+
* @param {Object} body query
|
|
7207
|
+
* postArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7208
|
+
*/
|
|
7209
|
+
postArchitectGrammarLanguageFilesVoice(grammarId, languageCode, body) {
|
|
7210
|
+
// verify the required parameter 'grammarId' is set
|
|
7211
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7212
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';
|
|
7213
|
+
}
|
|
7214
|
+
// verify the required parameter 'languageCode' is set
|
|
7215
|
+
if (languageCode === undefined || languageCode === null) {
|
|
7216
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';
|
|
7217
|
+
}
|
|
7218
|
+
// verify the required parameter 'body' is set
|
|
7219
|
+
if (body === undefined || body === null) {
|
|
7220
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';
|
|
7221
|
+
}
|
|
7222
|
+
|
|
7223
|
+
return this.apiClient.callApi(
|
|
7224
|
+
'/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
|
|
7225
|
+
'POST',
|
|
7226
|
+
{ 'grammarId': grammarId,'languageCode': languageCode },
|
|
7227
|
+
{ },
|
|
7228
|
+
{ },
|
|
7229
|
+
{ },
|
|
7230
|
+
body,
|
|
7231
|
+
['PureCloud OAuth'],
|
|
7232
|
+
['application/json'],
|
|
7233
|
+
['application/json']
|
|
7234
|
+
);
|
|
7235
|
+
}
|
|
7236
|
+
|
|
7237
|
+
/**
|
|
7238
|
+
* Create a new language for a given grammar
|
|
7239
|
+
*
|
|
7240
|
+
* @param {String} grammarId Grammar ID
|
|
7241
|
+
* @param {Object} body
|
|
7242
|
+
* postArchitectGrammarLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7243
|
+
*/
|
|
7244
|
+
postArchitectGrammarLanguages(grammarId, body) {
|
|
7245
|
+
// verify the required parameter 'grammarId' is set
|
|
7246
|
+
if (grammarId === undefined || grammarId === null) {
|
|
7247
|
+
throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';
|
|
7248
|
+
}
|
|
7249
|
+
// verify the required parameter 'body' is set
|
|
7250
|
+
if (body === undefined || body === null) {
|
|
7251
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguages';
|
|
7252
|
+
}
|
|
7253
|
+
|
|
7254
|
+
return this.apiClient.callApi(
|
|
7255
|
+
'/api/v2/architect/grammars/{grammarId}/languages',
|
|
7256
|
+
'POST',
|
|
7257
|
+
{ 'grammarId': grammarId },
|
|
7258
|
+
{ },
|
|
7259
|
+
{ },
|
|
7260
|
+
{ },
|
|
7261
|
+
body,
|
|
7262
|
+
['PureCloud OAuth'],
|
|
7263
|
+
['application/json'],
|
|
7264
|
+
['application/json']
|
|
7265
|
+
);
|
|
7266
|
+
}
|
|
7267
|
+
|
|
7268
|
+
/**
|
|
7269
|
+
* Create a new grammar
|
|
7270
|
+
*
|
|
7271
|
+
* @param {Object} body
|
|
7272
|
+
* postArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7273
|
+
*/
|
|
7274
|
+
postArchitectGrammars(body) {
|
|
7275
|
+
// verify the required parameter 'body' is set
|
|
7276
|
+
if (body === undefined || body === null) {
|
|
7277
|
+
throw 'Missing the required parameter "body" when calling postArchitectGrammars';
|
|
7278
|
+
}
|
|
7279
|
+
|
|
7280
|
+
return this.apiClient.callApi(
|
|
7281
|
+
'/api/v2/architect/grammars',
|
|
7282
|
+
'POST',
|
|
7283
|
+
{ },
|
|
7284
|
+
{ },
|
|
7285
|
+
{ },
|
|
7286
|
+
{ },
|
|
7287
|
+
body,
|
|
7288
|
+
['PureCloud OAuth'],
|
|
7289
|
+
['application/json'],
|
|
7290
|
+
['application/json']
|
|
7291
|
+
);
|
|
7292
|
+
}
|
|
7293
|
+
|
|
6682
7294
|
/**
|
|
6683
7295
|
* Create IVR config.
|
|
6684
7296
|
*
|
|
@@ -7772,7 +8384,7 @@ class AuditApi {
|
|
|
7772
8384
|
/**
|
|
7773
8385
|
* Audit service.
|
|
7774
8386
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7775
|
-
* @version
|
|
8387
|
+
* @version 175.0.0
|
|
7776
8388
|
*/
|
|
7777
8389
|
|
|
7778
8390
|
/**
|
|
@@ -7943,7 +8555,7 @@ class AuthorizationApi {
|
|
|
7943
8555
|
/**
|
|
7944
8556
|
* Authorization service.
|
|
7945
8557
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7946
|
-
* @version
|
|
8558
|
+
* @version 175.0.0
|
|
7947
8559
|
*/
|
|
7948
8560
|
|
|
7949
8561
|
/**
|
|
@@ -9174,7 +9786,7 @@ class BillingApi {
|
|
|
9174
9786
|
/**
|
|
9175
9787
|
* Billing service.
|
|
9176
9788
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9177
|
-
* @version
|
|
9789
|
+
* @version 175.0.0
|
|
9178
9790
|
*/
|
|
9179
9791
|
|
|
9180
9792
|
/**
|
|
@@ -9254,7 +9866,7 @@ class CarrierServicesApi {
|
|
|
9254
9866
|
/**
|
|
9255
9867
|
* CarrierServices service.
|
|
9256
9868
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9257
|
-
* @version
|
|
9869
|
+
* @version 175.0.0
|
|
9258
9870
|
*/
|
|
9259
9871
|
|
|
9260
9872
|
/**
|
|
@@ -9324,7 +9936,7 @@ class ChatApi {
|
|
|
9324
9936
|
/**
|
|
9325
9937
|
* Chat service.
|
|
9326
9938
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9327
|
-
* @version
|
|
9939
|
+
* @version 175.0.0
|
|
9328
9940
|
*/
|
|
9329
9941
|
|
|
9330
9942
|
/**
|
|
@@ -9488,7 +10100,7 @@ class CoachingApi {
|
|
|
9488
10100
|
/**
|
|
9489
10101
|
* Coaching service.
|
|
9490
10102
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9491
|
-
* @version
|
|
10103
|
+
* @version 175.0.0
|
|
9492
10104
|
*/
|
|
9493
10105
|
|
|
9494
10106
|
/**
|
|
@@ -10065,7 +10677,7 @@ class ContentManagementApi {
|
|
|
10065
10677
|
/**
|
|
10066
10678
|
* ContentManagement service.
|
|
10067
10679
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10068
|
-
* @version
|
|
10680
|
+
* @version 175.0.0
|
|
10069
10681
|
*/
|
|
10070
10682
|
|
|
10071
10683
|
/**
|
|
@@ -11208,7 +11820,7 @@ class ConversationsApi {
|
|
|
11208
11820
|
/**
|
|
11209
11821
|
* Conversations service.
|
|
11210
11822
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11211
|
-
* @version
|
|
11823
|
+
* @version 175.0.0
|
|
11212
11824
|
*/
|
|
11213
11825
|
|
|
11214
11826
|
/**
|
|
@@ -11373,6 +11985,31 @@ class ConversationsApi {
|
|
|
11373
11985
|
);
|
|
11374
11986
|
}
|
|
11375
11987
|
|
|
11988
|
+
/**
|
|
11989
|
+
* Remove a cached media item asychronously
|
|
11990
|
+
*
|
|
11991
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
11992
|
+
*/
|
|
11993
|
+
deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
11994
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
11995
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
11996
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';
|
|
11997
|
+
}
|
|
11998
|
+
|
|
11999
|
+
return this.apiClient.callApi(
|
|
12000
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
12001
|
+
'DELETE',
|
|
12002
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
12003
|
+
{ },
|
|
12004
|
+
{ },
|
|
12005
|
+
{ },
|
|
12006
|
+
null,
|
|
12007
|
+
['PureCloud OAuth'],
|
|
12008
|
+
['application/json'],
|
|
12009
|
+
['application/json']
|
|
12010
|
+
);
|
|
12011
|
+
}
|
|
12012
|
+
|
|
11376
12013
|
/**
|
|
11377
12014
|
* Delete a Facebook messaging integration
|
|
11378
12015
|
*
|
|
@@ -13174,7 +13811,7 @@ class ConversationsApi {
|
|
|
13174
13811
|
/**
|
|
13175
13812
|
* Get list of wrapup codes for this conversation participant
|
|
13176
13813
|
*
|
|
13177
|
-
* @param {String} conversationId
|
|
13814
|
+
* @param {String} conversationId conversationId
|
|
13178
13815
|
* @param {String} participantId participantId
|
|
13179
13816
|
*/
|
|
13180
13817
|
getConversationsMessageParticipantWrapupcodes(conversationId, participantId) {
|
|
@@ -13221,6 +13858,57 @@ class ConversationsApi {
|
|
|
13221
13858
|
);
|
|
13222
13859
|
}
|
|
13223
13860
|
|
|
13861
|
+
/**
|
|
13862
|
+
* Get a list of cached media items
|
|
13863
|
+
*
|
|
13864
|
+
* @param {Object} opts Optional parameters
|
|
13865
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13866
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13867
|
+
* @param {String} opts.url URL to search for
|
|
13868
|
+
*/
|
|
13869
|
+
getConversationsMessagesCachedmedia(opts) {
|
|
13870
|
+
opts = opts || {};
|
|
13871
|
+
|
|
13872
|
+
|
|
13873
|
+
return this.apiClient.callApi(
|
|
13874
|
+
'/api/v2/conversations/messages/cachedmedia',
|
|
13875
|
+
'GET',
|
|
13876
|
+
{ },
|
|
13877
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'url': opts['url'] },
|
|
13878
|
+
{ },
|
|
13879
|
+
{ },
|
|
13880
|
+
null,
|
|
13881
|
+
['PureCloud OAuth'],
|
|
13882
|
+
['application/json'],
|
|
13883
|
+
['application/json']
|
|
13884
|
+
);
|
|
13885
|
+
}
|
|
13886
|
+
|
|
13887
|
+
/**
|
|
13888
|
+
* Get a cached media item
|
|
13889
|
+
*
|
|
13890
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
13891
|
+
*/
|
|
13892
|
+
getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
13893
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
13894
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
13895
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';
|
|
13896
|
+
}
|
|
13897
|
+
|
|
13898
|
+
return this.apiClient.callApi(
|
|
13899
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
13900
|
+
'GET',
|
|
13901
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
13902
|
+
{ },
|
|
13903
|
+
{ },
|
|
13904
|
+
{ },
|
|
13905
|
+
null,
|
|
13906
|
+
['PureCloud OAuth'],
|
|
13907
|
+
['application/json'],
|
|
13908
|
+
['application/json']
|
|
13909
|
+
);
|
|
13910
|
+
}
|
|
13911
|
+
|
|
13224
13912
|
/**
|
|
13225
13913
|
* Get Genesys Facebook App Id
|
|
13226
13914
|
*
|
|
@@ -13964,6 +14652,32 @@ class ConversationsApi {
|
|
|
13964
14652
|
);
|
|
13965
14653
|
}
|
|
13966
14654
|
|
|
14655
|
+
/**
|
|
14656
|
+
* Gets a record for a given meetingId
|
|
14657
|
+
*
|
|
14658
|
+
* @param {String} meetingId meetingId
|
|
14659
|
+
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14660
|
+
*/
|
|
14661
|
+
getConversationsVideosMeeting(meetingId) {
|
|
14662
|
+
// verify the required parameter 'meetingId' is set
|
|
14663
|
+
if (meetingId === undefined || meetingId === null) {
|
|
14664
|
+
throw 'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';
|
|
14665
|
+
}
|
|
14666
|
+
|
|
14667
|
+
return this.apiClient.callApi(
|
|
14668
|
+
'/api/v2/conversations/videos/meetings/{meetingId}',
|
|
14669
|
+
'GET',
|
|
14670
|
+
{ 'meetingId': meetingId },
|
|
14671
|
+
{ },
|
|
14672
|
+
{ },
|
|
14673
|
+
{ },
|
|
14674
|
+
null,
|
|
14675
|
+
['PureCloud OAuth'],
|
|
14676
|
+
['application/json'],
|
|
14677
|
+
['application/json']
|
|
14678
|
+
);
|
|
14679
|
+
}
|
|
14680
|
+
|
|
13967
14681
|
/**
|
|
13968
14682
|
* Update a participant.
|
|
13969
14683
|
* Update conversation participant.
|
|
@@ -14926,7 +15640,7 @@ class ConversationsApi {
|
|
|
14926
15640
|
/**
|
|
14927
15641
|
* Update conversation participant
|
|
14928
15642
|
*
|
|
14929
|
-
* @param {String} conversationId
|
|
15643
|
+
* @param {String} conversationId conversationId
|
|
14930
15644
|
* @param {String} participantId participantId
|
|
14931
15645
|
* @param {Object} opts Optional parameters
|
|
14932
15646
|
* @param {Object} opts.body
|
|
@@ -14960,7 +15674,7 @@ class ConversationsApi {
|
|
|
14960
15674
|
/**
|
|
14961
15675
|
* Update the attributes on a conversation participant.
|
|
14962
15676
|
*
|
|
14963
|
-
* @param {String} conversationId
|
|
15677
|
+
* @param {String} conversationId conversationId
|
|
14964
15678
|
* @param {String} participantId participantId
|
|
14965
15679
|
* @param {Object} opts Optional parameters
|
|
14966
15680
|
* @param {Object} opts.body
|
|
@@ -14994,7 +15708,7 @@ class ConversationsApi {
|
|
|
14994
15708
|
/**
|
|
14995
15709
|
* Update conversation participant's communication by disconnecting it.
|
|
14996
15710
|
*
|
|
14997
|
-
* @param {String} conversationId
|
|
15711
|
+
* @param {String} conversationId conversationId
|
|
14998
15712
|
* @param {String} participantId participantId
|
|
14999
15713
|
* @param {String} communicationId communicationId
|
|
15000
15714
|
* @param {Object} body Participant
|
|
@@ -16951,6 +17665,96 @@ class ConversationsApi {
|
|
|
16951
17665
|
);
|
|
16952
17666
|
}
|
|
16953
17667
|
|
|
17668
|
+
/**
|
|
17669
|
+
* Send an inbound Open Event Message
|
|
17670
|
+
* 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.
|
|
17671
|
+
* @param {String} integrationId integrationId
|
|
17672
|
+
* @param {Object} body NormalizedMessage
|
|
17673
|
+
*/
|
|
17674
|
+
postConversationsMessageInboundOpenEvent(integrationId, body) {
|
|
17675
|
+
// verify the required parameter 'integrationId' is set
|
|
17676
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17677
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';
|
|
17678
|
+
}
|
|
17679
|
+
// verify the required parameter 'body' is set
|
|
17680
|
+
if (body === undefined || body === null) {
|
|
17681
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';
|
|
17682
|
+
}
|
|
17683
|
+
|
|
17684
|
+
return this.apiClient.callApi(
|
|
17685
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/event',
|
|
17686
|
+
'POST',
|
|
17687
|
+
{ 'integrationId': integrationId },
|
|
17688
|
+
{ },
|
|
17689
|
+
{ },
|
|
17690
|
+
{ },
|
|
17691
|
+
body,
|
|
17692
|
+
['PureCloud OAuth'],
|
|
17693
|
+
['application/json'],
|
|
17694
|
+
['application/json']
|
|
17695
|
+
);
|
|
17696
|
+
}
|
|
17697
|
+
|
|
17698
|
+
/**
|
|
17699
|
+
* Send inbound Open Message
|
|
17700
|
+
* 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.
|
|
17701
|
+
* @param {String} integrationId integrationId
|
|
17702
|
+
* @param {Object} body NormalizedMessage
|
|
17703
|
+
*/
|
|
17704
|
+
postConversationsMessageInboundOpenMessage(integrationId, body) {
|
|
17705
|
+
// verify the required parameter 'integrationId' is set
|
|
17706
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17707
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
|
|
17708
|
+
}
|
|
17709
|
+
// verify the required parameter 'body' is set
|
|
17710
|
+
if (body === undefined || body === null) {
|
|
17711
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';
|
|
17712
|
+
}
|
|
17713
|
+
|
|
17714
|
+
return this.apiClient.callApi(
|
|
17715
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/message',
|
|
17716
|
+
'POST',
|
|
17717
|
+
{ 'integrationId': integrationId },
|
|
17718
|
+
{ },
|
|
17719
|
+
{ },
|
|
17720
|
+
{ },
|
|
17721
|
+
body,
|
|
17722
|
+
['PureCloud OAuth'],
|
|
17723
|
+
['application/json'],
|
|
17724
|
+
['application/json']
|
|
17725
|
+
);
|
|
17726
|
+
}
|
|
17727
|
+
|
|
17728
|
+
/**
|
|
17729
|
+
* Send an inbound Open Receipt Message
|
|
17730
|
+
* 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.
|
|
17731
|
+
* @param {String} integrationId integrationId
|
|
17732
|
+
* @param {Object} body NormalizedMessage
|
|
17733
|
+
*/
|
|
17734
|
+
postConversationsMessageInboundOpenReceipt(integrationId, body) {
|
|
17735
|
+
// verify the required parameter 'integrationId' is set
|
|
17736
|
+
if (integrationId === undefined || integrationId === null) {
|
|
17737
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';
|
|
17738
|
+
}
|
|
17739
|
+
// verify the required parameter 'body' is set
|
|
17740
|
+
if (body === undefined || body === null) {
|
|
17741
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';
|
|
17742
|
+
}
|
|
17743
|
+
|
|
17744
|
+
return this.apiClient.callApi(
|
|
17745
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/receipt',
|
|
17746
|
+
'POST',
|
|
17747
|
+
{ 'integrationId': integrationId },
|
|
17748
|
+
{ },
|
|
17749
|
+
{ },
|
|
17750
|
+
{ },
|
|
17751
|
+
body,
|
|
17752
|
+
['PureCloud OAuth'],
|
|
17753
|
+
['application/json'],
|
|
17754
|
+
['application/json']
|
|
17755
|
+
);
|
|
17756
|
+
}
|
|
17757
|
+
|
|
16954
17758
|
/**
|
|
16955
17759
|
* Get messages in batch
|
|
16956
17760
|
* 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"]
|
|
@@ -17434,24 +18238,63 @@ class ConversationsApi {
|
|
|
17434
18238
|
* @param {Object} opts Optional parameters
|
|
17435
18239
|
* @param {Object} opts.body Wrap-up
|
|
17436
18240
|
*/
|
|
17437
|
-
postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
18241
|
+
postConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
18242
|
+
opts = opts || {};
|
|
18243
|
+
|
|
18244
|
+
// verify the required parameter 'conversationId' is set
|
|
18245
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18246
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
18247
|
+
}
|
|
18248
|
+
// verify the required parameter 'participantId' is set
|
|
18249
|
+
if (participantId === undefined || participantId === null) {
|
|
18250
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
18251
|
+
}
|
|
18252
|
+
// verify the required parameter 'communicationId' is set
|
|
18253
|
+
if (communicationId === undefined || communicationId === null) {
|
|
18254
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsSocialParticipantCommunicationWrapup';
|
|
18255
|
+
}
|
|
18256
|
+
|
|
18257
|
+
return this.apiClient.callApi(
|
|
18258
|
+
'/api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup',
|
|
18259
|
+
'POST',
|
|
18260
|
+
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
18261
|
+
{ },
|
|
18262
|
+
{ },
|
|
18263
|
+
{ },
|
|
18264
|
+
opts['body'],
|
|
18265
|
+
['PureCloud OAuth'],
|
|
18266
|
+
['application/json'],
|
|
18267
|
+
['application/json']
|
|
18268
|
+
);
|
|
18269
|
+
}
|
|
18270
|
+
|
|
18271
|
+
/**
|
|
18272
|
+
* Apply wrap-up for this conversation communication
|
|
18273
|
+
*
|
|
18274
|
+
* @param {String} conversationId conversationId
|
|
18275
|
+
* @param {String} participantId participantId
|
|
18276
|
+
* @param {String} communicationId communicationId
|
|
18277
|
+
* @param {Object} opts Optional parameters
|
|
18278
|
+
* @param {Object} opts.body Wrap-up
|
|
18279
|
+
*/
|
|
18280
|
+
postConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
17438
18281
|
opts = opts || {};
|
|
17439
18282
|
|
|
17440
18283
|
// verify the required parameter 'conversationId' is set
|
|
17441
18284
|
if (conversationId === undefined || conversationId === null) {
|
|
17442
|
-
throw 'Missing the required parameter "conversationId" when calling
|
|
18285
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17443
18286
|
}
|
|
17444
18287
|
// verify the required parameter 'participantId' is set
|
|
17445
18288
|
if (participantId === undefined || participantId === null) {
|
|
17446
|
-
throw 'Missing the required parameter "participantId" when calling
|
|
18289
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17447
18290
|
}
|
|
17448
18291
|
// verify the required parameter 'communicationId' is set
|
|
17449
18292
|
if (communicationId === undefined || communicationId === null) {
|
|
17450
|
-
throw 'Missing the required parameter "communicationId" when calling
|
|
18293
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17451
18294
|
}
|
|
17452
18295
|
|
|
17453
18296
|
return this.apiClient.callApi(
|
|
17454
|
-
'/api/v2/conversations/
|
|
18297
|
+
'/api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup',
|
|
17455
18298
|
'POST',
|
|
17456
18299
|
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
17457
18300
|
{ },
|
|
@@ -17465,38 +18308,25 @@ class ConversationsApi {
|
|
|
17465
18308
|
}
|
|
17466
18309
|
|
|
17467
18310
|
/**
|
|
17468
|
-
*
|
|
18311
|
+
* Generate a meetingId for a given conferenceId
|
|
17469
18312
|
*
|
|
17470
|
-
* @param {
|
|
17471
|
-
*
|
|
17472
|
-
* @param {String} communicationId communicationId
|
|
17473
|
-
* @param {Object} opts Optional parameters
|
|
17474
|
-
* @param {Object} opts.body Wrap-up
|
|
18313
|
+
* @param {Object} body MeetingIdRequest
|
|
18314
|
+
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17475
18315
|
*/
|
|
17476
|
-
|
|
17477
|
-
|
|
17478
|
-
|
|
17479
|
-
|
|
17480
|
-
if (conversationId === undefined || conversationId === null) {
|
|
17481
|
-
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17482
|
-
}
|
|
17483
|
-
// verify the required parameter 'participantId' is set
|
|
17484
|
-
if (participantId === undefined || participantId === null) {
|
|
17485
|
-
throw 'Missing the required parameter "participantId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
17486
|
-
}
|
|
17487
|
-
// verify the required parameter 'communicationId' is set
|
|
17488
|
-
if (communicationId === undefined || communicationId === null) {
|
|
17489
|
-
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoParticipantCommunicationWrapup';
|
|
18316
|
+
postConversationsVideosMeetings(body) {
|
|
18317
|
+
// verify the required parameter 'body' is set
|
|
18318
|
+
if (body === undefined || body === null) {
|
|
18319
|
+
throw 'Missing the required parameter "body" when calling postConversationsVideosMeetings';
|
|
17490
18320
|
}
|
|
17491
18321
|
|
|
17492
18322
|
return this.apiClient.callApi(
|
|
17493
|
-
'/api/v2/conversations/videos/
|
|
18323
|
+
'/api/v2/conversations/videos/meetings',
|
|
17494
18324
|
'POST',
|
|
17495
|
-
{ 'conversationId': conversationId,'participantId': participantId,'communicationId': communicationId },
|
|
17496
18325
|
{ },
|
|
17497
18326
|
{ },
|
|
17498
18327
|
{ },
|
|
17499
|
-
|
|
18328
|
+
{ },
|
|
18329
|
+
body,
|
|
17500
18330
|
['PureCloud OAuth'],
|
|
17501
18331
|
['application/json'],
|
|
17502
18332
|
['application/json']
|
|
@@ -18074,7 +18904,7 @@ class DataExtensionsApi {
|
|
|
18074
18904
|
/**
|
|
18075
18905
|
* DataExtensions service.
|
|
18076
18906
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
18077
|
-
* @version
|
|
18907
|
+
* @version 175.0.0
|
|
18078
18908
|
*/
|
|
18079
18909
|
|
|
18080
18910
|
/**
|
|
@@ -18160,7 +18990,7 @@ class DownloadsApi {
|
|
|
18160
18990
|
/**
|
|
18161
18991
|
* Downloads service.
|
|
18162
18992
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
18163
|
-
* @version
|
|
18993
|
+
* @version 175.0.0
|
|
18164
18994
|
*/
|
|
18165
18995
|
|
|
18166
18996
|
/**
|
|
@@ -18212,7 +19042,7 @@ class EmailsApi {
|
|
|
18212
19042
|
/**
|
|
18213
19043
|
* Emails service.
|
|
18214
19044
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
18215
|
-
* @version
|
|
19045
|
+
* @version 175.0.0
|
|
18216
19046
|
*/
|
|
18217
19047
|
|
|
18218
19048
|
/**
|
|
@@ -18277,7 +19107,7 @@ class EventsApi {
|
|
|
18277
19107
|
/**
|
|
18278
19108
|
* Events service.
|
|
18279
19109
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
18280
|
-
* @version
|
|
19110
|
+
* @version 175.0.0
|
|
18281
19111
|
*/
|
|
18282
19112
|
|
|
18283
19113
|
/**
|
|
@@ -18373,7 +19203,7 @@ class ExternalContactsApi {
|
|
|
18373
19203
|
/**
|
|
18374
19204
|
* ExternalContacts service.
|
|
18375
19205
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
18376
|
-
* @version
|
|
19206
|
+
* @version 175.0.0
|
|
18377
19207
|
*/
|
|
18378
19208
|
|
|
18379
19209
|
/**
|
|
@@ -20331,7 +21161,7 @@ class FaxApi {
|
|
|
20331
21161
|
/**
|
|
20332
21162
|
* Fax service.
|
|
20333
21163
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
20334
|
-
* @version
|
|
21164
|
+
* @version 175.0.0
|
|
20335
21165
|
*/
|
|
20336
21166
|
|
|
20337
21167
|
/**
|
|
@@ -20502,7 +21332,7 @@ class FlowsApi {
|
|
|
20502
21332
|
/**
|
|
20503
21333
|
* Flows service.
|
|
20504
21334
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
20505
|
-
* @version
|
|
21335
|
+
* @version 175.0.0
|
|
20506
21336
|
*/
|
|
20507
21337
|
|
|
20508
21338
|
/**
|
|
@@ -20686,7 +21516,7 @@ class GamificationApi {
|
|
|
20686
21516
|
/**
|
|
20687
21517
|
* Gamification service.
|
|
20688
21518
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
20689
|
-
* @version
|
|
21519
|
+
* @version 175.0.0
|
|
20690
21520
|
*/
|
|
20691
21521
|
|
|
20692
21522
|
/**
|
|
@@ -22772,7 +23602,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
22772
23602
|
/**
|
|
22773
23603
|
* GeneralDataProtectionRegulation service.
|
|
22774
23604
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
22775
|
-
* @version
|
|
23605
|
+
* @version 175.0.0
|
|
22776
23606
|
*/
|
|
22777
23607
|
|
|
22778
23608
|
/**
|
|
@@ -22902,7 +23732,7 @@ class GeolocationApi {
|
|
|
22902
23732
|
/**
|
|
22903
23733
|
* Geolocation service.
|
|
22904
23734
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
22905
|
-
* @version
|
|
23735
|
+
* @version 175.0.0
|
|
22906
23736
|
*/
|
|
22907
23737
|
|
|
22908
23738
|
/**
|
|
@@ -23033,7 +23863,7 @@ class GreetingsApi {
|
|
|
23033
23863
|
/**
|
|
23034
23864
|
* Greetings service.
|
|
23035
23865
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
23036
|
-
* @version
|
|
23866
|
+
* @version 175.0.0
|
|
23037
23867
|
*/
|
|
23038
23868
|
|
|
23039
23869
|
/**
|
|
@@ -23488,7 +24318,7 @@ class GroupsApi {
|
|
|
23488
24318
|
/**
|
|
23489
24319
|
* Groups service.
|
|
23490
24320
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
23491
|
-
* @version
|
|
24321
|
+
* @version 175.0.0
|
|
23492
24322
|
*/
|
|
23493
24323
|
|
|
23494
24324
|
/**
|
|
@@ -24007,7 +24837,7 @@ class IdentityProviderApi {
|
|
|
24007
24837
|
/**
|
|
24008
24838
|
* IdentityProvider service.
|
|
24009
24839
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
24010
|
-
* @version
|
|
24840
|
+
* @version 175.0.0
|
|
24011
24841
|
*/
|
|
24012
24842
|
|
|
24013
24843
|
/**
|
|
@@ -24763,7 +25593,7 @@ class InfrastructureAsCodeApi {
|
|
|
24763
25593
|
/**
|
|
24764
25594
|
* InfrastructureAsCode service.
|
|
24765
25595
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
24766
|
-
* @version
|
|
25596
|
+
* @version 175.0.0
|
|
24767
25597
|
*/
|
|
24768
25598
|
|
|
24769
25599
|
/**
|
|
@@ -24930,7 +25760,7 @@ class IntegrationsApi {
|
|
|
24930
25760
|
/**
|
|
24931
25761
|
* Integrations service.
|
|
24932
25762
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
24933
|
-
* @version
|
|
25763
|
+
* @version 175.0.0
|
|
24934
25764
|
*/
|
|
24935
25765
|
|
|
24936
25766
|
/**
|
|
@@ -26892,7 +27722,7 @@ class JourneyApi {
|
|
|
26892
27722
|
/**
|
|
26893
27723
|
* Journey service.
|
|
26894
27724
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
26895
|
-
* @version
|
|
27725
|
+
* @version 175.0.0
|
|
26896
27726
|
*/
|
|
26897
27727
|
|
|
26898
27728
|
/**
|
|
@@ -27092,6 +27922,37 @@ class JourneyApi {
|
|
|
27092
27922
|
);
|
|
27093
27923
|
}
|
|
27094
27924
|
|
|
27925
|
+
/**
|
|
27926
|
+
* Retrieve all sessions for a given external contact.
|
|
27927
|
+
*
|
|
27928
|
+
* @param {String} contactId ExternalContact ID
|
|
27929
|
+
* @param {Object} opts Optional parameters
|
|
27930
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
27931
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
27932
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
27933
|
+
*/
|
|
27934
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
27935
|
+
opts = opts || {};
|
|
27936
|
+
|
|
27937
|
+
// verify the required parameter 'contactId' is set
|
|
27938
|
+
if (contactId === undefined || contactId === null) {
|
|
27939
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
27940
|
+
}
|
|
27941
|
+
|
|
27942
|
+
return this.apiClient.callApi(
|
|
27943
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
27944
|
+
'GET',
|
|
27945
|
+
{ 'contactId': contactId },
|
|
27946
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
27947
|
+
{ },
|
|
27948
|
+
{ },
|
|
27949
|
+
null,
|
|
27950
|
+
['PureCloud OAuth'],
|
|
27951
|
+
['application/json'],
|
|
27952
|
+
['application/json']
|
|
27953
|
+
);
|
|
27954
|
+
}
|
|
27955
|
+
|
|
27095
27956
|
/**
|
|
27096
27957
|
* Retrieve a single action map.
|
|
27097
27958
|
*
|
|
@@ -27892,6 +28753,36 @@ class JourneyApi {
|
|
|
27892
28753
|
);
|
|
27893
28754
|
}
|
|
27894
28755
|
|
|
28756
|
+
/**
|
|
28757
|
+
* Send a journey app event, used for tracking customer activity on an application.
|
|
28758
|
+
*
|
|
28759
|
+
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
28760
|
+
* @param {Object} opts Optional parameters
|
|
28761
|
+
* @param {Object} opts.body
|
|
28762
|
+
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28763
|
+
*/
|
|
28764
|
+
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
28765
|
+
opts = opts || {};
|
|
28766
|
+
|
|
28767
|
+
// verify the required parameter 'deploymentId' is set
|
|
28768
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
28769
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';
|
|
28770
|
+
}
|
|
28771
|
+
|
|
28772
|
+
return this.apiClient.callApi(
|
|
28773
|
+
'/api/v2/journey/deployments/{deploymentId}/appevents',
|
|
28774
|
+
'POST',
|
|
28775
|
+
{ 'deploymentId': deploymentId },
|
|
28776
|
+
{ },
|
|
28777
|
+
{ },
|
|
28778
|
+
{ },
|
|
28779
|
+
opts['body'],
|
|
28780
|
+
['PureCloud OAuth'],
|
|
28781
|
+
['application/json'],
|
|
28782
|
+
['application/json']
|
|
28783
|
+
);
|
|
28784
|
+
}
|
|
28785
|
+
|
|
27895
28786
|
/**
|
|
27896
28787
|
* Create an outcome.
|
|
27897
28788
|
*
|
|
@@ -27995,7 +28886,7 @@ class KnowledgeApi {
|
|
|
27995
28886
|
/**
|
|
27996
28887
|
* Knowledge service.
|
|
27997
28888
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
27998
|
-
* @version
|
|
28889
|
+
* @version 175.0.0
|
|
27999
28890
|
*/
|
|
28000
28891
|
|
|
28001
28892
|
/**
|
|
@@ -28552,6 +29443,85 @@ class KnowledgeApi {
|
|
|
28552
29443
|
);
|
|
28553
29444
|
}
|
|
28554
29445
|
|
|
29446
|
+
/**
|
|
29447
|
+
* Get a list of feedback records given on a document
|
|
29448
|
+
*
|
|
29449
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
29450
|
+
* @param {String} documentId Document ID.
|
|
29451
|
+
* @param {Object} opts Optional parameters
|
|
29452
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
29453
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
29454
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
29455
|
+
* @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.
|
|
29456
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
29457
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
29458
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
29459
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
29460
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
29461
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
29462
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
29463
|
+
*/
|
|
29464
|
+
getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
29465
|
+
opts = opts || {};
|
|
29466
|
+
|
|
29467
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
29468
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
29469
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
29470
|
+
}
|
|
29471
|
+
// verify the required parameter 'documentId' is set
|
|
29472
|
+
if (documentId === undefined || documentId === null) {
|
|
29473
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
29474
|
+
}
|
|
29475
|
+
|
|
29476
|
+
return this.apiClient.callApi(
|
|
29477
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
29478
|
+
'GET',
|
|
29479
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
29480
|
+
{ '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'] },
|
|
29481
|
+
{ },
|
|
29482
|
+
{ },
|
|
29483
|
+
null,
|
|
29484
|
+
['PureCloud OAuth'],
|
|
29485
|
+
['application/json'],
|
|
29486
|
+
['application/json']
|
|
29487
|
+
);
|
|
29488
|
+
}
|
|
29489
|
+
|
|
29490
|
+
/**
|
|
29491
|
+
* Get a single feedback record given on a document
|
|
29492
|
+
*
|
|
29493
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
29494
|
+
* @param {String} documentId Document ID.
|
|
29495
|
+
* @param {String} feedbackId Feedback ID.
|
|
29496
|
+
*/
|
|
29497
|
+
getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId) {
|
|
29498
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
29499
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
29500
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
29501
|
+
}
|
|
29502
|
+
// verify the required parameter 'documentId' is set
|
|
29503
|
+
if (documentId === undefined || documentId === null) {
|
|
29504
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
29505
|
+
}
|
|
29506
|
+
// verify the required parameter 'feedbackId' is set
|
|
29507
|
+
if (feedbackId === undefined || feedbackId === null) {
|
|
29508
|
+
throw 'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
29509
|
+
}
|
|
29510
|
+
|
|
29511
|
+
return this.apiClient.callApi(
|
|
29512
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
|
|
29513
|
+
'GET',
|
|
29514
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
|
|
29515
|
+
{ },
|
|
29516
|
+
{ },
|
|
29517
|
+
{ },
|
|
29518
|
+
null,
|
|
29519
|
+
['PureCloud OAuth'],
|
|
29520
|
+
['application/json'],
|
|
29521
|
+
['application/json']
|
|
29522
|
+
);
|
|
29523
|
+
}
|
|
29524
|
+
|
|
28555
29525
|
/**
|
|
28556
29526
|
* Get a variation for a document.
|
|
28557
29527
|
*
|
|
@@ -28859,8 +29829,12 @@ class KnowledgeApi {
|
|
|
28859
29829
|
*
|
|
28860
29830
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28861
29831
|
* @param {String} importJobId Import job ID
|
|
29832
|
+
* @param {Object} opts Optional parameters
|
|
29833
|
+
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
28862
29834
|
*/
|
|
28863
|
-
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
29835
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, opts) {
|
|
29836
|
+
opts = opts || {};
|
|
29837
|
+
|
|
28864
29838
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
28865
29839
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
28866
29840
|
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
@@ -28874,7 +29848,7 @@ class KnowledgeApi {
|
|
|
28874
29848
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
28875
29849
|
'GET',
|
|
28876
29850
|
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
28877
|
-
{
|
|
29851
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
28878
29852
|
{ },
|
|
28879
29853
|
{ },
|
|
28880
29854
|
null,
|
|
@@ -29897,6 +30871,40 @@ class KnowledgeApi {
|
|
|
29897
30871
|
);
|
|
29898
30872
|
}
|
|
29899
30873
|
|
|
30874
|
+
/**
|
|
30875
|
+
* Give feedback on a document
|
|
30876
|
+
*
|
|
30877
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
30878
|
+
* @param {String} documentId Document ID.
|
|
30879
|
+
* @param {Object} opts Optional parameters
|
|
30880
|
+
* @param {Object} opts.body
|
|
30881
|
+
*/
|
|
30882
|
+
postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, opts) {
|
|
30883
|
+
opts = opts || {};
|
|
30884
|
+
|
|
30885
|
+
// verify the required parameter 'sessionId' is set
|
|
30886
|
+
if (sessionId === undefined || sessionId === null) {
|
|
30887
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
30888
|
+
}
|
|
30889
|
+
// verify the required parameter 'documentId' is set
|
|
30890
|
+
if (documentId === undefined || documentId === null) {
|
|
30891
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
30892
|
+
}
|
|
30893
|
+
|
|
30894
|
+
return this.apiClient.callApi(
|
|
30895
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback',
|
|
30896
|
+
'POST',
|
|
30897
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
30898
|
+
{ },
|
|
30899
|
+
{ },
|
|
30900
|
+
{ },
|
|
30901
|
+
opts['body'],
|
|
30902
|
+
['PureCloud OAuth'],
|
|
30903
|
+
['application/json'],
|
|
30904
|
+
['application/json']
|
|
30905
|
+
);
|
|
30906
|
+
}
|
|
30907
|
+
|
|
29900
30908
|
/**
|
|
29901
30909
|
* Search the documents in a guest session.
|
|
29902
30910
|
*
|
|
@@ -30011,6 +31019,40 @@ class KnowledgeApi {
|
|
|
30011
31019
|
);
|
|
30012
31020
|
}
|
|
30013
31021
|
|
|
31022
|
+
/**
|
|
31023
|
+
* Give feedback on a document
|
|
31024
|
+
*
|
|
31025
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31026
|
+
* @param {String} documentId Document ID.
|
|
31027
|
+
* @param {Object} opts Optional parameters
|
|
31028
|
+
* @param {Object} opts.body
|
|
31029
|
+
*/
|
|
31030
|
+
postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
31031
|
+
opts = opts || {};
|
|
31032
|
+
|
|
31033
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31034
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31035
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
31036
|
+
}
|
|
31037
|
+
// verify the required parameter 'documentId' is set
|
|
31038
|
+
if (documentId === undefined || documentId === null) {
|
|
31039
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
31040
|
+
}
|
|
31041
|
+
|
|
31042
|
+
return this.apiClient.callApi(
|
|
31043
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
31044
|
+
'POST',
|
|
31045
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31046
|
+
{ },
|
|
31047
|
+
{ },
|
|
31048
|
+
{ },
|
|
31049
|
+
opts['body'],
|
|
31050
|
+
['PureCloud OAuth'],
|
|
31051
|
+
['application/json'],
|
|
31052
|
+
['application/json']
|
|
31053
|
+
);
|
|
31054
|
+
}
|
|
31055
|
+
|
|
30014
31056
|
/**
|
|
30015
31057
|
* Create a variation for a document.
|
|
30016
31058
|
*
|
|
@@ -30081,6 +31123,40 @@ class KnowledgeApi {
|
|
|
30081
31123
|
);
|
|
30082
31124
|
}
|
|
30083
31125
|
|
|
31126
|
+
/**
|
|
31127
|
+
* Create view for a document.
|
|
31128
|
+
*
|
|
31129
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
31130
|
+
* @param {String} documentId Document ID.
|
|
31131
|
+
* @param {Object} opts Optional parameters
|
|
31132
|
+
* @param {Object} opts.body
|
|
31133
|
+
*/
|
|
31134
|
+
postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, opts) {
|
|
31135
|
+
opts = opts || {};
|
|
31136
|
+
|
|
31137
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
31138
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
31139
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
31140
|
+
}
|
|
31141
|
+
// verify the required parameter 'documentId' is set
|
|
31142
|
+
if (documentId === undefined || documentId === null) {
|
|
31143
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
31144
|
+
}
|
|
31145
|
+
|
|
31146
|
+
return this.apiClient.callApi(
|
|
31147
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views',
|
|
31148
|
+
'POST',
|
|
31149
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
31150
|
+
{ },
|
|
31151
|
+
{ },
|
|
31152
|
+
{ },
|
|
31153
|
+
opts['body'],
|
|
31154
|
+
['PureCloud OAuth'],
|
|
31155
|
+
['application/json'],
|
|
31156
|
+
['application/json']
|
|
31157
|
+
);
|
|
31158
|
+
}
|
|
31159
|
+
|
|
30084
31160
|
/**
|
|
30085
31161
|
* Create document.
|
|
30086
31162
|
*
|
|
@@ -30631,7 +31707,7 @@ class LanguageUnderstandingApi {
|
|
|
30631
31707
|
/**
|
|
30632
31708
|
* LanguageUnderstanding service.
|
|
30633
31709
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
30634
|
-
* @version
|
|
31710
|
+
* @version 175.0.0
|
|
30635
31711
|
*/
|
|
30636
31712
|
|
|
30637
31713
|
/**
|
|
@@ -31644,7 +32720,7 @@ class LanguagesApi {
|
|
|
31644
32720
|
/**
|
|
31645
32721
|
* Languages service.
|
|
31646
32722
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
31647
|
-
* @version
|
|
32723
|
+
* @version 175.0.0
|
|
31648
32724
|
*/
|
|
31649
32725
|
|
|
31650
32726
|
/**
|
|
@@ -31866,7 +32942,7 @@ class LearningApi {
|
|
|
31866
32942
|
/**
|
|
31867
32943
|
* Learning service.
|
|
31868
32944
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
31869
|
-
* @version
|
|
32945
|
+
* @version 175.0.0
|
|
31870
32946
|
*/
|
|
31871
32947
|
|
|
31872
32948
|
/**
|
|
@@ -32509,8 +33585,12 @@ class LearningApi {
|
|
|
32509
33585
|
* Publish a Learning module
|
|
32510
33586
|
*
|
|
32511
33587
|
* @param {String} moduleId The ID of the learning module
|
|
33588
|
+
* @param {Object} opts Optional parameters
|
|
33589
|
+
* @param {Object} opts.body The request body
|
|
32512
33590
|
*/
|
|
32513
|
-
postLearningModulePublish(moduleId) {
|
|
33591
|
+
postLearningModulePublish(moduleId, opts) {
|
|
33592
|
+
opts = opts || {};
|
|
33593
|
+
|
|
32514
33594
|
// verify the required parameter 'moduleId' is set
|
|
32515
33595
|
if (moduleId === undefined || moduleId === null) {
|
|
32516
33596
|
throw 'Missing the required parameter "moduleId" when calling postLearningModulePublish';
|
|
@@ -32523,7 +33603,7 @@ class LearningApi {
|
|
|
32523
33603
|
{ },
|
|
32524
33604
|
{ },
|
|
32525
33605
|
{ },
|
|
32526
|
-
|
|
33606
|
+
opts['body'],
|
|
32527
33607
|
['PureCloud OAuth'],
|
|
32528
33608
|
['application/json'],
|
|
32529
33609
|
['application/json']
|
|
@@ -32681,7 +33761,7 @@ class LicenseApi {
|
|
|
32681
33761
|
/**
|
|
32682
33762
|
* License service.
|
|
32683
33763
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
32684
|
-
* @version
|
|
33764
|
+
* @version 175.0.0
|
|
32685
33765
|
*/
|
|
32686
33766
|
|
|
32687
33767
|
/**
|
|
@@ -32919,7 +33999,7 @@ class LocationsApi {
|
|
|
32919
33999
|
/**
|
|
32920
34000
|
* Locations service.
|
|
32921
34001
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
32922
|
-
* @version
|
|
34002
|
+
* @version 175.0.0
|
|
32923
34003
|
*/
|
|
32924
34004
|
|
|
32925
34005
|
/**
|
|
@@ -33155,7 +34235,7 @@ class MessagingApi {
|
|
|
33155
34235
|
/**
|
|
33156
34236
|
* Messaging service.
|
|
33157
34237
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
33158
|
-
* @version
|
|
34238
|
+
* @version 175.0.0
|
|
33159
34239
|
*/
|
|
33160
34240
|
|
|
33161
34241
|
/**
|
|
@@ -33514,7 +34594,7 @@ class MobileDevicesApi {
|
|
|
33514
34594
|
/**
|
|
33515
34595
|
* MobileDevices service.
|
|
33516
34596
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
33517
|
-
* @version
|
|
34597
|
+
* @version 175.0.0
|
|
33518
34598
|
*/
|
|
33519
34599
|
|
|
33520
34600
|
/**
|
|
@@ -33665,7 +34745,7 @@ class NotificationsApi {
|
|
|
33665
34745
|
/**
|
|
33666
34746
|
* Notifications service.
|
|
33667
34747
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
33668
|
-
* @version
|
|
34748
|
+
* @version 175.0.0
|
|
33669
34749
|
*/
|
|
33670
34750
|
|
|
33671
34751
|
/**
|
|
@@ -33898,7 +34978,7 @@ class OAuthApi {
|
|
|
33898
34978
|
/**
|
|
33899
34979
|
* OAuth service.
|
|
33900
34980
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
33901
|
-
* @version
|
|
34981
|
+
* @version 175.0.0
|
|
33902
34982
|
*/
|
|
33903
34983
|
|
|
33904
34984
|
/**
|
|
@@ -34264,7 +35344,7 @@ class ObjectsApi {
|
|
|
34264
35344
|
/**
|
|
34265
35345
|
* Objects service.
|
|
34266
35346
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
34267
|
-
* @version
|
|
35347
|
+
* @version 175.0.0
|
|
34268
35348
|
*/
|
|
34269
35349
|
|
|
34270
35350
|
/**
|
|
@@ -34535,7 +35615,7 @@ class OrganizationApi {
|
|
|
34535
35615
|
/**
|
|
34536
35616
|
* Organization service.
|
|
34537
35617
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
34538
|
-
* @version
|
|
35618
|
+
* @version 175.0.0
|
|
34539
35619
|
*/
|
|
34540
35620
|
|
|
34541
35621
|
/**
|
|
@@ -34990,7 +36070,7 @@ class OrganizationAuthorizationApi {
|
|
|
34990
36070
|
/**
|
|
34991
36071
|
* OrganizationAuthorization service.
|
|
34992
36072
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
34993
|
-
* @version
|
|
36073
|
+
* @version 175.0.0
|
|
34994
36074
|
*/
|
|
34995
36075
|
|
|
34996
36076
|
/**
|
|
@@ -36337,7 +37417,7 @@ class OutboundApi {
|
|
|
36337
37417
|
/**
|
|
36338
37418
|
* Outbound service.
|
|
36339
37419
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
36340
|
-
* @version
|
|
37420
|
+
* @version 175.0.0
|
|
36341
37421
|
*/
|
|
36342
37422
|
|
|
36343
37423
|
/**
|
|
@@ -39959,7 +41039,7 @@ class PresenceApi {
|
|
|
39959
41039
|
/**
|
|
39960
41040
|
* Presence service.
|
|
39961
41041
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
39962
|
-
* @version
|
|
41042
|
+
* @version 175.0.0
|
|
39963
41043
|
*/
|
|
39964
41044
|
|
|
39965
41045
|
/**
|
|
@@ -40698,7 +41778,7 @@ class ProcessAutomationApi {
|
|
|
40698
41778
|
/**
|
|
40699
41779
|
* ProcessAutomation service.
|
|
40700
41780
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
40701
|
-
* @version
|
|
41781
|
+
* @version 175.0.0
|
|
40702
41782
|
*/
|
|
40703
41783
|
|
|
40704
41784
|
/**
|
|
@@ -40937,7 +42017,7 @@ class QualityApi {
|
|
|
40937
42017
|
/**
|
|
40938
42018
|
* Quality service.
|
|
40939
42019
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
40940
|
-
* @version
|
|
42020
|
+
* @version 175.0.0
|
|
40941
42021
|
*/
|
|
40942
42022
|
|
|
40943
42023
|
/**
|
|
@@ -41220,6 +42300,7 @@ class QualityApi {
|
|
|
41220
42300
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
41221
42301
|
* @param {String} opts.name name
|
|
41222
42302
|
* @param {String} opts.group group id
|
|
42303
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
41223
42304
|
*/
|
|
41224
42305
|
getQualityAgentsActivity(opts) {
|
|
41225
42306
|
opts = opts || {};
|
|
@@ -41229,7 +42310,7 @@ class QualityApi {
|
|
|
41229
42310
|
'/api/v2/quality/agents/activity',
|
|
41230
42311
|
'GET',
|
|
41231
42312
|
{ },
|
|
41232
|
-
{ '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'] },
|
|
42313
|
+
{ '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'] },
|
|
41233
42314
|
{ },
|
|
41234
42315
|
{ },
|
|
41235
42316
|
null,
|
|
@@ -41427,9 +42508,9 @@ class QualityApi {
|
|
|
41427
42508
|
* @param {Object} opts Optional parameters
|
|
41428
42509
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
41429
42510
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
41430
|
-
* @param {String} opts.sortBy
|
|
42511
|
+
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
41431
42512
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
41432
|
-
* @param {String} opts.nextPage
|
|
42513
|
+
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
41433
42514
|
* @param {String} opts.previousPage Previous page token
|
|
41434
42515
|
* @param {String} opts.conversationId conversationId specified
|
|
41435
42516
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -41438,12 +42519,13 @@ class QualityApi {
|
|
|
41438
42519
|
* @param {String} opts.queueId queue id
|
|
41439
42520
|
* @param {String} opts.startTime start time of the evaluation query
|
|
41440
42521
|
* @param {String} opts.endTime end time of the evaluation query
|
|
42522
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
41441
42523
|
* @param {Array.<String>} opts.evaluationState
|
|
41442
42524
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
41443
42525
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
41444
42526
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
41445
|
-
* @param {Number} opts.maximum maximum
|
|
41446
|
-
* @param {String} opts.sortOrder
|
|
42527
|
+
* @param {Number} opts.maximum the maximum number of results to return
|
|
42528
|
+
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
41447
42529
|
*/
|
|
41448
42530
|
getQualityEvaluationsQuery(opts) {
|
|
41449
42531
|
opts = opts || {};
|
|
@@ -41453,7 +42535,7 @@ class QualityApi {
|
|
|
41453
42535
|
'/api/v2/quality/evaluations/query',
|
|
41454
42536
|
'GET',
|
|
41455
42537
|
{ },
|
|
41456
|
-
{ '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'] },
|
|
42538
|
+
{ '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'] },
|
|
41457
42539
|
{ },
|
|
41458
42540
|
{ },
|
|
41459
42541
|
null,
|
|
@@ -42530,7 +43612,7 @@ class QualityApi {
|
|
|
42530
43612
|
* @param {String} evaluationId evaluationId
|
|
42531
43613
|
* @param {Object} body evaluation
|
|
42532
43614
|
* @param {Object} opts Optional parameters
|
|
42533
|
-
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
43615
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee, evaluator
|
|
42534
43616
|
*/
|
|
42535
43617
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
42536
43618
|
opts = opts || {};
|
|
@@ -42689,7 +43771,7 @@ class RecordingApi {
|
|
|
42689
43771
|
/**
|
|
42690
43772
|
* Recording service.
|
|
42691
43773
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
42692
|
-
* @version
|
|
43774
|
+
* @version 175.0.0
|
|
42693
43775
|
*/
|
|
42694
43776
|
|
|
42695
43777
|
/**
|
|
@@ -44326,7 +45408,7 @@ class ResponseManagementApi {
|
|
|
44326
45408
|
/**
|
|
44327
45409
|
* ResponseManagement service.
|
|
44328
45410
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
44329
|
-
* @version
|
|
45411
|
+
* @version 175.0.0
|
|
44330
45412
|
*/
|
|
44331
45413
|
|
|
44332
45414
|
/**
|
|
@@ -44811,7 +45893,7 @@ class RoutingApi {
|
|
|
44811
45893
|
/**
|
|
44812
45894
|
* Routing service.
|
|
44813
45895
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
44814
|
-
* @version
|
|
45896
|
+
* @version 175.0.0
|
|
44815
45897
|
*/
|
|
44816
45898
|
|
|
44817
45899
|
/**
|
|
@@ -45818,6 +46900,7 @@ class RoutingApi {
|
|
|
45818
46900
|
*
|
|
45819
46901
|
* @param {Object} opts Optional parameters
|
|
45820
46902
|
* @param {Object} opts.messengerType Messenger Type
|
|
46903
|
+
* @param {String} opts.name Recipient Name
|
|
45821
46904
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
45822
46905
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
45823
46906
|
*/
|
|
@@ -45829,7 +46912,7 @@ class RoutingApi {
|
|
|
45829
46912
|
'/api/v2/routing/message/recipients',
|
|
45830
46913
|
'GET',
|
|
45831
46914
|
{ },
|
|
45832
|
-
{ 'messengerType': opts['messengerType'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
46915
|
+
{ 'messengerType': opts['messengerType'],'name': opts['name'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
45833
46916
|
{ },
|
|
45834
46917
|
{ },
|
|
45835
46918
|
null,
|
|
@@ -48518,7 +49601,7 @@ class SCIMApi {
|
|
|
48518
49601
|
/**
|
|
48519
49602
|
* SCIM service.
|
|
48520
49603
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
48521
|
-
* @version
|
|
49604
|
+
* @version 175.0.0
|
|
48522
49605
|
*/
|
|
48523
49606
|
|
|
48524
49607
|
/**
|
|
@@ -49395,7 +50478,7 @@ class ScriptsApi {
|
|
|
49395
50478
|
/**
|
|
49396
50479
|
* Scripts service.
|
|
49397
50480
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
49398
|
-
* @version
|
|
50481
|
+
* @version 175.0.0
|
|
49399
50482
|
*/
|
|
49400
50483
|
|
|
49401
50484
|
/**
|
|
@@ -49839,7 +50922,7 @@ class SearchApi {
|
|
|
49839
50922
|
/**
|
|
49840
50923
|
* Search service.
|
|
49841
50924
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
49842
|
-
* @version
|
|
50925
|
+
* @version 175.0.0
|
|
49843
50926
|
*/
|
|
49844
50927
|
|
|
49845
50928
|
/**
|
|
@@ -50528,7 +51611,7 @@ class SettingsApi {
|
|
|
50528
51611
|
/**
|
|
50529
51612
|
* Settings service.
|
|
50530
51613
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
50531
|
-
* @version
|
|
51614
|
+
* @version 175.0.0
|
|
50532
51615
|
*/
|
|
50533
51616
|
|
|
50534
51617
|
/**
|
|
@@ -50593,7 +51676,7 @@ class SpeechTextAnalyticsApi {
|
|
|
50593
51676
|
/**
|
|
50594
51677
|
* SpeechTextAnalytics service.
|
|
50595
51678
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
50596
|
-
* @version
|
|
51679
|
+
* @version 175.0.0
|
|
50597
51680
|
*/
|
|
50598
51681
|
|
|
50599
51682
|
/**
|
|
@@ -51576,7 +52659,7 @@ class StationsApi {
|
|
|
51576
52659
|
/**
|
|
51577
52660
|
* Stations service.
|
|
51578
52661
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
51579
|
-
* @version
|
|
52662
|
+
* @version 175.0.0
|
|
51580
52663
|
*/
|
|
51581
52664
|
|
|
51582
52665
|
/**
|
|
@@ -51678,7 +52761,7 @@ class SuggestApi {
|
|
|
51678
52761
|
/**
|
|
51679
52762
|
* Suggest service.
|
|
51680
52763
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
51681
|
-
* @version
|
|
52764
|
+
* @version 175.0.0
|
|
51682
52765
|
*/
|
|
51683
52766
|
|
|
51684
52767
|
/**
|
|
@@ -51817,7 +52900,7 @@ class TaskManagementApi {
|
|
|
51817
52900
|
/**
|
|
51818
52901
|
* TaskManagement service.
|
|
51819
52902
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
51820
|
-
* @version
|
|
52903
|
+
* @version 175.0.0
|
|
51821
52904
|
*/
|
|
51822
52905
|
|
|
51823
52906
|
/**
|
|
@@ -53098,7 +54181,7 @@ class TeamsApi {
|
|
|
53098
54181
|
/**
|
|
53099
54182
|
* Teams service.
|
|
53100
54183
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
53101
|
-
* @version
|
|
54184
|
+
* @version 175.0.0
|
|
53102
54185
|
*/
|
|
53103
54186
|
|
|
53104
54187
|
/**
|
|
@@ -53400,7 +54483,7 @@ class TelephonyApi {
|
|
|
53400
54483
|
/**
|
|
53401
54484
|
* Telephony service.
|
|
53402
54485
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
53403
|
-
* @version
|
|
54486
|
+
* @version 175.0.0
|
|
53404
54487
|
*/
|
|
53405
54488
|
|
|
53406
54489
|
/**
|
|
@@ -53528,7 +54611,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
53528
54611
|
/**
|
|
53529
54612
|
* TelephonyProvidersEdge service.
|
|
53530
54613
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
53531
|
-
* @version
|
|
54614
|
+
* @version 175.0.0
|
|
53532
54615
|
*/
|
|
53533
54616
|
|
|
53534
54617
|
/**
|
|
@@ -55191,7 +56274,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
55191
56274
|
}
|
|
55192
56275
|
|
|
55193
56276
|
/**
|
|
55194
|
-
* Get a list of Phone Instances
|
|
56277
|
+
* 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.
|
|
55195
56278
|
*
|
|
55196
56279
|
* @param {Object} opts Optional parameters
|
|
55197
56280
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -56817,7 +57900,7 @@ class TextbotsApi {
|
|
|
56817
57900
|
/**
|
|
56818
57901
|
* Textbots service.
|
|
56819
57902
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
56820
|
-
* @version
|
|
57903
|
+
* @version 175.0.0
|
|
56821
57904
|
*/
|
|
56822
57905
|
|
|
56823
57906
|
/**
|
|
@@ -56945,7 +58028,7 @@ class TokensApi {
|
|
|
56945
58028
|
/**
|
|
56946
58029
|
* Tokens service.
|
|
56947
58030
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
56948
|
-
* @version
|
|
58031
|
+
* @version 175.0.0
|
|
56949
58032
|
*/
|
|
56950
58033
|
|
|
56951
58034
|
/**
|
|
@@ -57008,14 +58091,18 @@ class TokensApi {
|
|
|
57008
58091
|
/**
|
|
57009
58092
|
* Fetch information about the current token
|
|
57010
58093
|
*
|
|
58094
|
+
* @param {Object} opts Optional parameters
|
|
58095
|
+
* @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.
|
|
57011
58096
|
*/
|
|
57012
|
-
getTokensMe() {
|
|
58097
|
+
getTokensMe(opts) {
|
|
58098
|
+
opts = opts || {};
|
|
58099
|
+
|
|
57013
58100
|
|
|
57014
58101
|
return this.apiClient.callApi(
|
|
57015
58102
|
'/api/v2/tokens/me',
|
|
57016
58103
|
'GET',
|
|
57017
58104
|
{ },
|
|
57018
|
-
{
|
|
58105
|
+
{ 'preserveIdleTTL': opts['preserveIdleTTL'] },
|
|
57019
58106
|
{ },
|
|
57020
58107
|
{ },
|
|
57021
58108
|
null,
|
|
@@ -57097,7 +58184,7 @@ class UploadsApi {
|
|
|
57097
58184
|
/**
|
|
57098
58185
|
* Uploads service.
|
|
57099
58186
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
57100
|
-
* @version
|
|
58187
|
+
* @version 175.0.0
|
|
57101
58188
|
*/
|
|
57102
58189
|
|
|
57103
58190
|
/**
|
|
@@ -57273,7 +58360,7 @@ class UsageApi {
|
|
|
57273
58360
|
/**
|
|
57274
58361
|
* Usage service.
|
|
57275
58362
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
57276
|
-
* @version
|
|
58363
|
+
* @version 175.0.0
|
|
57277
58364
|
*/
|
|
57278
58365
|
|
|
57279
58366
|
/**
|
|
@@ -57483,7 +58570,7 @@ class UserRecordingsApi {
|
|
|
57483
58570
|
/**
|
|
57484
58571
|
* UserRecordings service.
|
|
57485
58572
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
57486
|
-
* @version
|
|
58573
|
+
* @version 175.0.0
|
|
57487
58574
|
*/
|
|
57488
58575
|
|
|
57489
58576
|
/**
|
|
@@ -57668,7 +58755,7 @@ class UsersApi {
|
|
|
57668
58755
|
/**
|
|
57669
58756
|
* Users service.
|
|
57670
58757
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
57671
|
-
* @version
|
|
58758
|
+
* @version 175.0.0
|
|
57672
58759
|
*/
|
|
57673
58760
|
|
|
57674
58761
|
/**
|
|
@@ -60229,7 +61316,7 @@ class UtilitiesApi {
|
|
|
60229
61316
|
/**
|
|
60230
61317
|
* Utilities service.
|
|
60231
61318
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
60232
|
-
* @version
|
|
61319
|
+
* @version 175.0.0
|
|
60233
61320
|
*/
|
|
60234
61321
|
|
|
60235
61322
|
/**
|
|
@@ -60340,7 +61427,7 @@ class VoicemailApi {
|
|
|
60340
61427
|
/**
|
|
60341
61428
|
* Voicemail service.
|
|
60342
61429
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
60343
|
-
* @version
|
|
61430
|
+
* @version 175.0.0
|
|
60344
61431
|
*/
|
|
60345
61432
|
|
|
60346
61433
|
/**
|
|
@@ -61007,7 +62094,7 @@ class WebChatApi {
|
|
|
61007
62094
|
/**
|
|
61008
62095
|
* WebChat service.
|
|
61009
62096
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
61010
|
-
* @version
|
|
62097
|
+
* @version 175.0.0
|
|
61011
62098
|
*/
|
|
61012
62099
|
|
|
61013
62100
|
/**
|
|
@@ -61556,7 +62643,7 @@ class WebDeploymentsApi {
|
|
|
61556
62643
|
/**
|
|
61557
62644
|
* WebDeployments service.
|
|
61558
62645
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
61559
|
-
* @version
|
|
62646
|
+
* @version 175.0.0
|
|
61560
62647
|
*/
|
|
61561
62648
|
|
|
61562
62649
|
/**
|
|
@@ -61784,8 +62871,12 @@ class WebDeploymentsApi {
|
|
|
61784
62871
|
* Get a deployment
|
|
61785
62872
|
*
|
|
61786
62873
|
* @param {String} deploymentId The deployment ID
|
|
62874
|
+
* @param {Object} opts Optional parameters
|
|
62875
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
61787
62876
|
*/
|
|
61788
|
-
getWebdeploymentsDeployment(deploymentId) {
|
|
62877
|
+
getWebdeploymentsDeployment(deploymentId, opts) {
|
|
62878
|
+
opts = opts || {};
|
|
62879
|
+
|
|
61789
62880
|
// verify the required parameter 'deploymentId' is set
|
|
61790
62881
|
if (deploymentId === undefined || deploymentId === null) {
|
|
61791
62882
|
throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';
|
|
@@ -61795,7 +62886,7 @@ class WebDeploymentsApi {
|
|
|
61795
62886
|
'/api/v2/webdeployments/deployments/{deploymentId}',
|
|
61796
62887
|
'GET',
|
|
61797
62888
|
{ 'deploymentId': deploymentId },
|
|
61798
|
-
{
|
|
62889
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
61799
62890
|
{ },
|
|
61800
62891
|
{ },
|
|
61801
62892
|
null,
|
|
@@ -61841,6 +62932,7 @@ class WebDeploymentsApi {
|
|
|
61841
62932
|
* @param {String} deploymentId The deployment ID
|
|
61842
62933
|
* @param {Object} opts Optional parameters
|
|
61843
62934
|
* @param {String} opts.type Get active configuration on a deployment
|
|
62935
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value
|
|
61844
62936
|
*/
|
|
61845
62937
|
getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
|
|
61846
62938
|
opts = opts || {};
|
|
@@ -61854,7 +62946,7 @@ class WebDeploymentsApi {
|
|
|
61854
62946
|
'/api/v2/webdeployments/deployments/{deploymentId}/configurations',
|
|
61855
62947
|
'GET',
|
|
61856
62948
|
{ 'deploymentId': deploymentId },
|
|
61857
|
-
{ 'type': opts['type'] },
|
|
62949
|
+
{ 'type': opts['type'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
61858
62950
|
{ },
|
|
61859
62951
|
{ },
|
|
61860
62952
|
null,
|
|
@@ -61868,7 +62960,7 @@ class WebDeploymentsApi {
|
|
|
61868
62960
|
* Get deployments
|
|
61869
62961
|
*
|
|
61870
62962
|
* @param {Object} opts Optional parameters
|
|
61871
|
-
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
62963
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
61872
62964
|
*/
|
|
61873
62965
|
getWebdeploymentsDeployments(opts) {
|
|
61874
62966
|
opts = opts || {};
|
|
@@ -62078,7 +63170,7 @@ class WebMessagingApi {
|
|
|
62078
63170
|
/**
|
|
62079
63171
|
* WebMessaging service.
|
|
62080
63172
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
62081
|
-
* @version
|
|
63173
|
+
* @version 175.0.0
|
|
62082
63174
|
*/
|
|
62083
63175
|
|
|
62084
63176
|
/**
|
|
@@ -62124,7 +63216,7 @@ class WidgetsApi {
|
|
|
62124
63216
|
/**
|
|
62125
63217
|
* Widgets service.
|
|
62126
63218
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
62127
|
-
* @version
|
|
63219
|
+
* @version 175.0.0
|
|
62128
63220
|
*/
|
|
62129
63221
|
|
|
62130
63222
|
/**
|
|
@@ -62270,7 +63362,7 @@ class WorkforceManagementApi {
|
|
|
62270
63362
|
/**
|
|
62271
63363
|
* WorkforceManagement service.
|
|
62272
63364
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
62273
|
-
* @version
|
|
63365
|
+
* @version 175.0.0
|
|
62274
63366
|
*/
|
|
62275
63367
|
|
|
62276
63368
|
/**
|
|
@@ -63189,8 +64281,12 @@ class WorkforceManagementApi {
|
|
|
63189
64281
|
*
|
|
63190
64282
|
* @param {String} businessUnitId The ID of the business unit.
|
|
63191
64283
|
* @param {String} serviceGoalTemplateId The ID of a service goal template to fetch
|
|
64284
|
+
* @param {Object} opts Optional parameters
|
|
64285
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
63192
64286
|
*/
|
|
63193
|
-
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId) {
|
|
64287
|
+
getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, opts) {
|
|
64288
|
+
opts = opts || {};
|
|
64289
|
+
|
|
63194
64290
|
// verify the required parameter 'businessUnitId' is set
|
|
63195
64291
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
63196
64292
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
@@ -63204,7 +64300,7 @@ class WorkforceManagementApi {
|
|
|
63204
64300
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
63205
64301
|
'GET',
|
|
63206
64302
|
{ 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
|
|
63207
|
-
{
|
|
64303
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63208
64304
|
{ },
|
|
63209
64305
|
{ },
|
|
63210
64306
|
null,
|
|
@@ -63218,8 +64314,12 @@ class WorkforceManagementApi {
|
|
|
63218
64314
|
* Gets list of service goal templates
|
|
63219
64315
|
*
|
|
63220
64316
|
* @param {String} businessUnitId The ID of the business unit.
|
|
64317
|
+
* @param {Object} opts Optional parameters
|
|
64318
|
+
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
63221
64319
|
*/
|
|
63222
|
-
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId) {
|
|
64320
|
+
getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, opts) {
|
|
64321
|
+
opts = opts || {};
|
|
64322
|
+
|
|
63223
64323
|
// verify the required parameter 'businessUnitId' is set
|
|
63224
64324
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
63225
64325
|
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
@@ -63229,7 +64329,7 @@ class WorkforceManagementApi {
|
|
|
63229
64329
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
|
|
63230
64330
|
'GET',
|
|
63231
64331
|
{ 'businessUnitId': businessUnitId },
|
|
63232
|
-
{
|
|
64332
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
63233
64333
|
{ },
|
|
63234
64334
|
{ },
|
|
63235
64335
|
null,
|
|
@@ -63779,6 +64879,51 @@ class WorkforceManagementApi {
|
|
|
63779
64879
|
);
|
|
63780
64880
|
}
|
|
63781
64881
|
|
|
64882
|
+
/**
|
|
64883
|
+
* Get integrations
|
|
64884
|
+
*
|
|
64885
|
+
*/
|
|
64886
|
+
getWorkforcemanagementIntegrationsHris() {
|
|
64887
|
+
|
|
64888
|
+
return this.apiClient.callApi(
|
|
64889
|
+
'/api/v2/workforcemanagement/integrations/hris',
|
|
64890
|
+
'GET',
|
|
64891
|
+
{ },
|
|
64892
|
+
{ },
|
|
64893
|
+
{ },
|
|
64894
|
+
{ },
|
|
64895
|
+
null,
|
|
64896
|
+
['PureCloud OAuth'],
|
|
64897
|
+
['application/json'],
|
|
64898
|
+
['application/json']
|
|
64899
|
+
);
|
|
64900
|
+
}
|
|
64901
|
+
|
|
64902
|
+
/**
|
|
64903
|
+
* Query the results of time off types job
|
|
64904
|
+
*
|
|
64905
|
+
* @param {String} jobId The ID of the job.
|
|
64906
|
+
*/
|
|
64907
|
+
getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId) {
|
|
64908
|
+
// verify the required parameter 'jobId' is set
|
|
64909
|
+
if (jobId === undefined || jobId === null) {
|
|
64910
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';
|
|
64911
|
+
}
|
|
64912
|
+
|
|
64913
|
+
return this.apiClient.callApi(
|
|
64914
|
+
'/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}',
|
|
64915
|
+
'GET',
|
|
64916
|
+
{ 'jobId': jobId },
|
|
64917
|
+
{ },
|
|
64918
|
+
{ },
|
|
64919
|
+
{ },
|
|
64920
|
+
null,
|
|
64921
|
+
['PureCloud OAuth'],
|
|
64922
|
+
['application/json'],
|
|
64923
|
+
['application/json']
|
|
64924
|
+
);
|
|
64925
|
+
}
|
|
64926
|
+
|
|
63782
64927
|
/**
|
|
63783
64928
|
* Get management unit
|
|
63784
64929
|
* settings.shortTermForecasting is deprecated and now lives on the business unit
|
|
@@ -64592,6 +65737,31 @@ class WorkforceManagementApi {
|
|
|
64592
65737
|
);
|
|
64593
65738
|
}
|
|
64594
65739
|
|
|
65740
|
+
/**
|
|
65741
|
+
* Query the results of time off types job
|
|
65742
|
+
*
|
|
65743
|
+
* @param {String} jobId The ID of the job.
|
|
65744
|
+
*/
|
|
65745
|
+
getWorkforcemanagementTimeoffbalanceJob(jobId) {
|
|
65746
|
+
// verify the required parameter 'jobId' is set
|
|
65747
|
+
if (jobId === undefined || jobId === null) {
|
|
65748
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';
|
|
65749
|
+
}
|
|
65750
|
+
|
|
65751
|
+
return this.apiClient.callApi(
|
|
65752
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}',
|
|
65753
|
+
'GET',
|
|
65754
|
+
{ 'jobId': jobId },
|
|
65755
|
+
{ },
|
|
65756
|
+
{ },
|
|
65757
|
+
{ },
|
|
65758
|
+
null,
|
|
65759
|
+
['PureCloud OAuth'],
|
|
65760
|
+
['application/json'],
|
|
65761
|
+
['application/json']
|
|
65762
|
+
);
|
|
65763
|
+
}
|
|
65764
|
+
|
|
64595
65765
|
/**
|
|
64596
65766
|
* Get a time off request for the current user
|
|
64597
65767
|
*
|
|
@@ -64963,6 +66133,45 @@ class WorkforceManagementApi {
|
|
|
64963
66133
|
);
|
|
64964
66134
|
}
|
|
64965
66135
|
|
|
66136
|
+
/**
|
|
66137
|
+
* Set integration status for a time off request.
|
|
66138
|
+
*
|
|
66139
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
66140
|
+
* @param {String} timeOffRequestId The ID of the time off request.
|
|
66141
|
+
* @param {String} userId The ID of user to whom the time off request belongs.
|
|
66142
|
+
* @param {Object} opts Optional parameters
|
|
66143
|
+
* @param {Object} opts.body body
|
|
66144
|
+
*/
|
|
66145
|
+
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, opts) {
|
|
66146
|
+
opts = opts || {};
|
|
66147
|
+
|
|
66148
|
+
// verify the required parameter 'managementUnitId' is set
|
|
66149
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
66150
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
66151
|
+
}
|
|
66152
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
66153
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
66154
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
66155
|
+
}
|
|
66156
|
+
// verify the required parameter 'userId' is set
|
|
66157
|
+
if (userId === undefined || userId === null) {
|
|
66158
|
+
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
66159
|
+
}
|
|
66160
|
+
|
|
66161
|
+
return this.apiClient.callApi(
|
|
66162
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
|
|
66163
|
+
'PATCH',
|
|
66164
|
+
{ 'managementUnitId': managementUnitId,'timeOffRequestId': timeOffRequestId,'userId': userId },
|
|
66165
|
+
{ },
|
|
66166
|
+
{ },
|
|
66167
|
+
{ },
|
|
66168
|
+
opts['body'],
|
|
66169
|
+
['PureCloud OAuth'],
|
|
66170
|
+
['application/json'],
|
|
66171
|
+
['application/json']
|
|
66172
|
+
);
|
|
66173
|
+
}
|
|
66174
|
+
|
|
64966
66175
|
/**
|
|
64967
66176
|
* Update a time off request
|
|
64968
66177
|
*
|
|
@@ -65200,6 +66409,7 @@ class WorkforceManagementApi {
|
|
|
65200
66409
|
*
|
|
65201
66410
|
* @param {Object} opts Optional parameters
|
|
65202
66411
|
* @param {Object} opts.body body
|
|
66412
|
+
* @deprecated
|
|
65203
66413
|
*/
|
|
65204
66414
|
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
65205
66415
|
opts = opts || {};
|
|
@@ -65308,6 +66518,54 @@ class WorkforceManagementApi {
|
|
|
65308
66518
|
);
|
|
65309
66519
|
}
|
|
65310
66520
|
|
|
66521
|
+
/**
|
|
66522
|
+
* Move agents in and out of management unit
|
|
66523
|
+
*
|
|
66524
|
+
* @param {Object} opts Optional parameters
|
|
66525
|
+
* @param {Object} opts.body body
|
|
66526
|
+
*/
|
|
66527
|
+
postWorkforcemanagementAgents(opts) {
|
|
66528
|
+
opts = opts || {};
|
|
66529
|
+
|
|
66530
|
+
|
|
66531
|
+
return this.apiClient.callApi(
|
|
66532
|
+
'/api/v2/workforcemanagement/agents',
|
|
66533
|
+
'POST',
|
|
66534
|
+
{ },
|
|
66535
|
+
{ },
|
|
66536
|
+
{ },
|
|
66537
|
+
{ },
|
|
66538
|
+
opts['body'],
|
|
66539
|
+
['PureCloud OAuth'],
|
|
66540
|
+
['application/json'],
|
|
66541
|
+
['application/json']
|
|
66542
|
+
);
|
|
66543
|
+
}
|
|
66544
|
+
|
|
66545
|
+
/**
|
|
66546
|
+
* Query integrations for agents
|
|
66547
|
+
*
|
|
66548
|
+
* @param {Object} opts Optional parameters
|
|
66549
|
+
* @param {Object} opts.body body
|
|
66550
|
+
*/
|
|
66551
|
+
postWorkforcemanagementAgentsIntegrationsHrisQuery(opts) {
|
|
66552
|
+
opts = opts || {};
|
|
66553
|
+
|
|
66554
|
+
|
|
66555
|
+
return this.apiClient.callApi(
|
|
66556
|
+
'/api/v2/workforcemanagement/agents/integrations/hris/query',
|
|
66557
|
+
'POST',
|
|
66558
|
+
{ },
|
|
66559
|
+
{ },
|
|
66560
|
+
{ },
|
|
66561
|
+
{ },
|
|
66562
|
+
opts['body'],
|
|
66563
|
+
['PureCloud OAuth'],
|
|
66564
|
+
['application/json'],
|
|
66565
|
+
['application/json']
|
|
66566
|
+
);
|
|
66567
|
+
}
|
|
66568
|
+
|
|
65311
66569
|
/**
|
|
65312
66570
|
* Get agent possible work shifts for requested time frame
|
|
65313
66571
|
*
|
|
@@ -66130,6 +67388,31 @@ class WorkforceManagementApi {
|
|
|
66130
67388
|
);
|
|
66131
67389
|
}
|
|
66132
67390
|
|
|
67391
|
+
/**
|
|
67392
|
+
* Get list of time off types configured in integration
|
|
67393
|
+
*
|
|
67394
|
+
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
67395
|
+
*/
|
|
67396
|
+
postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId) {
|
|
67397
|
+
// verify the required parameter 'hrisIntegrationId' is set
|
|
67398
|
+
if (hrisIntegrationId === undefined || hrisIntegrationId === null) {
|
|
67399
|
+
throw 'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';
|
|
67400
|
+
}
|
|
67401
|
+
|
|
67402
|
+
return this.apiClient.callApi(
|
|
67403
|
+
'/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs',
|
|
67404
|
+
'POST',
|
|
67405
|
+
{ 'hrisIntegrationId': hrisIntegrationId },
|
|
67406
|
+
{ },
|
|
67407
|
+
{ },
|
|
67408
|
+
{ },
|
|
67409
|
+
null,
|
|
67410
|
+
['PureCloud OAuth'],
|
|
67411
|
+
['application/json'],
|
|
67412
|
+
['application/json']
|
|
67413
|
+
);
|
|
67414
|
+
}
|
|
67415
|
+
|
|
66133
67416
|
/**
|
|
66134
67417
|
* Query published schedules for given given time range for set of users
|
|
66135
67418
|
*
|
|
@@ -66394,6 +67677,35 @@ class WorkforceManagementApi {
|
|
|
66394
67677
|
);
|
|
66395
67678
|
}
|
|
66396
67679
|
|
|
67680
|
+
/**
|
|
67681
|
+
* Retrieves integration statuses for a list of time off requests
|
|
67682
|
+
*
|
|
67683
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
67684
|
+
* @param {Object} opts Optional parameters
|
|
67685
|
+
* @param {Object} opts.body body
|
|
67686
|
+
*/
|
|
67687
|
+
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, opts) {
|
|
67688
|
+
opts = opts || {};
|
|
67689
|
+
|
|
67690
|
+
// verify the required parameter 'managementUnitId' is set
|
|
67691
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
67692
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
67693
|
+
}
|
|
67694
|
+
|
|
67695
|
+
return this.apiClient.callApi(
|
|
67696
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
|
|
67697
|
+
'POST',
|
|
67698
|
+
{ 'managementUnitId': managementUnitId },
|
|
67699
|
+
{ },
|
|
67700
|
+
{ },
|
|
67701
|
+
{ },
|
|
67702
|
+
opts['body'],
|
|
67703
|
+
['PureCloud OAuth'],
|
|
67704
|
+
['application/json'],
|
|
67705
|
+
['application/json']
|
|
67706
|
+
);
|
|
67707
|
+
}
|
|
67708
|
+
|
|
66397
67709
|
/**
|
|
66398
67710
|
* Fetches time off requests matching the conditions specified in the request body
|
|
66399
67711
|
* 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
|
|
@@ -66522,6 +67834,40 @@ class WorkforceManagementApi {
|
|
|
66522
67834
|
);
|
|
66523
67835
|
}
|
|
66524
67836
|
|
|
67837
|
+
/**
|
|
67838
|
+
* Estimates available time off for an agent
|
|
67839
|
+
*
|
|
67840
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
67841
|
+
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
67842
|
+
* @param {Object} opts Optional parameters
|
|
67843
|
+
* @param {Object} opts.body body
|
|
67844
|
+
*/
|
|
67845
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, opts) {
|
|
67846
|
+
opts = opts || {};
|
|
67847
|
+
|
|
67848
|
+
// verify the required parameter 'managementUnitId' is set
|
|
67849
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
67850
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
67851
|
+
}
|
|
67852
|
+
// verify the required parameter 'userId' is set
|
|
67853
|
+
if (userId === undefined || userId === null) {
|
|
67854
|
+
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
67855
|
+
}
|
|
67856
|
+
|
|
67857
|
+
return this.apiClient.callApi(
|
|
67858
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
67859
|
+
'POST',
|
|
67860
|
+
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
67861
|
+
{ },
|
|
67862
|
+
{ },
|
|
67863
|
+
{ },
|
|
67864
|
+
opts['body'],
|
|
67865
|
+
['PureCloud OAuth'],
|
|
67866
|
+
['application/json'],
|
|
67867
|
+
['application/json']
|
|
67868
|
+
);
|
|
67869
|
+
}
|
|
67870
|
+
|
|
66525
67871
|
/**
|
|
66526
67872
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
66527
67873
|
*
|
|
@@ -66964,6 +68310,31 @@ class WorkforceManagementApi {
|
|
|
66964
68310
|
);
|
|
66965
68311
|
}
|
|
66966
68312
|
|
|
68313
|
+
/**
|
|
68314
|
+
* Query time off balances for the current user for specified activity code and dates
|
|
68315
|
+
*
|
|
68316
|
+
* @param {Object} body The request body
|
|
68317
|
+
*/
|
|
68318
|
+
postWorkforcemanagementTimeoffbalanceJobs(body) {
|
|
68319
|
+
// verify the required parameter 'body' is set
|
|
68320
|
+
if (body === undefined || body === null) {
|
|
68321
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';
|
|
68322
|
+
}
|
|
68323
|
+
|
|
68324
|
+
return this.apiClient.callApi(
|
|
68325
|
+
'/api/v2/workforcemanagement/timeoffbalance/jobs',
|
|
68326
|
+
'POST',
|
|
68327
|
+
{ },
|
|
68328
|
+
{ },
|
|
68329
|
+
{ },
|
|
68330
|
+
{ },
|
|
68331
|
+
body,
|
|
68332
|
+
['PureCloud OAuth'],
|
|
68333
|
+
['application/json'],
|
|
68334
|
+
['application/json']
|
|
68335
|
+
);
|
|
68336
|
+
}
|
|
68337
|
+
|
|
66967
68338
|
/**
|
|
66968
68339
|
* Queries available time off for the current user
|
|
66969
68340
|
*
|
|
@@ -67012,6 +68383,84 @@ class WorkforceManagementApi {
|
|
|
67012
68383
|
);
|
|
67013
68384
|
}
|
|
67014
68385
|
|
|
68386
|
+
/**
|
|
68387
|
+
* Estimates available time off for current user
|
|
68388
|
+
*
|
|
68389
|
+
* @param {Object} opts Optional parameters
|
|
68390
|
+
* @param {Object} opts.body body
|
|
68391
|
+
*/
|
|
68392
|
+
postWorkforcemanagementTimeoffrequestsEstimate(opts) {
|
|
68393
|
+
opts = opts || {};
|
|
68394
|
+
|
|
68395
|
+
|
|
68396
|
+
return this.apiClient.callApi(
|
|
68397
|
+
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
68398
|
+
'POST',
|
|
68399
|
+
{ },
|
|
68400
|
+
{ },
|
|
68401
|
+
{ },
|
|
68402
|
+
{ },
|
|
68403
|
+
opts['body'],
|
|
68404
|
+
['PureCloud OAuth'],
|
|
68405
|
+
['application/json'],
|
|
68406
|
+
['application/json']
|
|
68407
|
+
);
|
|
68408
|
+
}
|
|
68409
|
+
|
|
68410
|
+
/**
|
|
68411
|
+
* Retrieves integration statuses for a list of current user time off requests
|
|
68412
|
+
*
|
|
68413
|
+
* @param {Object} opts Optional parameters
|
|
68414
|
+
* @param {Object} opts.body body
|
|
68415
|
+
*/
|
|
68416
|
+
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(opts) {
|
|
68417
|
+
opts = opts || {};
|
|
68418
|
+
|
|
68419
|
+
|
|
68420
|
+
return this.apiClient.callApi(
|
|
68421
|
+
'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
|
|
68422
|
+
'POST',
|
|
68423
|
+
{ },
|
|
68424
|
+
{ },
|
|
68425
|
+
{ },
|
|
68426
|
+
{ },
|
|
68427
|
+
opts['body'],
|
|
68428
|
+
['PureCloud OAuth'],
|
|
68429
|
+
['application/json'],
|
|
68430
|
+
['application/json']
|
|
68431
|
+
);
|
|
68432
|
+
}
|
|
68433
|
+
|
|
68434
|
+
/**
|
|
68435
|
+
* Update integrations for agent
|
|
68436
|
+
*
|
|
68437
|
+
* @param {String} agentId The ID of the agent
|
|
68438
|
+
* @param {Object} body body
|
|
68439
|
+
*/
|
|
68440
|
+
putWorkforcemanagementAgentIntegrationsHris(agentId, body) {
|
|
68441
|
+
// verify the required parameter 'agentId' is set
|
|
68442
|
+
if (agentId === undefined || agentId === null) {
|
|
68443
|
+
throw 'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
68444
|
+
}
|
|
68445
|
+
// verify the required parameter 'body' is set
|
|
68446
|
+
if (body === undefined || body === null) {
|
|
68447
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';
|
|
68448
|
+
}
|
|
68449
|
+
|
|
68450
|
+
return this.apiClient.callApi(
|
|
68451
|
+
'/api/v2/workforcemanagement/agents/{agentId}/integrations/hris',
|
|
68452
|
+
'PUT',
|
|
68453
|
+
{ 'agentId': agentId },
|
|
68454
|
+
{ },
|
|
68455
|
+
{ },
|
|
68456
|
+
{ },
|
|
68457
|
+
body,
|
|
68458
|
+
['PureCloud OAuth'],
|
|
68459
|
+
['application/json'],
|
|
68460
|
+
['application/json']
|
|
68461
|
+
);
|
|
68462
|
+
}
|
|
68463
|
+
|
|
67015
68464
|
/**
|
|
67016
68465
|
* Sets daily values for a date range of time off limit object
|
|
67017
68466
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
@@ -67077,7 +68526,7 @@ class WorkforceManagementApi {
|
|
|
67077
68526
|
* </pre>
|
|
67078
68527
|
* </p>
|
|
67079
68528
|
* @module purecloud-platform-client-v2/index
|
|
67080
|
-
* @version
|
|
68529
|
+
* @version 175.0.0
|
|
67081
68530
|
*/
|
|
67082
68531
|
class platformClient {
|
|
67083
68532
|
constructor() {
|