purecloud-platform-client-v2 192.2.0 → 193.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +188 -467
- package/dist/web-amd/purecloud-platform-client-v2.js +188 -467
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +193 -278
- package/dist/web-cjs/purecloud-platform-client-v2.js +193 -278
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +583 -602
- 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 +40 -346
- 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/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +48 -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 -2
- 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/EmailsApi.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 -2
- 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 +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 +21 -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 +3 -3
- 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 -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/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 -38
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -2
- 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 -2
- 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 +5 -3
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 193.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -45,31 +45,6 @@ class AnalyticsApi {
|
|
|
45
45
|
);
|
|
46
46
|
}
|
|
47
47
|
|
|
48
|
-
/**
|
|
49
|
-
* Delete a scheduled report job.
|
|
50
|
-
*
|
|
51
|
-
* @param {String} scheduleId Schedule ID
|
|
52
|
-
*/
|
|
53
|
-
deleteAnalyticsReportingSchedule(scheduleId) {
|
|
54
|
-
// verify the required parameter 'scheduleId' is set
|
|
55
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
56
|
-
throw 'Missing the required parameter "scheduleId" when calling deleteAnalyticsReportingSchedule';
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
return this.apiClient.callApi(
|
|
60
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
61
|
-
'DELETE',
|
|
62
|
-
{ 'scheduleId': scheduleId },
|
|
63
|
-
{ },
|
|
64
|
-
{ },
|
|
65
|
-
{ },
|
|
66
|
-
null,
|
|
67
|
-
['PureCloud OAuth'],
|
|
68
|
-
['application/json'],
|
|
69
|
-
['application/json']
|
|
70
|
-
);
|
|
71
|
-
}
|
|
72
|
-
|
|
73
48
|
/**
|
|
74
49
|
* Delete/cancel an async request
|
|
75
50
|
*
|
|
@@ -151,9 +126,44 @@ class AnalyticsApi {
|
|
|
151
126
|
);
|
|
152
127
|
}
|
|
153
128
|
|
|
129
|
+
/**
|
|
130
|
+
* Get Reporting Turns (division aware).
|
|
131
|
+
* Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
132
|
+
* @param {String} botFlowId ID of the bot flow.
|
|
133
|
+
* @param {Object} opts Optional parameters
|
|
134
|
+
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
135
|
+
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
136
|
+
* @param {String} opts.interval Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
137
|
+
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
138
|
+
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
|
|
139
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
140
|
+
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
141
|
+
*/
|
|
142
|
+
getAnalyticsBotflowDivisionsReportingturns(botFlowId, opts) {
|
|
143
|
+
opts = opts || {};
|
|
144
|
+
|
|
145
|
+
// verify the required parameter 'botFlowId' is set
|
|
146
|
+
if (botFlowId === undefined || botFlowId === null) {
|
|
147
|
+
throw 'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowDivisionsReportingturns';
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
return this.apiClient.callApi(
|
|
151
|
+
'/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns',
|
|
152
|
+
'GET',
|
|
153
|
+
{ 'botFlowId': botFlowId },
|
|
154
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
155
|
+
{ },
|
|
156
|
+
{ },
|
|
157
|
+
null,
|
|
158
|
+
['PureCloud OAuth'],
|
|
159
|
+
['application/json'],
|
|
160
|
+
['application/json']
|
|
161
|
+
);
|
|
162
|
+
}
|
|
163
|
+
|
|
154
164
|
/**
|
|
155
165
|
* Get Reporting Turns.
|
|
156
|
-
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
166
|
+
* Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
157
167
|
* @param {String} botFlowId ID of the bot flow.
|
|
158
168
|
* @param {Object} opts Optional parameters
|
|
159
169
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -163,6 +173,7 @@ class AnalyticsApi {
|
|
|
163
173
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
|
|
164
174
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
165
175
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
176
|
+
* @deprecated
|
|
166
177
|
*/
|
|
167
178
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
168
179
|
opts = opts || {};
|
|
@@ -853,216 +864,6 @@ class AnalyticsApi {
|
|
|
853
864
|
);
|
|
854
865
|
}
|
|
855
866
|
|
|
856
|
-
/**
|
|
857
|
-
* Get list of reporting metadata.
|
|
858
|
-
*
|
|
859
|
-
* @param {Object} opts Optional parameters
|
|
860
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
861
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
862
|
-
* @param {String} opts.locale Locale
|
|
863
|
-
*/
|
|
864
|
-
getAnalyticsReportingMetadata(opts) {
|
|
865
|
-
opts = opts || {};
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
return this.apiClient.callApi(
|
|
869
|
-
'/api/v2/analytics/reporting/metadata',
|
|
870
|
-
'GET',
|
|
871
|
-
{ },
|
|
872
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'locale': opts['locale'] },
|
|
873
|
-
{ },
|
|
874
|
-
{ },
|
|
875
|
-
null,
|
|
876
|
-
['PureCloud OAuth'],
|
|
877
|
-
['application/json'],
|
|
878
|
-
['application/json']
|
|
879
|
-
);
|
|
880
|
-
}
|
|
881
|
-
|
|
882
|
-
/**
|
|
883
|
-
* Get a reporting metadata.
|
|
884
|
-
*
|
|
885
|
-
* @param {String} reportId Report ID
|
|
886
|
-
* @param {Object} opts Optional parameters
|
|
887
|
-
* @param {String} opts.locale Locale
|
|
888
|
-
*/
|
|
889
|
-
getAnalyticsReportingReportIdMetadata(reportId, opts) {
|
|
890
|
-
opts = opts || {};
|
|
891
|
-
|
|
892
|
-
// verify the required parameter 'reportId' is set
|
|
893
|
-
if (reportId === undefined || reportId === null) {
|
|
894
|
-
throw 'Missing the required parameter "reportId" when calling getAnalyticsReportingReportIdMetadata';
|
|
895
|
-
}
|
|
896
|
-
|
|
897
|
-
return this.apiClient.callApi(
|
|
898
|
-
'/api/v2/analytics/reporting/{reportId}/metadata',
|
|
899
|
-
'GET',
|
|
900
|
-
{ 'reportId': reportId },
|
|
901
|
-
{ 'locale': opts['locale'] },
|
|
902
|
-
{ },
|
|
903
|
-
{ },
|
|
904
|
-
null,
|
|
905
|
-
['PureCloud OAuth'],
|
|
906
|
-
['application/json'],
|
|
907
|
-
['application/json']
|
|
908
|
-
);
|
|
909
|
-
}
|
|
910
|
-
|
|
911
|
-
/**
|
|
912
|
-
* Get a list of report formats
|
|
913
|
-
* Get a list of report formats.
|
|
914
|
-
*/
|
|
915
|
-
getAnalyticsReportingReportformats() {
|
|
916
|
-
|
|
917
|
-
return this.apiClient.callApi(
|
|
918
|
-
'/api/v2/analytics/reporting/reportformats',
|
|
919
|
-
'GET',
|
|
920
|
-
{ },
|
|
921
|
-
{ },
|
|
922
|
-
{ },
|
|
923
|
-
{ },
|
|
924
|
-
null,
|
|
925
|
-
['PureCloud OAuth'],
|
|
926
|
-
['application/json'],
|
|
927
|
-
['application/json']
|
|
928
|
-
);
|
|
929
|
-
}
|
|
930
|
-
|
|
931
|
-
/**
|
|
932
|
-
* Get a scheduled report job.
|
|
933
|
-
*
|
|
934
|
-
* @param {String} scheduleId Schedule ID
|
|
935
|
-
*/
|
|
936
|
-
getAnalyticsReportingSchedule(scheduleId) {
|
|
937
|
-
// verify the required parameter 'scheduleId' is set
|
|
938
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
939
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingSchedule';
|
|
940
|
-
}
|
|
941
|
-
|
|
942
|
-
return this.apiClient.callApi(
|
|
943
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
944
|
-
'GET',
|
|
945
|
-
{ 'scheduleId': scheduleId },
|
|
946
|
-
{ },
|
|
947
|
-
{ },
|
|
948
|
-
{ },
|
|
949
|
-
null,
|
|
950
|
-
['PureCloud OAuth'],
|
|
951
|
-
['application/json'],
|
|
952
|
-
['application/json']
|
|
953
|
-
);
|
|
954
|
-
}
|
|
955
|
-
|
|
956
|
-
/**
|
|
957
|
-
* Get list of completed scheduled report jobs.
|
|
958
|
-
*
|
|
959
|
-
* @param {String} scheduleId Schedule ID
|
|
960
|
-
* @param {Object} opts Optional parameters
|
|
961
|
-
* @param {Number} opts.pageNumber (default to 1)
|
|
962
|
-
* @param {Number} opts.pageSize (default to 25)
|
|
963
|
-
*/
|
|
964
|
-
getAnalyticsReportingScheduleHistory(scheduleId, opts) {
|
|
965
|
-
opts = opts || {};
|
|
966
|
-
|
|
967
|
-
// verify the required parameter 'scheduleId' is set
|
|
968
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
969
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistory';
|
|
970
|
-
}
|
|
971
|
-
|
|
972
|
-
return this.apiClient.callApi(
|
|
973
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history',
|
|
974
|
-
'GET',
|
|
975
|
-
{ 'scheduleId': scheduleId },
|
|
976
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
977
|
-
{ },
|
|
978
|
-
{ },
|
|
979
|
-
null,
|
|
980
|
-
['PureCloud OAuth'],
|
|
981
|
-
['application/json'],
|
|
982
|
-
['application/json']
|
|
983
|
-
);
|
|
984
|
-
}
|
|
985
|
-
|
|
986
|
-
/**
|
|
987
|
-
* Get most recently completed scheduled report job.
|
|
988
|
-
*
|
|
989
|
-
* @param {String} scheduleId Schedule ID
|
|
990
|
-
*/
|
|
991
|
-
getAnalyticsReportingScheduleHistoryLatest(scheduleId) {
|
|
992
|
-
// verify the required parameter 'scheduleId' is set
|
|
993
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
994
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryLatest';
|
|
995
|
-
}
|
|
996
|
-
|
|
997
|
-
return this.apiClient.callApi(
|
|
998
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest',
|
|
999
|
-
'GET',
|
|
1000
|
-
{ 'scheduleId': scheduleId },
|
|
1001
|
-
{ },
|
|
1002
|
-
{ },
|
|
1003
|
-
{ },
|
|
1004
|
-
null,
|
|
1005
|
-
['PureCloud OAuth'],
|
|
1006
|
-
['application/json'],
|
|
1007
|
-
['application/json']
|
|
1008
|
-
);
|
|
1009
|
-
}
|
|
1010
|
-
|
|
1011
|
-
/**
|
|
1012
|
-
* A completed scheduled report job
|
|
1013
|
-
* A completed scheduled report job.
|
|
1014
|
-
* @param {String} runId Run ID
|
|
1015
|
-
* @param {String} scheduleId Schedule ID
|
|
1016
|
-
*/
|
|
1017
|
-
getAnalyticsReportingScheduleHistoryRunId(runId, scheduleId) {
|
|
1018
|
-
// verify the required parameter 'runId' is set
|
|
1019
|
-
if (runId === undefined || runId === null) {
|
|
1020
|
-
throw 'Missing the required parameter "runId" when calling getAnalyticsReportingScheduleHistoryRunId';
|
|
1021
|
-
}
|
|
1022
|
-
// verify the required parameter 'scheduleId' is set
|
|
1023
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
1024
|
-
throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryRunId';
|
|
1025
|
-
}
|
|
1026
|
-
|
|
1027
|
-
return this.apiClient.callApi(
|
|
1028
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}',
|
|
1029
|
-
'GET',
|
|
1030
|
-
{ 'runId': runId,'scheduleId': scheduleId },
|
|
1031
|
-
{ },
|
|
1032
|
-
{ },
|
|
1033
|
-
{ },
|
|
1034
|
-
null,
|
|
1035
|
-
['PureCloud OAuth'],
|
|
1036
|
-
['application/json'],
|
|
1037
|
-
['application/json']
|
|
1038
|
-
);
|
|
1039
|
-
}
|
|
1040
|
-
|
|
1041
|
-
/**
|
|
1042
|
-
* Get a list of scheduled report jobs
|
|
1043
|
-
* Get a list of scheduled report jobs.
|
|
1044
|
-
* @param {Object} opts Optional parameters
|
|
1045
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1046
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1047
|
-
*/
|
|
1048
|
-
getAnalyticsReportingSchedules(opts) {
|
|
1049
|
-
opts = opts || {};
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
return this.apiClient.callApi(
|
|
1053
|
-
'/api/v2/analytics/reporting/schedules',
|
|
1054
|
-
'GET',
|
|
1055
|
-
{ },
|
|
1056
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
1057
|
-
{ },
|
|
1058
|
-
{ },
|
|
1059
|
-
null,
|
|
1060
|
-
['PureCloud OAuth'],
|
|
1061
|
-
['application/json'],
|
|
1062
|
-
['application/json']
|
|
1063
|
-
);
|
|
1064
|
-
}
|
|
1065
|
-
|
|
1066
867
|
/**
|
|
1067
868
|
* Get AnalyticsReportingSettings for an organization
|
|
1068
869
|
*
|
|
@@ -1093,6 +894,7 @@ class AnalyticsApi {
|
|
|
1093
894
|
* @param {Number} opts.pageSize (default to 50)
|
|
1094
895
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
1095
896
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
897
|
+
* @param {String} opts.name retrieve dashboards that match with given name
|
|
1096
898
|
*/
|
|
1097
899
|
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
1098
900
|
opts = opts || {};
|
|
@@ -1106,27 +908,7 @@ class AnalyticsApi {
|
|
|
1106
908
|
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
1107
909
|
'GET',
|
|
1108
910
|
{ 'userId': userId },
|
|
1109
|
-
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
|
|
1110
|
-
{ },
|
|
1111
|
-
{ },
|
|
1112
|
-
null,
|
|
1113
|
-
['PureCloud OAuth'],
|
|
1114
|
-
['application/json'],
|
|
1115
|
-
['application/json']
|
|
1116
|
-
);
|
|
1117
|
-
}
|
|
1118
|
-
|
|
1119
|
-
/**
|
|
1120
|
-
* Get a list of report time periods.
|
|
1121
|
-
*
|
|
1122
|
-
*/
|
|
1123
|
-
getAnalyticsReportingTimeperiods() {
|
|
1124
|
-
|
|
1125
|
-
return this.apiClient.callApi(
|
|
1126
|
-
'/api/v2/analytics/reporting/timeperiods',
|
|
1127
|
-
'GET',
|
|
1128
|
-
{ },
|
|
1129
|
-
{ },
|
|
911
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
|
|
1130
912
|
{ },
|
|
1131
913
|
{ },
|
|
1132
914
|
null,
|
|
@@ -1655,7 +1437,6 @@ class AnalyticsApi {
|
|
|
1655
1437
|
* @param {Object} opts Optional parameters
|
|
1656
1438
|
* @param {Number} opts.pageSize The desired page size
|
|
1657
1439
|
* @param {Number} opts.pageNumber The desired page number
|
|
1658
|
-
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1659
1440
|
*/
|
|
1660
1441
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
1661
1442
|
opts = opts || {};
|
|
@@ -1914,7 +1695,6 @@ class AnalyticsApi {
|
|
|
1914
1695
|
* @param {Object} opts Optional parameters
|
|
1915
1696
|
* @param {Number} opts.pageSize The desired page size
|
|
1916
1697
|
* @param {Number} opts.pageNumber The desired page number
|
|
1917
|
-
* postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1918
1698
|
*/
|
|
1919
1699
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
1920
1700
|
opts = opts || {};
|
|
@@ -2216,58 +1996,6 @@ class AnalyticsApi {
|
|
|
2216
1996
|
);
|
|
2217
1997
|
}
|
|
2218
1998
|
|
|
2219
|
-
/**
|
|
2220
|
-
* Place a scheduled report immediately into the reporting queue
|
|
2221
|
-
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports/{exportId}/execute instead
|
|
2222
|
-
* @param {String} scheduleId Schedule ID
|
|
2223
|
-
* @deprecated
|
|
2224
|
-
*/
|
|
2225
|
-
postAnalyticsReportingScheduleRunreport(scheduleId) {
|
|
2226
|
-
// verify the required parameter 'scheduleId' is set
|
|
2227
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
2228
|
-
throw 'Missing the required parameter "scheduleId" when calling postAnalyticsReportingScheduleRunreport';
|
|
2229
|
-
}
|
|
2230
|
-
|
|
2231
|
-
return this.apiClient.callApi(
|
|
2232
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}/runreport',
|
|
2233
|
-
'POST',
|
|
2234
|
-
{ 'scheduleId': scheduleId },
|
|
2235
|
-
{ },
|
|
2236
|
-
{ },
|
|
2237
|
-
{ },
|
|
2238
|
-
null,
|
|
2239
|
-
['PureCloud OAuth'],
|
|
2240
|
-
['application/json'],
|
|
2241
|
-
['application/json']
|
|
2242
|
-
);
|
|
2243
|
-
}
|
|
2244
|
-
|
|
2245
|
-
/**
|
|
2246
|
-
* Create a scheduled report job
|
|
2247
|
-
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports instead
|
|
2248
|
-
* @param {Object} body ReportSchedule
|
|
2249
|
-
* @deprecated
|
|
2250
|
-
*/
|
|
2251
|
-
postAnalyticsReportingSchedules(body) {
|
|
2252
|
-
// verify the required parameter 'body' is set
|
|
2253
|
-
if (body === undefined || body === null) {
|
|
2254
|
-
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSchedules';
|
|
2255
|
-
}
|
|
2256
|
-
|
|
2257
|
-
return this.apiClient.callApi(
|
|
2258
|
-
'/api/v2/analytics/reporting/schedules',
|
|
2259
|
-
'POST',
|
|
2260
|
-
{ },
|
|
2261
|
-
{ },
|
|
2262
|
-
{ },
|
|
2263
|
-
{ },
|
|
2264
|
-
body,
|
|
2265
|
-
['PureCloud OAuth'],
|
|
2266
|
-
['application/json'],
|
|
2267
|
-
['application/json']
|
|
2268
|
-
);
|
|
2269
|
-
}
|
|
2270
|
-
|
|
2271
1999
|
/**
|
|
2272
2000
|
* Bulk remove dashboard configurations
|
|
2273
2001
|
*
|
|
@@ -2351,7 +2079,6 @@ class AnalyticsApi {
|
|
|
2351
2079
|
* @param {Object} opts Optional parameters
|
|
2352
2080
|
* @param {Number} opts.pageSize The desired page size
|
|
2353
2081
|
* @param {Number} opts.pageNumber The desired page number
|
|
2354
|
-
* postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2355
2082
|
*/
|
|
2356
2083
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
2357
2084
|
opts = opts || {};
|
|
@@ -2485,7 +2212,6 @@ class AnalyticsApi {
|
|
|
2485
2212
|
* @param {Object} opts Optional parameters
|
|
2486
2213
|
* @param {Number} opts.pageSize The desired page size
|
|
2487
2214
|
* @param {Number} opts.pageNumber The desired page number
|
|
2488
|
-
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2489
2215
|
*/
|
|
2490
2216
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
2491
2217
|
opts = opts || {};
|
|
@@ -2567,7 +2293,6 @@ class AnalyticsApi {
|
|
|
2567
2293
|
* @param {Object} opts Optional parameters
|
|
2568
2294
|
* @param {Number} opts.pageSize The desired page size
|
|
2569
2295
|
* @param {Number} opts.pageNumber The desired page number
|
|
2570
|
-
* postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2571
2296
|
*/
|
|
2572
2297
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
2573
2298
|
opts = opts || {};
|
|
@@ -2742,37 +2467,6 @@ class AnalyticsApi {
|
|
|
2742
2467
|
);
|
|
2743
2468
|
}
|
|
2744
2469
|
|
|
2745
|
-
/**
|
|
2746
|
-
* Update a scheduled report job.
|
|
2747
|
-
* This route is deprecated, please use PATCH:api/v2/analytics/reporting/exports/{exportId}/schedule instead
|
|
2748
|
-
* @param {String} scheduleId Schedule ID
|
|
2749
|
-
* @param {Object} body ReportSchedule
|
|
2750
|
-
* @deprecated
|
|
2751
|
-
*/
|
|
2752
|
-
putAnalyticsReportingSchedule(scheduleId, body) {
|
|
2753
|
-
// verify the required parameter 'scheduleId' is set
|
|
2754
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
2755
|
-
throw 'Missing the required parameter "scheduleId" when calling putAnalyticsReportingSchedule';
|
|
2756
|
-
}
|
|
2757
|
-
// verify the required parameter 'body' is set
|
|
2758
|
-
if (body === undefined || body === null) {
|
|
2759
|
-
throw 'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';
|
|
2760
|
-
}
|
|
2761
|
-
|
|
2762
|
-
return this.apiClient.callApi(
|
|
2763
|
-
'/api/v2/analytics/reporting/schedules/{scheduleId}',
|
|
2764
|
-
'PUT',
|
|
2765
|
-
{ 'scheduleId': scheduleId },
|
|
2766
|
-
{ },
|
|
2767
|
-
{ },
|
|
2768
|
-
{ },
|
|
2769
|
-
body,
|
|
2770
|
-
['PureCloud OAuth'],
|
|
2771
|
-
['application/json'],
|
|
2772
|
-
['application/json']
|
|
2773
|
-
);
|
|
2774
|
-
}
|
|
2775
|
-
|
|
2776
2470
|
}
|
|
2777
2471
|
|
|
2778
2472
|
|
|
@@ -5,7 +5,7 @@ class ChatApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Chat service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 193.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -501,6 +501,27 @@ class ChatApi {
|
|
|
501
501
|
);
|
|
502
502
|
}
|
|
503
503
|
|
|
504
|
+
/**
|
|
505
|
+
* Get a user's chat settings
|
|
506
|
+
*
|
|
507
|
+
* getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
508
|
+
*/
|
|
509
|
+
getChatsUsersMeSettings() {
|
|
510
|
+
|
|
511
|
+
return this.apiClient.callApi(
|
|
512
|
+
'/api/v2/chats/users/me/settings',
|
|
513
|
+
'GET',
|
|
514
|
+
{ },
|
|
515
|
+
{ },
|
|
516
|
+
{ },
|
|
517
|
+
{ },
|
|
518
|
+
null,
|
|
519
|
+
['PureCloud OAuth'],
|
|
520
|
+
['application/json'],
|
|
521
|
+
['application/json']
|
|
522
|
+
);
|
|
523
|
+
}
|
|
524
|
+
|
|
504
525
|
/**
|
|
505
526
|
* Set properties for a room
|
|
506
527
|
*
|
|
@@ -657,6 +678,32 @@ class ChatApi {
|
|
|
657
678
|
);
|
|
658
679
|
}
|
|
659
680
|
|
|
681
|
+
/**
|
|
682
|
+
* Update a user's chat settings
|
|
683
|
+
*
|
|
684
|
+
* @param {Object} body
|
|
685
|
+
* patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
686
|
+
*/
|
|
687
|
+
patchChatsUsersMeSettings(body) {
|
|
688
|
+
// verify the required parameter 'body' is set
|
|
689
|
+
if (body === undefined || body === null) {
|
|
690
|
+
throw 'Missing the required parameter "body" when calling patchChatsUsersMeSettings';
|
|
691
|
+
}
|
|
692
|
+
|
|
693
|
+
return this.apiClient.callApi(
|
|
694
|
+
'/api/v2/chats/users/me/settings',
|
|
695
|
+
'PATCH',
|
|
696
|
+
{ },
|
|
697
|
+
{ },
|
|
698
|
+
{ },
|
|
699
|
+
{ },
|
|
700
|
+
body,
|
|
701
|
+
['PureCloud OAuth'],
|
|
702
|
+
['application/json'],
|
|
703
|
+
['application/json']
|
|
704
|
+
);
|
|
705
|
+
}
|
|
706
|
+
|
|
660
707
|
/**
|
|
661
708
|
* Send a message to a room
|
|
662
709
|
*
|
|
@@ -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 193.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -4299,7 +4299,6 @@ class ConversationsApi {
|
|
|
4299
4299
|
* @param {Object} opts Optional parameters
|
|
4300
4300
|
* @param {Number} opts.pageSize The desired page size
|
|
4301
4301
|
* @param {Number} opts.pageNumber The desired page number
|
|
4302
|
-
* postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4303
4302
|
*/
|
|
4304
4303
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
4305
4304
|
opts = opts || {};
|