purecloud-platform-client-v2 239.0.0 → 241.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +824 -115
- package/dist/web-amd/purecloud-platform-client-v2.js +824 -115
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +286 -118
- package/dist/web-cjs/purecloud-platform-client-v2.js +286 -118
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1276 -752
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +5 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +36 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +156 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +135 -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 -14
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.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 +273 -13
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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/EmployeeEngagementApi.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 +5 -5
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- 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 +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/LogCaptureApi.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/OperationalEventsApi.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 +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 +134 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.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/SocialMediaApi.js +3 -2
- 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 +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/UsersRulesApi.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
|
@@ -5,7 +5,7 @@ class ConversationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Conversations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 241.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -671,6 +671,111 @@ class ConversationsApi {
|
|
|
671
671
|
);
|
|
672
672
|
}
|
|
673
673
|
|
|
674
|
+
/**
|
|
675
|
+
* Get checklist info for a single checklist.
|
|
676
|
+
*
|
|
677
|
+
* @param {String} conversationId Conversation ID
|
|
678
|
+
* @param {String} communicationId Communication ID
|
|
679
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
680
|
+
*/
|
|
681
|
+
getConversationCommunicationAgentchecklist(conversationId, communicationId, agentChecklistId) {
|
|
682
|
+
// verify the required parameter 'conversationId' is set
|
|
683
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
684
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklist';
|
|
685
|
+
}
|
|
686
|
+
// verify the required parameter 'communicationId' is set
|
|
687
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
688
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklist';
|
|
689
|
+
}
|
|
690
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
691
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
692
|
+
throw 'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklist';
|
|
693
|
+
}
|
|
694
|
+
|
|
695
|
+
return this.apiClient.callApi(
|
|
696
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}',
|
|
697
|
+
'GET',
|
|
698
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
699
|
+
{ },
|
|
700
|
+
{ },
|
|
701
|
+
{ },
|
|
702
|
+
null,
|
|
703
|
+
['PureCloud OAuth'],
|
|
704
|
+
['application/json'],
|
|
705
|
+
['application/json']
|
|
706
|
+
);
|
|
707
|
+
}
|
|
708
|
+
|
|
709
|
+
/**
|
|
710
|
+
* Get inference job status
|
|
711
|
+
*
|
|
712
|
+
* @param {String} conversationId Conversation ID
|
|
713
|
+
* @param {String} communicationId Communication ID
|
|
714
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
715
|
+
* @param {String} jobId Inference Job ID
|
|
716
|
+
*/
|
|
717
|
+
getConversationCommunicationAgentchecklistJob(conversationId, communicationId, agentChecklistId, jobId) {
|
|
718
|
+
// verify the required parameter 'conversationId' is set
|
|
719
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
720
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklistJob';
|
|
721
|
+
}
|
|
722
|
+
// verify the required parameter 'communicationId' is set
|
|
723
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
724
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklistJob';
|
|
725
|
+
}
|
|
726
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
727
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
728
|
+
throw 'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklistJob';
|
|
729
|
+
}
|
|
730
|
+
// verify the required parameter 'jobId' is set
|
|
731
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
732
|
+
throw 'Missing the required parameter "jobId" when calling getConversationCommunicationAgentchecklistJob';
|
|
733
|
+
}
|
|
734
|
+
|
|
735
|
+
return this.apiClient.callApi(
|
|
736
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs/{jobId}',
|
|
737
|
+
'GET',
|
|
738
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId,'jobId': jobId },
|
|
739
|
+
{ },
|
|
740
|
+
{ },
|
|
741
|
+
{ },
|
|
742
|
+
null,
|
|
743
|
+
['PureCloud OAuth'],
|
|
744
|
+
['application/json'],
|
|
745
|
+
['application/json']
|
|
746
|
+
);
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
/**
|
|
750
|
+
* Get information of all checklists associated with a conversation.
|
|
751
|
+
*
|
|
752
|
+
* @param {String} conversationId Conversation ID
|
|
753
|
+
* @param {String} communicationId Communication ID
|
|
754
|
+
*/
|
|
755
|
+
getConversationCommunicationAgentchecklists(conversationId, communicationId) {
|
|
756
|
+
// verify the required parameter 'conversationId' is set
|
|
757
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
758
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklists';
|
|
759
|
+
}
|
|
760
|
+
// verify the required parameter 'communicationId' is set
|
|
761
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
762
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklists';
|
|
763
|
+
}
|
|
764
|
+
|
|
765
|
+
return this.apiClient.callApi(
|
|
766
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists',
|
|
767
|
+
'GET',
|
|
768
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
769
|
+
{ },
|
|
770
|
+
{ },
|
|
771
|
+
{ },
|
|
772
|
+
null,
|
|
773
|
+
['PureCloud OAuth'],
|
|
774
|
+
['application/json'],
|
|
775
|
+
['application/json']
|
|
776
|
+
);
|
|
777
|
+
}
|
|
778
|
+
|
|
674
779
|
/**
|
|
675
780
|
* Get message
|
|
676
781
|
*
|
|
@@ -5226,6 +5331,161 @@ class ConversationsApi {
|
|
|
5226
5331
|
);
|
|
5227
5332
|
}
|
|
5228
5333
|
|
|
5334
|
+
/**
|
|
5335
|
+
* Agent Checklist activation API
|
|
5336
|
+
*
|
|
5337
|
+
* @param {String} conversationId Conversation ID
|
|
5338
|
+
* @param {String} communicationId Communication ID
|
|
5339
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
5340
|
+
* @param {Object} body Agent checklist activation payload
|
|
5341
|
+
*/
|
|
5342
|
+
postConversationCommunicationAgentchecklist(conversationId, communicationId, agentChecklistId, body) {
|
|
5343
|
+
// verify the required parameter 'conversationId' is set
|
|
5344
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
5345
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklist';
|
|
5346
|
+
}
|
|
5347
|
+
// verify the required parameter 'communicationId' is set
|
|
5348
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
5349
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklist';
|
|
5350
|
+
}
|
|
5351
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
5352
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
5353
|
+
throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklist';
|
|
5354
|
+
}
|
|
5355
|
+
// verify the required parameter 'body' is set
|
|
5356
|
+
if (body === undefined || body === null) {
|
|
5357
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklist';
|
|
5358
|
+
}
|
|
5359
|
+
|
|
5360
|
+
return this.apiClient.callApi(
|
|
5361
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}',
|
|
5362
|
+
'POST',
|
|
5363
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
5364
|
+
{ },
|
|
5365
|
+
{ },
|
|
5366
|
+
{ },
|
|
5367
|
+
body,
|
|
5368
|
+
['PureCloud OAuth'],
|
|
5369
|
+
['application/json'],
|
|
5370
|
+
['application/json']
|
|
5371
|
+
);
|
|
5372
|
+
}
|
|
5373
|
+
|
|
5374
|
+
/**
|
|
5375
|
+
* API invoked to capture an agent action.
|
|
5376
|
+
*
|
|
5377
|
+
* @param {String} conversationId Conversation ID
|
|
5378
|
+
* @param {String} communicationId Communication ID
|
|
5379
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
5380
|
+
* @param {Object} body Agent action payload
|
|
5381
|
+
*/
|
|
5382
|
+
postConversationCommunicationAgentchecklistAgentaction(conversationId, communicationId, agentChecklistId, body) {
|
|
5383
|
+
// verify the required parameter 'conversationId' is set
|
|
5384
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
5385
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
5386
|
+
}
|
|
5387
|
+
// verify the required parameter 'communicationId' is set
|
|
5388
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
5389
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
5390
|
+
}
|
|
5391
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
5392
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
5393
|
+
throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
5394
|
+
}
|
|
5395
|
+
// verify the required parameter 'body' is set
|
|
5396
|
+
if (body === undefined || body === null) {
|
|
5397
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
5398
|
+
}
|
|
5399
|
+
|
|
5400
|
+
return this.apiClient.callApi(
|
|
5401
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/agentaction',
|
|
5402
|
+
'POST',
|
|
5403
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
5404
|
+
{ },
|
|
5405
|
+
{ },
|
|
5406
|
+
{ },
|
|
5407
|
+
body,
|
|
5408
|
+
['PureCloud OAuth'],
|
|
5409
|
+
['application/json'],
|
|
5410
|
+
['application/json']
|
|
5411
|
+
);
|
|
5412
|
+
}
|
|
5413
|
+
|
|
5414
|
+
/**
|
|
5415
|
+
* Create inference job
|
|
5416
|
+
*
|
|
5417
|
+
* @param {String} conversationId Conversation ID
|
|
5418
|
+
* @param {String} communicationId Communication ID
|
|
5419
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
5420
|
+
* @param {Object} body Agent checklist inference job payload
|
|
5421
|
+
*/
|
|
5422
|
+
postConversationCommunicationAgentchecklistJobs(conversationId, communicationId, agentChecklistId, body) {
|
|
5423
|
+
// verify the required parameter 'conversationId' is set
|
|
5424
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
5425
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistJobs';
|
|
5426
|
+
}
|
|
5427
|
+
// verify the required parameter 'communicationId' is set
|
|
5428
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
5429
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistJobs';
|
|
5430
|
+
}
|
|
5431
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
5432
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
5433
|
+
throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistJobs';
|
|
5434
|
+
}
|
|
5435
|
+
// verify the required parameter 'body' is set
|
|
5436
|
+
if (body === undefined || body === null) {
|
|
5437
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistJobs';
|
|
5438
|
+
}
|
|
5439
|
+
|
|
5440
|
+
return this.apiClient.callApi(
|
|
5441
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs',
|
|
5442
|
+
'POST',
|
|
5443
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
5444
|
+
{ },
|
|
5445
|
+
{ },
|
|
5446
|
+
{ },
|
|
5447
|
+
body,
|
|
5448
|
+
['PureCloud OAuth'],
|
|
5449
|
+
['application/json'],
|
|
5450
|
+
['application/json']
|
|
5451
|
+
);
|
|
5452
|
+
}
|
|
5453
|
+
|
|
5454
|
+
/**
|
|
5455
|
+
* API invoked to finalize agent checklist evaluation.
|
|
5456
|
+
*
|
|
5457
|
+
* @param {String} conversationId Conversation ID
|
|
5458
|
+
* @param {String} communicationId Communication ID
|
|
5459
|
+
* @param {Object} body Agent checklist finalize payload
|
|
5460
|
+
*/
|
|
5461
|
+
postConversationCommunicationAgentchecklistsFinalize(conversationId, communicationId, body) {
|
|
5462
|
+
// verify the required parameter 'conversationId' is set
|
|
5463
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
5464
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistsFinalize';
|
|
5465
|
+
}
|
|
5466
|
+
// verify the required parameter 'communicationId' is set
|
|
5467
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
5468
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistsFinalize';
|
|
5469
|
+
}
|
|
5470
|
+
// verify the required parameter 'body' is set
|
|
5471
|
+
if (body === undefined || body === null) {
|
|
5472
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistsFinalize';
|
|
5473
|
+
}
|
|
5474
|
+
|
|
5475
|
+
return this.apiClient.callApi(
|
|
5476
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/finalize',
|
|
5477
|
+
'POST',
|
|
5478
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
5479
|
+
{ },
|
|
5480
|
+
{ },
|
|
5481
|
+
{ },
|
|
5482
|
+
body,
|
|
5483
|
+
['PureCloud OAuth'],
|
|
5484
|
+
['application/json'],
|
|
5485
|
+
['application/json']
|
|
5486
|
+
);
|
|
5487
|
+
}
|
|
5488
|
+
|
|
5229
5489
|
/**
|
|
5230
5490
|
* Send internal message
|
|
5231
5491
|
* Send a new internal message for an existing communication.
|
|
@@ -5390,11 +5650,12 @@ class ConversationsApi {
|
|
|
5390
5650
|
}
|
|
5391
5651
|
|
|
5392
5652
|
/**
|
|
5393
|
-
* Replace this participant
|
|
5394
|
-
*
|
|
5653
|
+
* Replace this participant (Deprecated)
|
|
5654
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
|
|
5395
5655
|
* @param {String} conversationId conversation ID
|
|
5396
5656
|
* @param {String} participantId participant ID
|
|
5397
5657
|
* @param {Object} body Transfer request
|
|
5658
|
+
* @deprecated
|
|
5398
5659
|
*/
|
|
5399
5660
|
postConversationParticipantReplace(conversationId, participantId, body) {
|
|
5400
5661
|
// verify the required parameter 'conversationId' is set
|
|
@@ -5465,7 +5726,6 @@ class ConversationsApi {
|
|
|
5465
5726
|
* @param {String} conversationId conversation ID
|
|
5466
5727
|
* @param {String} participantId participant ID
|
|
5467
5728
|
* @param {Object} body Transfer request
|
|
5468
|
-
* postConversationParticipantReplaceContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5469
5729
|
*/
|
|
5470
5730
|
postConversationParticipantReplaceContactExternal(conversationId, participantId, body) {
|
|
5471
5731
|
// verify the required parameter 'conversationId' is set
|
|
@@ -5496,11 +5756,12 @@ class ConversationsApi {
|
|
|
5496
5756
|
}
|
|
5497
5757
|
|
|
5498
5758
|
/**
|
|
5499
|
-
* Replace this participant with the an external contact
|
|
5500
|
-
*
|
|
5759
|
+
* Replace this participant with the an external contact (Deprecated)
|
|
5760
|
+
* This endpoint is deprecated. Use /replace/contact/external endpoint instead.
|
|
5501
5761
|
* @param {String} conversationId conversation ID
|
|
5502
5762
|
* @param {String} participantId participant ID
|
|
5503
5763
|
* @param {Object} body Transfer request
|
|
5764
|
+
* @deprecated
|
|
5504
5765
|
*/
|
|
5505
5766
|
postConversationParticipantReplaceExternal(conversationId, participantId, body) {
|
|
5506
5767
|
// verify the required parameter 'conversationId' is set
|
|
@@ -5605,7 +5866,6 @@ class ConversationsApi {
|
|
|
5605
5866
|
* @param {String} conversationId conversation ID
|
|
5606
5867
|
* @param {String} participantId participant ID
|
|
5607
5868
|
* @param {Object} body Transfer request
|
|
5608
|
-
* postConversationParticipantTransfer is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5609
5869
|
*/
|
|
5610
5870
|
postConversationParticipantTransfer(conversationId, participantId, body) {
|
|
5611
5871
|
// verify the required parameter 'conversationId' is set
|
|
@@ -5865,11 +6125,12 @@ class ConversationsApi {
|
|
|
5865
6125
|
}
|
|
5866
6126
|
|
|
5867
6127
|
/**
|
|
5868
|
-
* Initiate and update consult transfer
|
|
5869
|
-
*
|
|
6128
|
+
* Initiate and update consult transfer (Deprecated)
|
|
6129
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
|
|
5870
6130
|
* @param {String} conversationId conversationId
|
|
5871
6131
|
* @param {String} participantId participantId
|
|
5872
6132
|
* @param {Object} body Destination address and initial speak to
|
|
6133
|
+
* @deprecated
|
|
5873
6134
|
*/
|
|
5874
6135
|
postConversationsCallParticipantConsult(conversationId, participantId, body) {
|
|
5875
6136
|
// verify the required parameter 'conversationId' is set
|
|
@@ -5940,7 +6201,6 @@ class ConversationsApi {
|
|
|
5940
6201
|
* @param {String} conversationId conversationId
|
|
5941
6202
|
* @param {String} participantId participantId
|
|
5942
6203
|
* @param {Object} body Destination address and initial speak to
|
|
5943
|
-
* postConversationsCallParticipantConsultContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5944
6204
|
*/
|
|
5945
6205
|
postConversationsCallParticipantConsultContactExternal(conversationId, participantId, body) {
|
|
5946
6206
|
// verify the required parameter 'conversationId' is set
|
|
@@ -5971,11 +6231,12 @@ class ConversationsApi {
|
|
|
5971
6231
|
}
|
|
5972
6232
|
|
|
5973
6233
|
/**
|
|
5974
|
-
* Initiate a consult transfer to an external contact
|
|
5975
|
-
*
|
|
6234
|
+
* Initiate a consult transfer to an external contact (Deprecated)
|
|
6235
|
+
* This endpoint is deprecated. Use /consult/contact/external endpoints instead.
|
|
5976
6236
|
* @param {String} conversationId conversationId
|
|
5977
6237
|
* @param {String} participantId participantId
|
|
5978
6238
|
* @param {Object} body Destination address and initial speak to
|
|
6239
|
+
* @deprecated
|
|
5979
6240
|
*/
|
|
5980
6241
|
postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
|
|
5981
6242
|
// verify the required parameter 'conversationId' is set
|
|
@@ -6111,7 +6372,6 @@ class ConversationsApi {
|
|
|
6111
6372
|
* @param {String} conversationId conversationId
|
|
6112
6373
|
* @param {String} participantId participantId
|
|
6113
6374
|
* @param {Object} body Destination address and initial speak to
|
|
6114
|
-
* postConversationsCallParticipantVoiceConsult is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6115
6375
|
*/
|
|
6116
6376
|
postConversationsCallParticipantVoiceConsult(conversationId, participantId, body) {
|
|
6117
6377
|
// verify the required parameter 'conversationId' is set
|
|
@@ -5,7 +5,7 @@ class JourneyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Journey service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 241.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -378,7 +378,7 @@ class JourneyApi {
|
|
|
378
378
|
* @param {String} opts.filterValue Value to filter by. Requires 'filterValue' to also be set.
|
|
379
379
|
* @param {Array.<String>} opts.actionMapIds IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.
|
|
380
380
|
* @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires 'queryValue' to also be set.
|
|
381
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
381
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
382
382
|
*/
|
|
383
383
|
getJourneyActionmaps(opts) {
|
|
384
384
|
opts = opts || {};
|
|
@@ -533,7 +533,7 @@ class JourneyApi {
|
|
|
533
533
|
* @param {Object} opts.mediaType Media type
|
|
534
534
|
* @param {Object} opts.state Action template state.
|
|
535
535
|
* @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
|
|
536
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
536
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
537
537
|
*/
|
|
538
538
|
getJourneyActiontemplates(opts) {
|
|
539
539
|
opts = opts || {};
|
|
@@ -625,7 +625,7 @@ class JourneyApi {
|
|
|
625
625
|
* @param {String} opts.sortBy Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
|
|
626
626
|
* @param {Array.<String>} opts.outcomeIds IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.
|
|
627
627
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
628
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
628
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
629
629
|
*/
|
|
630
630
|
getJourneyOutcomes(opts) {
|
|
631
631
|
opts = opts || {};
|
|
@@ -777,7 +777,7 @@ class JourneyApi {
|
|
|
777
777
|
* @param {Boolean} opts.isActive Determines whether or not to show only active segments.
|
|
778
778
|
* @param {Array.<String>} opts.segmentIds IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.
|
|
779
779
|
* @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires 'queryValue' to also be set.
|
|
780
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
780
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
781
781
|
*/
|
|
782
782
|
getJourneySegments(opts) {
|
|
783
783
|
opts = opts || {};
|