purecloud-platform-client-v2 225.0.0 → 226.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 +232 -128
- package/dist/web-amd/purecloud-platform-client-v2.js +232 -128
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +128 -94
- package/dist/web-cjs/purecloud-platform-client-v2.js +128 -94
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +132 -162
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -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 +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/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 +145 -1
- 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 +3 -2
- 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 +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 +3 -2
- 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 +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 +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 -43
- 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 226.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -5134,6 +5134,42 @@ class ConversationsApi {
|
|
|
5134
5134
|
);
|
|
5135
5135
|
}
|
|
5136
5136
|
|
|
5137
|
+
/**
|
|
5138
|
+
* Replace this participant with the an external contact
|
|
5139
|
+
*
|
|
5140
|
+
* @param {String} conversationId conversation ID
|
|
5141
|
+
* @param {String} participantId participant ID
|
|
5142
|
+
* @param {Object} body Transfer request
|
|
5143
|
+
* postConversationParticipantReplaceContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5144
|
+
*/
|
|
5145
|
+
postConversationParticipantReplaceContactExternal(conversationId, participantId, body) {
|
|
5146
|
+
// verify the required parameter 'conversationId' is set
|
|
5147
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
5148
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceContactExternal';
|
|
5149
|
+
}
|
|
5150
|
+
// verify the required parameter 'participantId' is set
|
|
5151
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
5152
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceContactExternal';
|
|
5153
|
+
}
|
|
5154
|
+
// verify the required parameter 'body' is set
|
|
5155
|
+
if (body === undefined || body === null) {
|
|
5156
|
+
throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceContactExternal';
|
|
5157
|
+
}
|
|
5158
|
+
|
|
5159
|
+
return this.apiClient.callApi(
|
|
5160
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/replace/contact/external',
|
|
5161
|
+
'POST',
|
|
5162
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
5163
|
+
{ },
|
|
5164
|
+
{ },
|
|
5165
|
+
{ },
|
|
5166
|
+
body,
|
|
5167
|
+
['PureCloud OAuth'],
|
|
5168
|
+
['application/json'],
|
|
5169
|
+
['application/json']
|
|
5170
|
+
);
|
|
5171
|
+
}
|
|
5172
|
+
|
|
5137
5173
|
/**
|
|
5138
5174
|
* Replace this participant with the an external contact
|
|
5139
5175
|
*
|
|
@@ -5238,6 +5274,42 @@ class ConversationsApi {
|
|
|
5238
5274
|
);
|
|
5239
5275
|
}
|
|
5240
5276
|
|
|
5277
|
+
/**
|
|
5278
|
+
* Replace this participant by another one using the address of the destination.
|
|
5279
|
+
*
|
|
5280
|
+
* @param {String} conversationId conversation ID
|
|
5281
|
+
* @param {String} participantId participant ID
|
|
5282
|
+
* @param {Object} body Transfer request
|
|
5283
|
+
* postConversationParticipantTransfer is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5284
|
+
*/
|
|
5285
|
+
postConversationParticipantTransfer(conversationId, participantId, body) {
|
|
5286
|
+
// verify the required parameter 'conversationId' is set
|
|
5287
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
5288
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantTransfer';
|
|
5289
|
+
}
|
|
5290
|
+
// verify the required parameter 'participantId' is set
|
|
5291
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
5292
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantTransfer';
|
|
5293
|
+
}
|
|
5294
|
+
// verify the required parameter 'body' is set
|
|
5295
|
+
if (body === undefined || body === null) {
|
|
5296
|
+
throw 'Missing the required parameter "body" when calling postConversationParticipantTransfer';
|
|
5297
|
+
}
|
|
5298
|
+
|
|
5299
|
+
return this.apiClient.callApi(
|
|
5300
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/transfer',
|
|
5301
|
+
'POST',
|
|
5302
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
5303
|
+
{ },
|
|
5304
|
+
{ },
|
|
5305
|
+
{ },
|
|
5306
|
+
body,
|
|
5307
|
+
['PureCloud OAuth'],
|
|
5308
|
+
['application/json'],
|
|
5309
|
+
['application/json']
|
|
5310
|
+
);
|
|
5311
|
+
}
|
|
5312
|
+
|
|
5241
5313
|
/**
|
|
5242
5314
|
* Save an engagement on the suggestion.
|
|
5243
5315
|
*
|
|
@@ -5537,6 +5609,42 @@ class ConversationsApi {
|
|
|
5537
5609
|
);
|
|
5538
5610
|
}
|
|
5539
5611
|
|
|
5612
|
+
/**
|
|
5613
|
+
* Initiate a consult transfer to an external contact
|
|
5614
|
+
*
|
|
5615
|
+
* @param {String} conversationId conversationId
|
|
5616
|
+
* @param {String} participantId participantId
|
|
5617
|
+
* @param {Object} body Destination address and initial speak to
|
|
5618
|
+
* postConversationsCallParticipantConsultContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5619
|
+
*/
|
|
5620
|
+
postConversationsCallParticipantConsultContactExternal(conversationId, participantId, body) {
|
|
5621
|
+
// verify the required parameter 'conversationId' is set
|
|
5622
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
5623
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultContactExternal';
|
|
5624
|
+
}
|
|
5625
|
+
// verify the required parameter 'participantId' is set
|
|
5626
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
5627
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultContactExternal';
|
|
5628
|
+
}
|
|
5629
|
+
// verify the required parameter 'body' is set
|
|
5630
|
+
if (body === undefined || body === null) {
|
|
5631
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultContactExternal';
|
|
5632
|
+
}
|
|
5633
|
+
|
|
5634
|
+
return this.apiClient.callApi(
|
|
5635
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/contact/external',
|
|
5636
|
+
'POST',
|
|
5637
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
5638
|
+
{ },
|
|
5639
|
+
{ },
|
|
5640
|
+
{ },
|
|
5641
|
+
body,
|
|
5642
|
+
['PureCloud OAuth'],
|
|
5643
|
+
['application/json'],
|
|
5644
|
+
['application/json']
|
|
5645
|
+
);
|
|
5646
|
+
}
|
|
5647
|
+
|
|
5540
5648
|
/**
|
|
5541
5649
|
* Initiate a consult transfer to an external contact
|
|
5542
5650
|
*
|
|
@@ -5672,6 +5780,42 @@ class ConversationsApi {
|
|
|
5672
5780
|
);
|
|
5673
5781
|
}
|
|
5674
5782
|
|
|
5783
|
+
/**
|
|
5784
|
+
* Initiate voice consult transfer
|
|
5785
|
+
*
|
|
5786
|
+
* @param {String} conversationId conversationId
|
|
5787
|
+
* @param {String} participantId participantId
|
|
5788
|
+
* @param {Object} body Destination address and initial speak to
|
|
5789
|
+
* postConversationsCallParticipantVoiceConsult is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5790
|
+
*/
|
|
5791
|
+
postConversationsCallParticipantVoiceConsult(conversationId, participantId, body) {
|
|
5792
|
+
// verify the required parameter 'conversationId' is set
|
|
5793
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
5794
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantVoiceConsult';
|
|
5795
|
+
}
|
|
5796
|
+
// verify the required parameter 'participantId' is set
|
|
5797
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
5798
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantVoiceConsult';
|
|
5799
|
+
}
|
|
5800
|
+
// verify the required parameter 'body' is set
|
|
5801
|
+
if (body === undefined || body === null) {
|
|
5802
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallParticipantVoiceConsult';
|
|
5803
|
+
}
|
|
5804
|
+
|
|
5805
|
+
return this.apiClient.callApi(
|
|
5806
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/voice/consult',
|
|
5807
|
+
'POST',
|
|
5808
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
5809
|
+
{ },
|
|
5810
|
+
{ },
|
|
5811
|
+
{ },
|
|
5812
|
+
body,
|
|
5813
|
+
['PureCloud OAuth'],
|
|
5814
|
+
['application/json'],
|
|
5815
|
+
['application/json']
|
|
5816
|
+
);
|
|
5817
|
+
}
|
|
5818
|
+
|
|
5675
5819
|
/**
|
|
5676
5820
|
* Add participants to a conversation
|
|
5677
5821
|
*
|
|
@@ -5,7 +5,7 @@ class IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 226.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -943,10 +943,11 @@ class IntegrationsApi {
|
|
|
943
943
|
|
|
944
944
|
/**
|
|
945
945
|
* List multiple sets of credentials
|
|
946
|
-
*
|
|
946
|
+
* This endpoint is deprecated. Please see the Listing API (GET /api/v2/integrations/credentials/listing)
|
|
947
947
|
* @param {Object} opts Optional parameters
|
|
948
948
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
949
949
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
950
|
+
* @deprecated
|
|
950
951
|
*/
|
|
951
952
|
getIntegrationsCredentials(opts) {
|
|
952
953
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class RoutingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Routing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 226.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1586,6 +1586,7 @@ class RoutingApi {
|
|
|
1586
1586
|
* @param {Object} opts Optional parameters
|
|
1587
1587
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1588
1588
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1589
|
+
* @param {String} opts.name Wrapup code's name (trailing asterisks allowed)
|
|
1589
1590
|
*/
|
|
1590
1591
|
getRoutingQueueWrapupcodes(queueId, opts) {
|
|
1591
1592
|
opts = opts || {};
|
|
@@ -1599,7 +1600,7 @@ class RoutingApi {
|
|
|
1599
1600
|
'/api/v2/routing/queues/{queueId}/wrapupcodes',
|
|
1600
1601
|
'GET',
|
|
1601
1602
|
{ 'queueId': queueId },
|
|
1602
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
1603
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'name': opts['name'] },
|
|
1603
1604
|
{ },
|
|
1604
1605
|
{ },
|
|
1605
1606
|
null,
|