Skip to content

Commit 6c46e37

Browse files
author
InIn Devops
committed
8.0.0
1 parent 96b6350 commit 6c46e37

85 files changed

Lines changed: 4801 additions & 1633 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ npm install purecloud-platform-client-v2
2525
Reference from the CDN:
2626

2727
~~~ html
28-
<!-- Replace `7.0.0` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/7.0.0/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `8.0.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/8.0.0/purecloud-platform-client-v2.min.js"></script>
3030
~~~
3131

3232
View the documentation on the [PureCloud Developer Center](https://developer.mypurecloud.com/api/rest/client-libraries/javascript/).

‎build/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ npm install purecloud-platform-client-v2
2525
Reference from the CDN:
2626

2727
~~~ html
28-
<!-- Replace `7.0.0` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/7.0.0/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `8.0.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/8.0.0/purecloud-platform-client-v2.min.js"></script>
3030
~~~
3131

3232
View the documentation on the [PureCloud Developer Center](https://developer.mypurecloud.com/api/rest/client-libraries/javascript/).

‎build/docs/AlertingApi.md‎

Lines changed: 49 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.mypurecloud.com*
99
| ------------- | ------------- | ------------- |
1010
[**deleteAlertingInteractionstatsAlert**](AlertingApi.html#deleteAlertingInteractionstatsAlert) | **DELETE** /api/v2/alerting/interactionstats/alerts/{alertId} | Delete an interaction stats alert
1111
[**deleteAlertingInteractionstatsRule**](AlertingApi.html#deleteAlertingInteractionstatsRule) | **DELETE** /api/v2/alerting/interactionstats/rules/{ruleId} | Delete an interaction stats rule.
12+
[**getAlertingAlertsActive**](AlertingApi.html#getAlertingAlertsActive) | **GET** /api/v2/alerting/alerts/active | Gets active alert count for a user.
1213
[**getAlertingInteractionstatsAlert**](AlertingApi.html#getAlertingInteractionstatsAlert) | **GET** /api/v2/alerting/interactionstats/alerts/{alertId} | Get an interaction stats alert
1314
[**getAlertingInteractionstatsAlerts**](AlertingApi.html#getAlertingInteractionstatsAlerts) | **GET** /api/v2/alerting/interactionstats/alerts | Get interaction stats alert list.
1415
[**getAlertingInteractionstatsAlertsUnread**](AlertingApi.html#getAlertingInteractionstatsAlertsUnread) | **GET** /api/v2/alerting/interactionstats/alerts/unread | Gets user unread count of interaction stats alerts.
@@ -115,6 +116,48 @@ apiInstance.deleteAlertingInteractionstatsRule(ruleId)
115116

116117
void (no response body)
117118

119+
<a name="getAlertingAlertsActive"></a>
120+
121+
# [**ActiveAlertCount**](ActiveAlertCount.html) getAlertingAlertsActive()
122+
123+
GET /api/v2/alerting/alerts/active
124+
125+
Gets active alert count for a user.
126+
127+
128+
129+
### Example
130+
131+
~~~ javascript
132+
// Browser
133+
const platformClient = require('platformClient');
134+
// Node
135+
const platformClient = require('purecloud-platform-client-v2');
136+
137+
// Configure OAuth2 access token for authorization: PureCloud Auth
138+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
139+
140+
var apiInstance = new platformClient.AlertingApi();
141+
apiInstance.getAlertingAlertsActive()
142+
.then(function(data) {
143+
console.log(`getAlertingAlertsActive success! data: ${JSON.stringify(data, null, 2)}`);
144+
})
145+
.catch(function(error) {
146+
console.log('There was a failure calling getAlertingAlertsActive');
147+
console.error(error);
148+
});
149+
150+
~~~
151+
152+
### Parameters
153+
154+
This endpoint does not need any parameter.
155+
{: class="table table-striped"}
156+
157+
### Return type
158+
159+
**ActiveAlertCount**
160+
118161
<a name="getAlertingInteractionstatsAlert"></a>
119162

120163
# [**InteractionStatsAlert**](InteractionStatsAlert.html) getAlertingInteractionstatsAlert(alertId, opts)
@@ -382,7 +425,7 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
382425

383426
var apiInstance = new platformClient.AlertingApi();
384427

385-
var body = new platformClient.InteractionStatsRule(); // InteractionStatsRule | AlertingRule
428+
var body = {}; // Object | AlertingRule
386429

387430
var opts = {
388431
'expand': ["expand_example"] // [String] | Which fields, if any, to expand
@@ -403,7 +446,7 @@ apiInstance.postAlertingInteractionstatsRules(body, opts)
403446

404447
| Name | Type | Description | Notes |
405448
| ------------- | ------------- | ------------- | ------------- |
406-
**body** | **InteractionStatsRule** | AlertingRule | |
449+
**body** | **Object** | AlertingRule | |
407450
**expand** | **[String]** | Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
408451
{: class="table table-striped"}
409452

@@ -436,7 +479,7 @@ var apiInstance = new platformClient.AlertingApi();
436479

437480
var alertId = "alertId_example"; // String | Alert ID
438481

439-
var body = new platformClient.UnreadStatus(); // UnreadStatus | InteractionStatsAlert
482+
var body = {}; // Object | InteractionStatsAlert
440483

441484
var opts = {
442485
'expand': ["expand_example"] // [String] | Which fields, if any, to expand
@@ -458,7 +501,7 @@ apiInstance.putAlertingInteractionstatsAlert(alertId, body, opts)
458501
| Name | Type | Description | Notes |
459502
| ------------- | ------------- | ------------- | ------------- |
460503
**alertId** | **String** | Alert ID | |
461-
**body** | **UnreadStatus** | InteractionStatsAlert | |
504+
**body** | **Object** | InteractionStatsAlert | |
462505
**expand** | **[String]** | Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
463506
{: class="table table-striped"}
464507

@@ -491,7 +534,7 @@ var apiInstance = new platformClient.AlertingApi();
491534

492535
var ruleId = "ruleId_example"; // String | Rule ID
493536

494-
var body = new platformClient.InteractionStatsRule(); // InteractionStatsRule | AlertingRule
537+
var body = {}; // Object | AlertingRule
495538

496539
var opts = {
497540
'expand': ["expand_example"] // [String] | Which fields, if any, to expand
@@ -513,7 +556,7 @@ apiInstance.putAlertingInteractionstatsRule(ruleId, body, opts)
513556
| Name | Type | Description | Notes |
514557
| ------------- | ------------- | ------------- | ------------- |
515558
**ruleId** | **String** | Rule ID | |
516-
**body** | **InteractionStatsRule** | AlertingRule | |
559+
**body** | **Object** | AlertingRule | |
517560
**expand** | **[String]** | Which fields, if any, to expand | [optional] <br />**Values**: notificationUsers |
518561
{: class="table table-striped"}
519562

‎build/docs/AnalyticsApi.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ var apiInstance = new platformClient.AnalyticsApi();
593593

594594
var conversationId = "conversationId_example"; // String | conversationId
595595

596-
var body = new platformClient.PropertyIndexRequest(); // PropertyIndexRequest | request
596+
var body = {}; // Object | request
597597

598598
apiInstance.postAnalyticsConversationDetailsProperties(conversationId, body)
599599
.then(function(data) {
@@ -612,7 +612,7 @@ apiInstance.postAnalyticsConversationDetailsProperties(conversationId, body)
612612
| Name | Type | Description | Notes |
613613
| ------------- | ------------- | ------------- | ------------- |
614614
**conversationId** | **String** | conversationId | |
615-
**body** | **PropertyIndexRequest** | request | |
615+
**body** | **Object** | request | |
616616
{: class="table table-striped"}
617617

618618
### Return type
@@ -642,7 +642,7 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
642642

643643
var apiInstance = new platformClient.AnalyticsApi();
644644

645-
var body = new platformClient.AggregationQuery(); // AggregationQuery | query
645+
var body = {}; // Object | query
646646

647647
apiInstance.postAnalyticsConversationsAggregatesQuery(body)
648648
.then(function(data) {
@@ -660,7 +660,7 @@ apiInstance.postAnalyticsConversationsAggregatesQuery(body)
660660

661661
| Name | Type | Description | Notes |
662662
| ------------- | ------------- | ------------- | ------------- |
663-
**body** | **AggregationQuery** | query | |
663+
**body** | **Object** | query | |
664664
{: class="table table-striped"}
665665

666666
### Return type
@@ -690,7 +690,7 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
690690

691691
var apiInstance = new platformClient.AnalyticsApi();
692692

693-
var body = new platformClient.ConversationQuery(); // ConversationQuery | query
693+
var body = {}; // Object | query
694694

695695
apiInstance.postAnalyticsConversationsDetailsQuery(body)
696696
.then(function(data) {
@@ -708,7 +708,7 @@ apiInstance.postAnalyticsConversationsDetailsQuery(body)
708708

709709
| Name | Type | Description | Notes |
710710
| ------------- | ------------- | ------------- | ------------- |
711-
**body** | **ConversationQuery** | query | |
711+
**body** | **Object** | query | |
712712
{: class="table table-striped"}
713713

714714
### Return type
@@ -738,7 +738,7 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
738738

739739
var apiInstance = new platformClient.AnalyticsApi();
740740

741-
var body = new platformClient.AggregationQuery(); // AggregationQuery | query
741+
var body = {}; // Object | query
742742

743743
apiInstance.postAnalyticsEvaluationsAggregatesQuery(body)
744744
.then(function(data) {
@@ -756,7 +756,7 @@ apiInstance.postAnalyticsEvaluationsAggregatesQuery(body)
756756

757757
| Name | Type | Description | Notes |
758758
| ------------- | ------------- | ------------- | ------------- |
759-
**body** | **AggregationQuery** | query | |
759+
**body** | **Object** | query | |
760760
{: class="table table-striped"}
761761

762762
### Return type
@@ -786,7 +786,7 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
786786

787787
var apiInstance = new platformClient.AnalyticsApi();
788788

789-
var body = new platformClient.ObservationQuery(); // ObservationQuery | query
789+
var body = {}; // Object | query
790790

791791
apiInstance.postAnalyticsQueuesObservationsQuery(body)
792792
.then(function(data) {
@@ -804,7 +804,7 @@ apiInstance.postAnalyticsQueuesObservationsQuery(body)
804804

805805
| Name | Type | Description | Notes |
806806
| ------------- | ------------- | ------------- | ------------- |
807-
**body** | **ObservationQuery** | query | |
807+
**body** | **Object** | query | |
808808
{: class="table table-striped"}
809809

810810
### Return type
@@ -882,7 +882,7 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
882882

883883
var apiInstance = new platformClient.AnalyticsApi();
884884

885-
var body = new platformClient.ReportSchedule(); // ReportSchedule | ReportSchedule
885+
var body = {}; // Object | ReportSchedule
886886

887887
apiInstance.postAnalyticsReportingSchedules(body)
888888
.then(function(data) {
@@ -900,7 +900,7 @@ apiInstance.postAnalyticsReportingSchedules(body)
900900

901901
| Name | Type | Description | Notes |
902902
| ------------- | ------------- | ------------- | ------------- |
903-
**body** | **ReportSchedule** | ReportSchedule | |
903+
**body** | **Object** | ReportSchedule | |
904904
{: class="table table-striped"}
905905

906906
### Return type
@@ -930,7 +930,7 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
930930

931931
var apiInstance = new platformClient.AnalyticsApi();
932932

933-
var body = new platformClient.AggregationQuery(); // AggregationQuery | query
933+
var body = {}; // Object | query
934934

935935
apiInstance.postAnalyticsUsersAggregatesQuery(body)
936936
.then(function(data) {
@@ -948,7 +948,7 @@ apiInstance.postAnalyticsUsersAggregatesQuery(body)
948948

949949
| Name | Type | Description | Notes |
950950
| ------------- | ------------- | ------------- | ------------- |
951-
**body** | **AggregationQuery** | query | |
951+
**body** | **Object** | query | |
952952
{: class="table table-striped"}
953953

954954
### Return type
@@ -978,7 +978,7 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
978978

979979
var apiInstance = new platformClient.AnalyticsApi();
980980

981-
var body = new platformClient.UserDetailsQuery(); // UserDetailsQuery | query
981+
var body = {}; // Object | query
982982

983983
apiInstance.postAnalyticsUsersDetailsQuery(body)
984984
.then(function(data) {
@@ -996,7 +996,7 @@ apiInstance.postAnalyticsUsersDetailsQuery(body)
996996

997997
| Name | Type | Description | Notes |
998998
| ------------- | ------------- | ------------- | ------------- |
999-
**body** | **UserDetailsQuery** | query | |
999+
**body** | **Object** | query | |
10001000
{: class="table table-striped"}
10011001

10021002
### Return type
@@ -1026,7 +1026,7 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
10261026

10271027
var apiInstance = new platformClient.AnalyticsApi();
10281028

1029-
var body = new platformClient.ObservationQuery(); // ObservationQuery | query
1029+
var body = {}; // Object | query
10301030

10311031
apiInstance.postAnalyticsUsersObservationsQuery(body)
10321032
.then(function(data) {
@@ -1044,7 +1044,7 @@ apiInstance.postAnalyticsUsersObservationsQuery(body)
10441044

10451045
| Name | Type | Description | Notes |
10461046
| ------------- | ------------- | ------------- | ------------- |
1047-
**body** | **ObservationQuery** | query | |
1047+
**body** | **Object** | query | |
10481048
{: class="table table-striped"}
10491049

10501050
### Return type
@@ -1076,7 +1076,7 @@ var apiInstance = new platformClient.AnalyticsApi();
10761076

10771077
var scheduleId = "scheduleId_example"; // String | Schedule ID
10781078

1079-
var body = new platformClient.ReportSchedule(); // ReportSchedule | ReportSchedule
1079+
var body = {}; // Object | ReportSchedule
10801080

10811081
apiInstance.putAnalyticsReportingSchedule(scheduleId, body)
10821082
.then(function(data) {
@@ -1095,7 +1095,7 @@ apiInstance.putAnalyticsReportingSchedule(scheduleId, body)
10951095
| Name | Type | Description | Notes |
10961096
| ------------- | ------------- | ------------- | ------------- |
10971097
**scheduleId** | **String** | Schedule ID | |
1098-
**body** | **ReportSchedule** | ReportSchedule | |
1098+
**body** | **Object** | ReportSchedule | |
10991099
{: class="table table-striped"}
11001100

11011101
### Return type

0 commit comments

Comments
 (0)