purecloud-platform-client-v2 227.0.0 → 229.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 +1841 -237
- package/dist/web-amd/purecloud-platform-client-v2.js +1841 -237
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +583 -188
- package/dist/web-cjs/purecloud-platform-client-v2.js +583 -188
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1320 -290
- package/package.json +4 -4
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +32 -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 +391 -26
- 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 +4 -46
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +7 -4
- 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 +61 -35
- 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 +60 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +27 -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 +86 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -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 +101 -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 +53 -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/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 -26
- 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 +158 -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 +105 -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 +121 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -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 +12 -12
- 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 +6 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +494 -6
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SpeechTextAnalytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 229.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -99,6 +99,32 @@ class SpeechTextAnalyticsApi {
|
|
|
99
99
|
);
|
|
100
100
|
}
|
|
101
101
|
|
|
102
|
+
/**
|
|
103
|
+
* Delete a Speech and Text Analytics Reprocessing job by Id
|
|
104
|
+
*
|
|
105
|
+
* @param {String} jobId The Id of the Reprocessing job
|
|
106
|
+
* deleteSpeechandtextanalyticsReprocessingJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
107
|
+
*/
|
|
108
|
+
deleteSpeechandtextanalyticsReprocessingJob(jobId) {
|
|
109
|
+
// verify the required parameter 'jobId' is set
|
|
110
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
111
|
+
throw 'Missing the required parameter "jobId" when calling deleteSpeechandtextanalyticsReprocessingJob';
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
return this.apiClient.callApi(
|
|
115
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs/{jobId}',
|
|
116
|
+
'DELETE',
|
|
117
|
+
{ 'jobId': jobId },
|
|
118
|
+
{ },
|
|
119
|
+
{ },
|
|
120
|
+
{ },
|
|
121
|
+
null,
|
|
122
|
+
['PureCloud OAuth'],
|
|
123
|
+
['application/json'],
|
|
124
|
+
['application/json']
|
|
125
|
+
);
|
|
126
|
+
}
|
|
127
|
+
|
|
102
128
|
/**
|
|
103
129
|
* Delete All Speech and Text Analytics SentimentFeedback
|
|
104
130
|
*
|
|
@@ -338,6 +364,31 @@ class SpeechTextAnalyticsApi {
|
|
|
338
364
|
);
|
|
339
365
|
}
|
|
340
366
|
|
|
367
|
+
/**
|
|
368
|
+
* Get sentiment data
|
|
369
|
+
*
|
|
370
|
+
* @param {String} conversationId The conversation ID of the sentiment data
|
|
371
|
+
*/
|
|
372
|
+
getSpeechandtextanalyticsConversationSentiments(conversationId) {
|
|
373
|
+
// verify the required parameter 'conversationId' is set
|
|
374
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
375
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationSentiments';
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
return this.apiClient.callApi(
|
|
379
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/sentiments',
|
|
380
|
+
'GET',
|
|
381
|
+
{ 'conversationId': conversationId },
|
|
382
|
+
{ },
|
|
383
|
+
{ },
|
|
384
|
+
{ },
|
|
385
|
+
null,
|
|
386
|
+
['PureCloud OAuth'],
|
|
387
|
+
['application/json'],
|
|
388
|
+
['application/json']
|
|
389
|
+
);
|
|
390
|
+
}
|
|
391
|
+
|
|
341
392
|
/**
|
|
342
393
|
* Get conversation summaries by conversation id.
|
|
343
394
|
*
|
|
@@ -686,6 +737,86 @@ class SpeechTextAnalyticsApi {
|
|
|
686
737
|
);
|
|
687
738
|
}
|
|
688
739
|
|
|
740
|
+
/**
|
|
741
|
+
* Get a Speech and Text Analytics reprocess job by id
|
|
742
|
+
*
|
|
743
|
+
* @param {String} jobId The Id of the Reprocessing job
|
|
744
|
+
* getSpeechandtextanalyticsReprocessingJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
745
|
+
*/
|
|
746
|
+
getSpeechandtextanalyticsReprocessingJob(jobId) {
|
|
747
|
+
// verify the required parameter 'jobId' is set
|
|
748
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
749
|
+
throw 'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsReprocessingJob';
|
|
750
|
+
}
|
|
751
|
+
|
|
752
|
+
return this.apiClient.callApi(
|
|
753
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs/{jobId}',
|
|
754
|
+
'GET',
|
|
755
|
+
{ 'jobId': jobId },
|
|
756
|
+
{ },
|
|
757
|
+
{ },
|
|
758
|
+
{ },
|
|
759
|
+
null,
|
|
760
|
+
['PureCloud OAuth'],
|
|
761
|
+
['application/json'],
|
|
762
|
+
['application/json']
|
|
763
|
+
);
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
/**
|
|
767
|
+
* Get a Speech and Text Analytics Reprocessing interactions statuses by job id
|
|
768
|
+
*
|
|
769
|
+
* @param {String} jobId The Id of the Reprocessing job
|
|
770
|
+
* getSpeechandtextanalyticsReprocessingJobInteractions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
771
|
+
*/
|
|
772
|
+
getSpeechandtextanalyticsReprocessingJobInteractions(jobId) {
|
|
773
|
+
// verify the required parameter 'jobId' is set
|
|
774
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
775
|
+
throw 'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsReprocessingJobInteractions';
|
|
776
|
+
}
|
|
777
|
+
|
|
778
|
+
return this.apiClient.callApi(
|
|
779
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs/{jobId}/interactions',
|
|
780
|
+
'GET',
|
|
781
|
+
{ 'jobId': jobId },
|
|
782
|
+
{ },
|
|
783
|
+
{ },
|
|
784
|
+
{ },
|
|
785
|
+
null,
|
|
786
|
+
['PureCloud OAuth'],
|
|
787
|
+
['application/json'],
|
|
788
|
+
['application/json']
|
|
789
|
+
);
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
/**
|
|
793
|
+
* Get the list of Speech and Text Analytics reprocess jobs
|
|
794
|
+
*
|
|
795
|
+
* @param {Object} opts Optional parameters
|
|
796
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 100. Default is 25.
|
|
797
|
+
* @param {Number} opts.pageNumber The page number for the listing. Defaults to 1.
|
|
798
|
+
* @param {Object} opts.sortOrder Results are sorted by dateCreated. Please choose the sort order. The default is descending (desc).
|
|
799
|
+
* @param {String} opts.name Case insensitive partial name to filter by.
|
|
800
|
+
* getSpeechandtextanalyticsReprocessingJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
801
|
+
*/
|
|
802
|
+
getSpeechandtextanalyticsReprocessingJobs(opts) {
|
|
803
|
+
opts = opts || {};
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
return this.apiClient.callApi(
|
|
807
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs',
|
|
808
|
+
'GET',
|
|
809
|
+
{ },
|
|
810
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
811
|
+
{ },
|
|
812
|
+
{ },
|
|
813
|
+
null,
|
|
814
|
+
['PureCloud OAuth'],
|
|
815
|
+
['application/json'],
|
|
816
|
+
['application/json']
|
|
817
|
+
);
|
|
818
|
+
}
|
|
819
|
+
|
|
689
820
|
/**
|
|
690
821
|
* Get the list of Speech and Text Analytics sentiment supported dialects
|
|
691
822
|
*
|
|
@@ -1129,6 +1260,32 @@ class SpeechTextAnalyticsApi {
|
|
|
1129
1260
|
);
|
|
1130
1261
|
}
|
|
1131
1262
|
|
|
1263
|
+
/**
|
|
1264
|
+
* Create a Speech and Text Analytics reprocess job.
|
|
1265
|
+
*
|
|
1266
|
+
* @param {Object} body The ReprocessJob to create
|
|
1267
|
+
* postSpeechandtextanalyticsReprocessingJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1268
|
+
*/
|
|
1269
|
+
postSpeechandtextanalyticsReprocessingJobs(body) {
|
|
1270
|
+
// verify the required parameter 'body' is set
|
|
1271
|
+
if (body === undefined || body === null) {
|
|
1272
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsReprocessingJobs';
|
|
1273
|
+
}
|
|
1274
|
+
|
|
1275
|
+
return this.apiClient.callApi(
|
|
1276
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs',
|
|
1277
|
+
'POST',
|
|
1278
|
+
{ },
|
|
1279
|
+
{ },
|
|
1280
|
+
{ },
|
|
1281
|
+
{ },
|
|
1282
|
+
body,
|
|
1283
|
+
['PureCloud OAuth'],
|
|
1284
|
+
['application/json'],
|
|
1285
|
+
['application/json']
|
|
1286
|
+
);
|
|
1287
|
+
}
|
|
1288
|
+
|
|
1132
1289
|
/**
|
|
1133
1290
|
* Create a Speech and Text Analytics SentimentFeedback
|
|
1134
1291
|
*
|
|
@@ -5,7 +5,7 @@ class TelephonyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Telephony service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 229.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,53 @@ class TelephonyApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Get an agent's greetings.
|
|
25
|
+
*
|
|
26
|
+
* @param {String} agentId User ID
|
|
27
|
+
* getTelephonyAgentGreetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
|
+
*/
|
|
29
|
+
getTelephonyAgentGreetings(agentId) {
|
|
30
|
+
// verify the required parameter 'agentId' is set
|
|
31
|
+
if (agentId === undefined || agentId === null || agentId === '') {
|
|
32
|
+
throw 'Missing the required parameter "agentId" when calling getTelephonyAgentGreetings';
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return this.apiClient.callApi(
|
|
36
|
+
'/api/v2/telephony/agents/{agentId}/greetings',
|
|
37
|
+
'GET',
|
|
38
|
+
{ 'agentId': agentId },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
{ },
|
|
42
|
+
null,
|
|
43
|
+
['PureCloud OAuth'],
|
|
44
|
+
['application/json'],
|
|
45
|
+
['application/json']
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Get the agent's own greetings.
|
|
51
|
+
*
|
|
52
|
+
* getTelephonyAgentsGreetingsMe is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
53
|
+
*/
|
|
54
|
+
getTelephonyAgentsGreetingsMe() {
|
|
55
|
+
|
|
56
|
+
return this.apiClient.callApi(
|
|
57
|
+
'/api/v2/telephony/agents/greetings/me',
|
|
58
|
+
'GET',
|
|
59
|
+
{ },
|
|
60
|
+
{ },
|
|
61
|
+
{ },
|
|
62
|
+
{ },
|
|
63
|
+
null,
|
|
64
|
+
['PureCloud OAuth'],
|
|
65
|
+
['application/json'],
|
|
66
|
+
['application/json']
|
|
67
|
+
);
|
|
68
|
+
}
|
|
69
|
+
|
|
23
70
|
/**
|
|
24
71
|
* Retrieve the list of AWS regions media can stream through.
|
|
25
72
|
*
|
|
@@ -181,6 +228,63 @@ class TelephonyApi {
|
|
|
181
228
|
);
|
|
182
229
|
}
|
|
183
230
|
|
|
231
|
+
/**
|
|
232
|
+
* Updates an agent's greetings.
|
|
233
|
+
*
|
|
234
|
+
* @param {String} agentId User ID
|
|
235
|
+
* @param {Object} body Agent Greeting
|
|
236
|
+
* putTelephonyAgentGreetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
237
|
+
*/
|
|
238
|
+
putTelephonyAgentGreetings(agentId, body) {
|
|
239
|
+
// verify the required parameter 'agentId' is set
|
|
240
|
+
if (agentId === undefined || agentId === null || agentId === '') {
|
|
241
|
+
throw 'Missing the required parameter "agentId" when calling putTelephonyAgentGreetings';
|
|
242
|
+
}
|
|
243
|
+
// verify the required parameter 'body' is set
|
|
244
|
+
if (body === undefined || body === null) {
|
|
245
|
+
throw 'Missing the required parameter "body" when calling putTelephonyAgentGreetings';
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
return this.apiClient.callApi(
|
|
249
|
+
'/api/v2/telephony/agents/{agentId}/greetings',
|
|
250
|
+
'PUT',
|
|
251
|
+
{ 'agentId': agentId },
|
|
252
|
+
{ },
|
|
253
|
+
{ },
|
|
254
|
+
{ },
|
|
255
|
+
body,
|
|
256
|
+
['PureCloud OAuth'],
|
|
257
|
+
['application/json'],
|
|
258
|
+
['application/json']
|
|
259
|
+
);
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
/**
|
|
263
|
+
* Updates the agent's own greetings.
|
|
264
|
+
*
|
|
265
|
+
* @param {Object} body Agent Greeting
|
|
266
|
+
* putTelephonyAgentsGreetingsMe is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
267
|
+
*/
|
|
268
|
+
putTelephonyAgentsGreetingsMe(body) {
|
|
269
|
+
// verify the required parameter 'body' is set
|
|
270
|
+
if (body === undefined || body === null) {
|
|
271
|
+
throw 'Missing the required parameter "body" when calling putTelephonyAgentsGreetingsMe';
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
return this.apiClient.callApi(
|
|
275
|
+
'/api/v2/telephony/agents/greetings/me',
|
|
276
|
+
'PUT',
|
|
277
|
+
{ },
|
|
278
|
+
{ },
|
|
279
|
+
{ },
|
|
280
|
+
{ },
|
|
281
|
+
body,
|
|
282
|
+
['PureCloud OAuth'],
|
|
283
|
+
['application/json'],
|
|
284
|
+
['application/json']
|
|
285
|
+
);
|
|
286
|
+
}
|
|
287
|
+
|
|
184
288
|
}
|
|
185
289
|
|
|
186
290
|
|
|
@@ -5,7 +5,7 @@ class UsageApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Usage service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 229.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -79,6 +79,71 @@ class UsageApi {
|
|
|
79
79
|
);
|
|
80
80
|
}
|
|
81
81
|
|
|
82
|
+
/**
|
|
83
|
+
* Get the status and results of the usage query
|
|
84
|
+
*
|
|
85
|
+
* @param {String} jobId jobId
|
|
86
|
+
* @param {Object} opts Optional parameters
|
|
87
|
+
* @param {Number} opts.pageSize Page size of the results. Max is 1000. (default to 100)
|
|
88
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
89
|
+
*/
|
|
90
|
+
getUsageAggregatesQueryJob(jobId, opts) {
|
|
91
|
+
opts = opts || {};
|
|
92
|
+
|
|
93
|
+
// verify the required parameter 'jobId' is set
|
|
94
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
95
|
+
throw 'Missing the required parameter "jobId" when calling getUsageAggregatesQueryJob';
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
return this.apiClient.callApi(
|
|
99
|
+
'/api/v2/usage/aggregates/query/jobs/{jobId}',
|
|
100
|
+
'GET',
|
|
101
|
+
{ 'jobId': jobId },
|
|
102
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
103
|
+
{ },
|
|
104
|
+
{ },
|
|
105
|
+
null,
|
|
106
|
+
['PureCloud OAuth'],
|
|
107
|
+
['application/json'],
|
|
108
|
+
['application/json']
|
|
109
|
+
);
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* Get the status and results of the usage query
|
|
114
|
+
*
|
|
115
|
+
* @param {String} clientId clientId
|
|
116
|
+
* @param {String} jobId jobId
|
|
117
|
+
* @param {Object} opts Optional parameters
|
|
118
|
+
* @param {Number} opts.pageSize Page size of the results. Max is 1000. (default to 100)
|
|
119
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
120
|
+
*/
|
|
121
|
+
getUsageClientClientIdAggregatesQueryJob(clientId, jobId, opts) {
|
|
122
|
+
opts = opts || {};
|
|
123
|
+
|
|
124
|
+
// verify the required parameter 'clientId' is set
|
|
125
|
+
if (clientId === undefined || clientId === null || clientId === '') {
|
|
126
|
+
throw 'Missing the required parameter "clientId" when calling getUsageClientClientIdAggregatesQueryJob';
|
|
127
|
+
}
|
|
128
|
+
// verify the required parameter 'jobId' is set
|
|
129
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
130
|
+
throw 'Missing the required parameter "jobId" when calling getUsageClientClientIdAggregatesQueryJob';
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
return this.apiClient.callApi(
|
|
134
|
+
'/api/v2/usage/client/{clientId}/aggregates/query/jobs/{jobId}',
|
|
135
|
+
'GET',
|
|
136
|
+
{ 'clientId': clientId,'jobId': jobId },
|
|
137
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
138
|
+
{ },
|
|
139
|
+
{ },
|
|
140
|
+
null,
|
|
141
|
+
['PureCloud OAuth'],
|
|
142
|
+
['application/json'],
|
|
143
|
+
['application/json']
|
|
144
|
+
);
|
|
145
|
+
}
|
|
146
|
+
|
|
82
147
|
/**
|
|
83
148
|
* Get the results of a usage query
|
|
84
149
|
*
|
|
@@ -164,6 +229,61 @@ class UsageApi {
|
|
|
164
229
|
);
|
|
165
230
|
}
|
|
166
231
|
|
|
232
|
+
/**
|
|
233
|
+
* Query your organization's public api usage.
|
|
234
|
+
* After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
|
|
235
|
+
* @param {Object} body Query
|
|
236
|
+
*/
|
|
237
|
+
postUsageAggregatesQueryJobs(body) {
|
|
238
|
+
// verify the required parameter 'body' is set
|
|
239
|
+
if (body === undefined || body === null) {
|
|
240
|
+
throw 'Missing the required parameter "body" when calling postUsageAggregatesQueryJobs';
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
return this.apiClient.callApi(
|
|
244
|
+
'/api/v2/usage/aggregates/query/jobs',
|
|
245
|
+
'POST',
|
|
246
|
+
{ },
|
|
247
|
+
{ },
|
|
248
|
+
{ },
|
|
249
|
+
{ },
|
|
250
|
+
body,
|
|
251
|
+
['PureCloud OAuth'],
|
|
252
|
+
['application/json'],
|
|
253
|
+
['application/json']
|
|
254
|
+
);
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* Query your client's public api usage.
|
|
259
|
+
* After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
|
|
260
|
+
* @param {String} clientId clientId
|
|
261
|
+
* @param {Object} body Query
|
|
262
|
+
*/
|
|
263
|
+
postUsageClientClientIdAggregatesQueryJobs(clientId, body) {
|
|
264
|
+
// verify the required parameter 'clientId' is set
|
|
265
|
+
if (clientId === undefined || clientId === null || clientId === '') {
|
|
266
|
+
throw 'Missing the required parameter "clientId" when calling postUsageClientClientIdAggregatesQueryJobs';
|
|
267
|
+
}
|
|
268
|
+
// verify the required parameter 'body' is set
|
|
269
|
+
if (body === undefined || body === null) {
|
|
270
|
+
throw 'Missing the required parameter "body" when calling postUsageClientClientIdAggregatesQueryJobs';
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
return this.apiClient.callApi(
|
|
274
|
+
'/api/v2/usage/client/{clientId}/aggregates/query/jobs',
|
|
275
|
+
'POST',
|
|
276
|
+
{ 'clientId': clientId },
|
|
277
|
+
{ },
|
|
278
|
+
{ },
|
|
279
|
+
{ },
|
|
280
|
+
body,
|
|
281
|
+
['PureCloud OAuth'],
|
|
282
|
+
['application/json'],
|
|
283
|
+
['application/json']
|
|
284
|
+
);
|
|
285
|
+
}
|
|
286
|
+
|
|
167
287
|
/**
|
|
168
288
|
* Query organization API Usage -
|
|
169
289
|
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
@@ -5,7 +5,7 @@ class UsersApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Users service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 229.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,32 @@ class UsersApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Delete/cancel an async request for user aggregates
|
|
25
|
+
*
|
|
26
|
+
* @param {String} jobId jobId
|
|
27
|
+
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
|
+
*/
|
|
29
|
+
deleteAnalyticsUsersAggregatesJob(jobId) {
|
|
30
|
+
// verify the required parameter 'jobId' is set
|
|
31
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
32
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return this.apiClient.callApi(
|
|
36
|
+
'/api/v2/analytics/users/aggregates/jobs/{jobId}',
|
|
37
|
+
'DELETE',
|
|
38
|
+
{ 'jobId': jobId },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
{ },
|
|
42
|
+
null,
|
|
43
|
+
['PureCloud OAuth'],
|
|
44
|
+
['application/json'],
|
|
45
|
+
['application/json']
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
|
|
23
49
|
/**
|
|
24
50
|
* Delete/cancel an async request
|
|
25
51
|
*
|