purecloud-platform-client-v2 154.0.0 → 155.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +323 -77
- package/dist/web-amd/purecloud-platform-client-v2.js +323 -77
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +323 -77
- package/dist/web-cjs/purecloud-platform-client-v2.js +323 -77
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +409 -227
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +1 -1
- 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/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/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +116 -8
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +119 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +21 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* LanguageUnderstanding service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 155.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -195,6 +195,7 @@ class LanguageUnderstandingApi {
|
|
|
195
195
|
* @param {String} opts.dateStart Begin of time window as ISO-8601 date.
|
|
196
196
|
* @param {String} opts.dateEnd End of time window as ISO-8601 date.
|
|
197
197
|
* @param {Boolean} opts.includeDeleted Whether to include soft-deleted items in the result.
|
|
198
|
+
* @param {String} opts.language Whether to filter response based on the language, e.g. en-us, pt-br.
|
|
198
199
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
199
200
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
200
201
|
* @param {Boolean} opts.enableCursorPagination Enable Cursor Pagination (default to false)
|
|
@@ -213,7 +214,7 @@ class LanguageUnderstandingApi {
|
|
|
213
214
|
'/api/v2/languageunderstanding/domains/{domainId}/feedback',
|
|
214
215
|
'GET',
|
|
215
216
|
{ 'domainId': domainId },
|
|
216
|
-
{ 'intentName': opts['intentName'],'assessment': opts['assessment'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'includeDeleted': opts['includeDeleted'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'enableCursorPagination': opts['enableCursorPagination'],'after': opts['after'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
|
|
217
|
+
{ 'intentName': opts['intentName'],'assessment': opts['assessment'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'includeDeleted': opts['includeDeleted'],'language': opts['language'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'enableCursorPagination': opts['enableCursorPagination'],'after': opts['after'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
|
|
217
218
|
{ },
|
|
218
219
|
{ },
|
|
219
220
|
null,
|
|
@@ -407,8 +408,13 @@ class LanguageUnderstandingApi {
|
|
|
407
408
|
*
|
|
408
409
|
* @param {String} minerId Miner ID
|
|
409
410
|
* @param {String} draftId Draft ID
|
|
411
|
+
* @param {Object} opts Optional parameters
|
|
412
|
+
* @param {String} opts.draftIntentId Parameter to filter a specific intent.
|
|
413
|
+
* @param {String} opts.draftTopicId Parameter to filter a specific topic.
|
|
410
414
|
*/
|
|
411
|
-
getLanguageunderstandingMinerDraft(minerId, draftId) {
|
|
415
|
+
getLanguageunderstandingMinerDraft(minerId, draftId, opts) {
|
|
416
|
+
opts = opts || {};
|
|
417
|
+
|
|
412
418
|
// verify the required parameter 'minerId' is set
|
|
413
419
|
if (minerId === undefined || minerId === null) {
|
|
414
420
|
throw 'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerDraft';
|
|
@@ -422,7 +428,7 @@ class LanguageUnderstandingApi {
|
|
|
422
428
|
'/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}',
|
|
423
429
|
'GET',
|
|
424
430
|
{ 'minerId': minerId,'draftId': draftId },
|
|
425
|
-
{
|
|
431
|
+
{ 'draftIntentId': opts['draftIntentId'],'draftTopicId': opts['draftTopicId'] },
|
|
426
432
|
{ },
|
|
427
433
|
{ },
|
|
428
434
|
null,
|
|
@@ -520,17 +526,115 @@ class LanguageUnderstandingApi {
|
|
|
520
526
|
);
|
|
521
527
|
}
|
|
522
528
|
|
|
529
|
+
/**
|
|
530
|
+
* Retrieves details of a particular topic.
|
|
531
|
+
*
|
|
532
|
+
* @param {String} minerId Miner ID
|
|
533
|
+
* @param {String} topicId The ID of the topic to be retrieved.
|
|
534
|
+
* @param {Object} opts Optional parameters
|
|
535
|
+
* @param {Object} opts.expand Option to fetch phrases
|
|
536
|
+
*/
|
|
537
|
+
getLanguageunderstandingMinerTopic(minerId, topicId, opts) {
|
|
538
|
+
opts = opts || {};
|
|
539
|
+
|
|
540
|
+
// verify the required parameter 'minerId' is set
|
|
541
|
+
if (minerId === undefined || minerId === null) {
|
|
542
|
+
throw 'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopic';
|
|
543
|
+
}
|
|
544
|
+
// verify the required parameter 'topicId' is set
|
|
545
|
+
if (topicId === undefined || topicId === null) {
|
|
546
|
+
throw 'Missing the required parameter "topicId" when calling getLanguageunderstandingMinerTopic';
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
return this.apiClient.callApi(
|
|
550
|
+
'/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}',
|
|
551
|
+
'GET',
|
|
552
|
+
{ 'minerId': minerId,'topicId': topicId },
|
|
553
|
+
{ 'expand': opts['expand'] },
|
|
554
|
+
{ },
|
|
555
|
+
{ },
|
|
556
|
+
null,
|
|
557
|
+
['PureCloud OAuth'],
|
|
558
|
+
['application/json'],
|
|
559
|
+
['application/json']
|
|
560
|
+
);
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
/**
|
|
564
|
+
* Retrieves utterances related to a phrase in a topic.
|
|
565
|
+
*
|
|
566
|
+
* @param {String} minerId Miner ID
|
|
567
|
+
* @param {String} topicId The ID of the topic to be retrieved.
|
|
568
|
+
* @param {String} phraseId The ID of the phrase to be retrieved.
|
|
569
|
+
*/
|
|
570
|
+
getLanguageunderstandingMinerTopicPhrase(minerId, topicId, phraseId) {
|
|
571
|
+
// verify the required parameter 'minerId' is set
|
|
572
|
+
if (minerId === undefined || minerId === null) {
|
|
573
|
+
throw 'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopicPhrase';
|
|
574
|
+
}
|
|
575
|
+
// verify the required parameter 'topicId' is set
|
|
576
|
+
if (topicId === undefined || topicId === null) {
|
|
577
|
+
throw 'Missing the required parameter "topicId" when calling getLanguageunderstandingMinerTopicPhrase';
|
|
578
|
+
}
|
|
579
|
+
// verify the required parameter 'phraseId' is set
|
|
580
|
+
if (phraseId === undefined || phraseId === null) {
|
|
581
|
+
throw 'Missing the required parameter "phraseId" when calling getLanguageunderstandingMinerTopicPhrase';
|
|
582
|
+
}
|
|
583
|
+
|
|
584
|
+
return this.apiClient.callApi(
|
|
585
|
+
'/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}',
|
|
586
|
+
'GET',
|
|
587
|
+
{ 'minerId': minerId,'topicId': topicId,'phraseId': phraseId },
|
|
588
|
+
{ },
|
|
589
|
+
{ },
|
|
590
|
+
{ },
|
|
591
|
+
null,
|
|
592
|
+
['PureCloud OAuth'],
|
|
593
|
+
['application/json'],
|
|
594
|
+
['application/json']
|
|
595
|
+
);
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
/**
|
|
599
|
+
* Retrieve a list of mined topics.
|
|
600
|
+
*
|
|
601
|
+
* @param {String} minerId Miner ID
|
|
602
|
+
*/
|
|
603
|
+
getLanguageunderstandingMinerTopics(minerId) {
|
|
604
|
+
// verify the required parameter 'minerId' is set
|
|
605
|
+
if (minerId === undefined || minerId === null) {
|
|
606
|
+
throw 'Missing the required parameter "minerId" when calling getLanguageunderstandingMinerTopics';
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
return this.apiClient.callApi(
|
|
610
|
+
'/api/v2/languageunderstanding/miners/{minerId}/topics',
|
|
611
|
+
'GET',
|
|
612
|
+
{ 'minerId': minerId },
|
|
613
|
+
{ },
|
|
614
|
+
{ },
|
|
615
|
+
{ },
|
|
616
|
+
null,
|
|
617
|
+
['PureCloud OAuth'],
|
|
618
|
+
['application/json'],
|
|
619
|
+
['application/json']
|
|
620
|
+
);
|
|
621
|
+
}
|
|
622
|
+
|
|
523
623
|
/**
|
|
524
624
|
* Retrieve the list of miners created.
|
|
525
625
|
*
|
|
626
|
+
* @param {Object} opts Optional parameters
|
|
627
|
+
* @param {String} opts.minerType Type of miner, either intent or topic
|
|
526
628
|
*/
|
|
527
|
-
getLanguageunderstandingMiners() {
|
|
629
|
+
getLanguageunderstandingMiners(opts) {
|
|
630
|
+
opts = opts || {};
|
|
631
|
+
|
|
528
632
|
|
|
529
633
|
return this.apiClient.callApi(
|
|
530
634
|
'/api/v2/languageunderstanding/miners',
|
|
531
635
|
'GET',
|
|
532
636
|
{ },
|
|
533
|
-
{
|
|
637
|
+
{ 'minerType': opts['minerType'] },
|
|
534
638
|
{ },
|
|
535
639
|
{ },
|
|
536
640
|
null,
|
|
@@ -734,8 +838,12 @@ class LanguageUnderstandingApi {
|
|
|
734
838
|
*
|
|
735
839
|
* @param {String} domainId ID of the NLU domain.
|
|
736
840
|
* @param {Object} body The NLU Domain Version to create.
|
|
841
|
+
* @param {Object} opts Optional parameters
|
|
842
|
+
* @param {Boolean} opts.includeUtterances Whether utterances for intent definition should be included when marshalling response.
|
|
737
843
|
*/
|
|
738
|
-
postLanguageunderstandingDomainVersions(domainId, body) {
|
|
844
|
+
postLanguageunderstandingDomainVersions(domainId, body, opts) {
|
|
845
|
+
opts = opts || {};
|
|
846
|
+
|
|
739
847
|
// verify the required parameter 'domainId' is set
|
|
740
848
|
if (domainId === undefined || domainId === null) {
|
|
741
849
|
throw 'Missing the required parameter "domainId" when calling postLanguageunderstandingDomainVersions';
|
|
@@ -749,7 +857,7 @@ class LanguageUnderstandingApi {
|
|
|
749
857
|
'/api/v2/languageunderstanding/domains/{domainId}/versions',
|
|
750
858
|
'POST',
|
|
751
859
|
{ 'domainId': domainId },
|
|
752
|
-
{
|
|
860
|
+
{ 'includeUtterances': opts['includeUtterances'] },
|
|
753
861
|
{ },
|
|
754
862
|
{ },
|
|
755
863
|
body,
|