purecloud-platform-client-v2 251.2.0 → 252.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 +392 -125
- package/dist/web-amd/purecloud-platform-client-v2.js +392 -125
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +25682 -25547
- package/dist/web-cjs/purecloud-platform-client-v2.js +25682 -25547
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +312 -94
- package/package.json +2 -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 +38 -2
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.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/BackgroundAssistantApi.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/CaseManagementApi.js +32 -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 +72 -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 +32 -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/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +49 -33
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +4 -2
- 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 +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/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 +2 -2
- 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 +83 -3
- 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
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "purecloud-platform-client-v2",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "252.0.0",
|
|
4
4
|
"description": "A JavaScript library to interface with the PureCloud Platform API",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/node/purecloud-platform-client-v2.js",
|
|
@@ -41,6 +41,7 @@
|
|
|
41
41
|
"expect.js": "~0.3.1",
|
|
42
42
|
"@babel/core": "^7.23.3",
|
|
43
43
|
"@babel/preset-env": "^7.23.3",
|
|
44
|
+
"@babel/plugin-transform-nullish-coalescing-operator": "^7.23.4",
|
|
44
45
|
"rollup": "^2.79.1",
|
|
45
46
|
"uglify-es": "^3.3.9",
|
|
46
47
|
"browserify": "^17.0.0",
|
|
@@ -5,7 +5,7 @@ class ArchitectApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Architect service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 252.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -3997,12 +3997,48 @@ class ArchitectApi {
|
|
|
3997
3997
|
}
|
|
3998
3998
|
|
|
3999
3999
|
/**
|
|
4000
|
-
* Begin an import process for importing rows into a datatable
|
|
4000
|
+
* Begin an import process for importing rows from a CSV file into a datatable. CSV file is uploaded by performing a PUT request against the URL in the returned 'uploadURI' field. Headers for the PUT request must contain all headers contained in the returned 'uploadHeaders' field.
|
|
4001
|
+
* Create an import job for importing rows from a CSV file. The caller can then poll for status of the import using the token returned in the response
|
|
4002
|
+
* @param {String} datatableId id of datatable
|
|
4003
|
+
* @param {Object} body import job information
|
|
4004
|
+
* @param {Object} opts Optional parameters
|
|
4005
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4006
|
+
*/
|
|
4007
|
+
postFlowsDatatableImportCsvJobs(datatableId, body, opts) {
|
|
4008
|
+
opts = opts || {};
|
|
4009
|
+
|
|
4010
|
+
// verify the required parameter 'datatableId' is set
|
|
4011
|
+
if (datatableId === undefined || datatableId === null || datatableId === '') {
|
|
4012
|
+
throw 'Missing the required parameter "datatableId" when calling postFlowsDatatableImportCsvJobs';
|
|
4013
|
+
}
|
|
4014
|
+
// verify the required parameter 'body' is set
|
|
4015
|
+
if (body === undefined || body === null) {
|
|
4016
|
+
throw 'Missing the required parameter "body" when calling postFlowsDatatableImportCsvJobs';
|
|
4017
|
+
}
|
|
4018
|
+
|
|
4019
|
+
return this.apiClient.callApi(
|
|
4020
|
+
'/api/v2/flows/datatables/{datatableId}/import/csv/jobs',
|
|
4021
|
+
'POST',
|
|
4022
|
+
{ 'datatableId': datatableId },
|
|
4023
|
+
{ },
|
|
4024
|
+
{ },
|
|
4025
|
+
{ },
|
|
4026
|
+
body,
|
|
4027
|
+
['PureCloud OAuth'],
|
|
4028
|
+
['application/json'],
|
|
4029
|
+
['application/json'],
|
|
4030
|
+
opts['customHeaders']
|
|
4031
|
+
);
|
|
4032
|
+
}
|
|
4033
|
+
|
|
4034
|
+
/**
|
|
4035
|
+
* Begin an import process for importing rows into a datatable. Apps should migrate to use POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs instead
|
|
4001
4036
|
* Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response
|
|
4002
4037
|
* @param {String} datatableId id of datatable
|
|
4003
4038
|
* @param {Object} body import job information
|
|
4004
4039
|
* @param {Object} opts Optional parameters
|
|
4005
4040
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4041
|
+
* @deprecated
|
|
4006
4042
|
*/
|
|
4007
4043
|
postFlowsDatatableImportJobs(datatableId, body, opts) {
|
|
4008
4044
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class CaseManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* CaseManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 252.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1167,6 +1167,37 @@ class CaseManagementApi {
|
|
|
1167
1167
|
);
|
|
1168
1168
|
}
|
|
1169
1169
|
|
|
1170
|
+
/**
|
|
1171
|
+
* Query for caseplans
|
|
1172
|
+
*
|
|
1173
|
+
* @param {Object} body CaseplanQueryRequest
|
|
1174
|
+
* @param {Object} opts Optional parameters
|
|
1175
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1176
|
+
* postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1177
|
+
*/
|
|
1178
|
+
postCasemanagementCaseplansQuery(body, opts) {
|
|
1179
|
+
opts = opts || {};
|
|
1180
|
+
|
|
1181
|
+
// verify the required parameter 'body' is set
|
|
1182
|
+
if (body === undefined || body === null) {
|
|
1183
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCaseplansQuery';
|
|
1184
|
+
}
|
|
1185
|
+
|
|
1186
|
+
return this.apiClient.callApi(
|
|
1187
|
+
'/api/v2/casemanagement/caseplans/query',
|
|
1188
|
+
'POST',
|
|
1189
|
+
{ },
|
|
1190
|
+
{ },
|
|
1191
|
+
{ },
|
|
1192
|
+
{ },
|
|
1193
|
+
body,
|
|
1194
|
+
['PureCloud OAuth'],
|
|
1195
|
+
['application/json'],
|
|
1196
|
+
['application/json'],
|
|
1197
|
+
opts['customHeaders']
|
|
1198
|
+
);
|
|
1199
|
+
}
|
|
1200
|
+
|
|
1170
1201
|
/**
|
|
1171
1202
|
* Create a Case.
|
|
1172
1203
|
*
|
|
@@ -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 252.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -893,6 +893,37 @@ class ConversationsApi {
|
|
|
893
893
|
);
|
|
894
894
|
}
|
|
895
895
|
|
|
896
|
+
/**
|
|
897
|
+
* Get copilot context values for a conversation.
|
|
898
|
+
*
|
|
899
|
+
* @param {String} conversationId Conversation ID.
|
|
900
|
+
* @param {Object} opts Optional parameters
|
|
901
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
902
|
+
* getConversationAssistantCopilotcontext is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
903
|
+
*/
|
|
904
|
+
getConversationAssistantCopilotcontext(conversationId, opts) {
|
|
905
|
+
opts = opts || {};
|
|
906
|
+
|
|
907
|
+
// verify the required parameter 'conversationId' is set
|
|
908
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
909
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationAssistantCopilotcontext';
|
|
910
|
+
}
|
|
911
|
+
|
|
912
|
+
return this.apiClient.callApi(
|
|
913
|
+
'/api/v2/conversations/{conversationId}/assistant/copilotcontext',
|
|
914
|
+
'GET',
|
|
915
|
+
{ 'conversationId': conversationId },
|
|
916
|
+
{ },
|
|
917
|
+
{ },
|
|
918
|
+
{ },
|
|
919
|
+
null,
|
|
920
|
+
['PureCloud OAuth'],
|
|
921
|
+
['application/json'],
|
|
922
|
+
['application/json'],
|
|
923
|
+
opts['customHeaders']
|
|
924
|
+
);
|
|
925
|
+
}
|
|
926
|
+
|
|
896
927
|
/**
|
|
897
928
|
* Get checklist info for a single checklist.
|
|
898
929
|
*
|
|
@@ -6047,6 +6078,46 @@ class ConversationsApi {
|
|
|
6047
6078
|
);
|
|
6048
6079
|
}
|
|
6049
6080
|
|
|
6081
|
+
/**
|
|
6082
|
+
* Update conversation by setting its parking state
|
|
6083
|
+
*
|
|
6084
|
+
* @param {String} conversationId conversationId
|
|
6085
|
+
* @param {String} participantId participantId
|
|
6086
|
+
* @param {Object} body Parking update request
|
|
6087
|
+
* @param {Object} opts Optional parameters
|
|
6088
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6089
|
+
*/
|
|
6090
|
+
patchConversationsMessageParticipantParkingstate(conversationId, participantId, body, opts) {
|
|
6091
|
+
opts = opts || {};
|
|
6092
|
+
|
|
6093
|
+
// verify the required parameter 'conversationId' is set
|
|
6094
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
6095
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsMessageParticipantParkingstate';
|
|
6096
|
+
}
|
|
6097
|
+
// verify the required parameter 'participantId' is set
|
|
6098
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
6099
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsMessageParticipantParkingstate';
|
|
6100
|
+
}
|
|
6101
|
+
// verify the required parameter 'body' is set
|
|
6102
|
+
if (body === undefined || body === null) {
|
|
6103
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessageParticipantParkingstate';
|
|
6104
|
+
}
|
|
6105
|
+
|
|
6106
|
+
return this.apiClient.callApi(
|
|
6107
|
+
'/api/v2/conversations/messages/{conversationId}/participants/{participantId}/parkingstate',
|
|
6108
|
+
'PATCH',
|
|
6109
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
6110
|
+
{ },
|
|
6111
|
+
{ },
|
|
6112
|
+
{ },
|
|
6113
|
+
body,
|
|
6114
|
+
['PureCloud OAuth'],
|
|
6115
|
+
['application/json'],
|
|
6116
|
+
['application/json'],
|
|
6117
|
+
opts['customHeaders']
|
|
6118
|
+
);
|
|
6119
|
+
}
|
|
6120
|
+
|
|
6050
6121
|
/**
|
|
6051
6122
|
* Update an Apple messaging integration
|
|
6052
6123
|
*
|
|
@@ -5,7 +5,7 @@ class EventsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Events service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 252.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -50,6 +50,37 @@ class EventsApi {
|
|
|
50
50
|
);
|
|
51
51
|
}
|
|
52
52
|
|
|
53
|
+
/**
|
|
54
|
+
* Publish Predictive Routing Custom Kpi Attribution Batch Events
|
|
55
|
+
*
|
|
56
|
+
* @param {Object} body batchRequest
|
|
57
|
+
* @param {Object} opts Optional parameters
|
|
58
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
59
|
+
* postEventsRoutingCustomkpiattributions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60
|
+
*/
|
|
61
|
+
postEventsRoutingCustomkpiattributions(body, opts) {
|
|
62
|
+
opts = opts || {};
|
|
63
|
+
|
|
64
|
+
// verify the required parameter 'body' is set
|
|
65
|
+
if (body === undefined || body === null) {
|
|
66
|
+
throw 'Missing the required parameter "body" when calling postEventsRoutingCustomkpiattributions';
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return this.apiClient.callApi(
|
|
70
|
+
'/api/v2/events/routing/customkpiattributions',
|
|
71
|
+
'POST',
|
|
72
|
+
{ },
|
|
73
|
+
{ },
|
|
74
|
+
{ },
|
|
75
|
+
{ },
|
|
76
|
+
body,
|
|
77
|
+
['PureCloud OAuth'],
|
|
78
|
+
['application/json'],
|
|
79
|
+
['application/json'],
|
|
80
|
+
opts['customHeaders']
|
|
81
|
+
);
|
|
82
|
+
}
|
|
83
|
+
|
|
53
84
|
/**
|
|
54
85
|
* Publish User Presence Status Batch Events
|
|
55
86
|
*
|