Skip to content

Commit 494822c

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent 0429c91 commit 494822c

Some content is hidden

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

83 files changed

+753
-155
lines changed

‎.lastupdated

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2025-01-27T16:31:43
1+
2025-02-04T07:52:27

‎docs/AgentAssistantsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -675,4 +675,4 @@ apiInstance.putAssistantQueue(assistantId, queueId, body)
675675
**AssistantQueue**
676676

677677

678-
_purecloud-platform-client-v2@213.1.0_
678+
_purecloud-platform-client-v2@214.0.0_

‎docs/AgentCopilotApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,4 @@ apiInstance.putAssistantCopilot(assistantId, body)
113113
**Copilot**
114114

115115

116-
_purecloud-platform-client-v2@213.1.0_
116+
_purecloud-platform-client-v2@214.0.0_

‎docs/AgentUIApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,4 +217,4 @@ apiInstance.putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body)
217217
**AutoAnswerSettings**
218218

219219

220-
_purecloud-platform-client-v2@213.1.0_
220+
_purecloud-platform-client-v2@214.0.0_

‎docs/AlertingApi.md

Lines changed: 100 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.mypurecloud.com*
77
| Method | HTTP request | Description |
88
| ------------- | ------------- | ------------- |
99
[**deleteAlertingAlert**](AlertingApi#deleteAlertingAlert) | **DELETE** /api/v2/alerting/alerts/{alertId} | Delete an alert
10+
[**deleteAlertingAlertsAll**](AlertingApi#deleteAlertingAlertsAll) | **DELETE** /api/v2/alerting/alerts/all | Delete all alerts for the user
1011
[**deleteAlertingInteractionstatsAlert**](AlertingApi#deleteAlertingInteractionstatsAlert) | **DELETE** /api/v2/alerting/interactionstats/alerts/{alertId} | Delete an interaction stats alert
1112
[**deleteAlertingInteractionstatsRule**](AlertingApi#deleteAlertingInteractionstatsRule) | **DELETE** /api/v2/alerting/interactionstats/rules/{ruleId} | Delete an interaction stats rule
1213
[**deleteAlertingRule**](AlertingApi#deleteAlertingRule) | **DELETE** /api/v2/alerting/rules/{ruleId} | Delete a rule.
@@ -19,6 +20,7 @@ All URIs are relative to *https://api.mypurecloud.com*
1920
[**getAlertingInteractionstatsRules**](AlertingApi#getAlertingInteractionstatsRules) | **GET** /api/v2/alerting/interactionstats/rules | Get an interaction stats rule list
2021
[**getAlertingRule**](AlertingApi#getAlertingRule) | **GET** /api/v2/alerting/rules/{ruleId} | Get a rule.
2122
[**patchAlertingAlert**](AlertingApi#patchAlertingAlert) | **PATCH** /api/v2/alerting/alerts/{alertId} | Allows an entity to mute/snooze an alert or update the unread status of the alert.
23+
[**patchAlertingAlertsAll**](AlertingApi#patchAlertingAlertsAll) | **PATCH** /api/v2/alerting/alerts/all | Updates all alerts
2224
[**patchAlertingAlertsBulk**](AlertingApi#patchAlertingAlertsBulk) | **PATCH** /api/v2/alerting/alerts/bulk | Bulk alert updates
2325
[**patchAlertingRulesBulk**](AlertingApi#patchAlertingRulesBulk) | **PATCH** /api/v2/alerting/rules/bulk | Bulk update of notification lists
2426
[**postAlertingAlertsQuery**](AlertingApi#postAlertingAlertsQuery) | **POST** /api/v2/alerting/alerts/query | Gets a paged list of alerts. The max page size is 50
@@ -83,6 +85,51 @@ apiInstance.deleteAlertingAlert(alertId)
8385
void (no response body)
8486

8587

88+
## deleteAlertingAlertsAll
89+
90+
> **Object** deleteAlertingAlertsAll()
91+
92+
93+
DELETE /api/v2/alerting/alerts/all
94+
95+
Delete all alerts for the user
96+
97+
Requires ALL permissions:
98+
99+
* alerting:alert:edit
100+
101+
### Example Usage
102+
103+
```{"language":"javascript"}
104+
// Browser
105+
const platformClient = require('platformClient');
106+
// Node
107+
const platformClient = require('purecloud-platform-client-v2');
108+
109+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
110+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
111+
112+
let apiInstance = new platformClient.AlertingApi();
113+
114+
apiInstance.deleteAlertingAlertsAll()
115+
.then((data) => {
116+
console.log(`deleteAlertingAlertsAll success! data: ${JSON.stringify(data, null, 2)}`);
117+
})
118+
.catch((err) => {
119+
console.log('There was a failure calling deleteAlertingAlertsAll');
120+
console.error(err);
121+
});
122+
```
123+
124+
### Parameters
125+
126+
This endpoint does not need any parameter.
127+
128+
### Return type
129+
130+
**Object**
131+
132+
86133
## deleteAlertingInteractionstatsAlert
87134

88135
> void deleteAlertingInteractionstatsAlert(alertId)
@@ -727,6 +774,58 @@ apiInstance.patchAlertingAlert(alertId, opts)
727774
**CommonAlert**
728775

729776

777+
## patchAlertingAlertsAll
778+
779+
> **Object** patchAlertingAlertsAll(opts)
780+
781+
782+
PATCH /api/v2/alerting/alerts/all
783+
784+
Updates all alerts
785+
786+
Requires ALL permissions:
787+
788+
* alerting:alert:edit
789+
790+
### Example Usage
791+
792+
```{"language":"javascript"}
793+
// Browser
794+
const platformClient = require('platformClient');
795+
// Node
796+
const platformClient = require('purecloud-platform-client-v2');
797+
798+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
799+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
800+
801+
let apiInstance = new platformClient.AlertingApi();
802+
803+
let opts = {
804+
'body': {} // Object |
805+
};
806+
807+
apiInstance.patchAlertingAlertsAll(opts)
808+
.then((data) => {
809+
console.log(`patchAlertingAlertsAll success! data: ${JSON.stringify(data, null, 2)}`);
810+
})
811+
.catch((err) => {
812+
console.log('There was a failure calling patchAlertingAlertsAll');
813+
console.error(err);
814+
});
815+
```
816+
817+
### Parameters
818+
819+
820+
| Name | Type | Description | Notes |
821+
| ------------- | ------------- | ------------- | ------------- |
822+
**body** | **Object** | | [optional] |
823+
824+
### Return type
825+
826+
**Object**
827+
828+
730829
## patchAlertingAlertsBulk
731830

732831
> BulkResponse patchAlertingAlertsBulk(body)
@@ -1318,4 +1417,4 @@ apiInstance.putAlertingRule(ruleId, body)
13181417
**CommonRule**
13191418

13201419

1321-
_purecloud-platform-client-v2@213.1.0_
1420+
_purecloud-platform-client-v2@214.0.0_

‎docs/AnalyticsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5656,4 +5656,4 @@ apiInstance.putAnalyticsDataretentionSettings(body)
56565656
**AnalyticsDataRetentionResponse**
56575657

56585658

5659-
_purecloud-platform-client-v2@213.1.0_
5659+
_purecloud-platform-client-v2@214.0.0_

‎docs/ArchitectApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8022,4 +8022,4 @@ apiInstance.putFlowsOutcome(flowOutcomeId, opts)
80228022
**Operation**
80238023

80248024

8025-
_purecloud-platform-client-v2@213.1.0_
8025+
_purecloud-platform-client-v2@214.0.0_

‎docs/AuditApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,4 +378,4 @@ apiInstance.postAuditsQueryRealtimeRelated(body, opts)
378378
**AuditRealtimeRelatedResultsResponse**
379379

380380

381-
_purecloud-platform-client-v2@213.1.0_
381+
_purecloud-platform-client-v2@214.0.0_

‎docs/AuthorizationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2428,4 +2428,4 @@ apiInstance.putUserRoles(subjectId, body)
24282428
**UserAuthorization**
24292429

24302430

2431-
_purecloud-platform-client-v2@213.1.0_
2431+
_purecloud-platform-client-v2@214.0.0_

‎docs/BillingApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,4 @@ apiInstance.getBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId, opts)
122122
**TrusteeBillingOverview**
123123

124124

125-
_purecloud-platform-client-v2@213.1.0_
125+
_purecloud-platform-client-v2@214.0.0_

‎docs/CarrierServicesApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,4 @@ apiInstance.postCarrierservicesIntegrationsEmergencylocationsMe(opts)
109109
**EmergencyLocation**
110110

111111

112-
_purecloud-platform-client-v2@213.1.0_
112+
_purecloud-platform-client-v2@214.0.0_

‎docs/ChatApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1731,4 +1731,4 @@ apiInstance.putChatsSettings(body)
17311731
**ChatSettings**
17321732

17331733

1734-
_purecloud-platform-client-v2@213.1.0_
1734+
_purecloud-platform-client-v2@214.0.0_

‎docs/CoachingApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1086,4 +1086,4 @@ apiInstance.postCoachingScheduleslotsQuery(body)
10861086
**CoachingSlotsResponse**
10871087

10881088

1089-
_purecloud-platform-client-v2@213.1.0_
1089+
_purecloud-platform-client-v2@214.0.0_

‎docs/ContentManagementApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1956,4 +1956,4 @@ apiInstance.putContentmanagementWorkspaceTagvalue(workspaceId, tagId, body)
19561956
**TagValue**
19571957

19581958

1959-
_purecloud-platform-client-v2@213.1.0_
1959+
_purecloud-platform-client-v2@214.0.0_

‎docs/ConversationsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12871,4 +12871,4 @@ apiInstance.putConversationsVideoRecordingstate(conversationId, body)
1287112871
**'String'**
1287212872

1287312873

12874-
_purecloud-platform-client-v2@213.1.0_
12874+
_purecloud-platform-client-v2@214.0.0_

‎docs/DataExtensionsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,4 +152,4 @@ This endpoint does not need any parameter.
152152
**SchemaQuantityLimits**
153153

154154

155-
_purecloud-platform-client-v2@213.1.0_
155+
_purecloud-platform-client-v2@214.0.0_

‎docs/DataPrivacyApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,4 +314,4 @@ apiInstance.postDataprivacyMaskingrulesValidate(body)
314314
**MaskingRuleValidateResponse**
315315

316316

317-
_purecloud-platform-client-v2@213.1.0_
317+
_purecloud-platform-client-v2@214.0.0_

‎docs/DownloadsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ apiInstance.getDownload(downloadId, opts)
6868
**UrlResponse**
6969

7070

71-
_purecloud-platform-client-v2@213.1.0_
71+
_purecloud-platform-client-v2@214.0.0_

‎docs/EmailsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,4 @@ apiInstance.patchEmailsSettings(opts)
108108
**EmailSettings**
109109

110110

111-
_purecloud-platform-client-v2@213.1.0_
111+
_purecloud-platform-client-v2@214.0.0_

‎docs/EmployeeEngagementApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,4 +270,4 @@ apiInstance.postEmployeeengagementRecognitions(body)
270270
**RecognitionBase**
271271

272272

273-
_purecloud-platform-client-v2@213.1.0_
273+
_purecloud-platform-client-v2@214.0.0_

‎docs/EventsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,4 +162,4 @@ apiInstance.postEventsUsersRoutingstatus(body)
162162
**BatchEventResponse**
163163

164164

165-
_purecloud-platform-client-v2@213.1.0_
165+
_purecloud-platform-client-v2@214.0.0_

‎docs/ExternalContactsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5048,4 +5048,4 @@ apiInstance.putExternalcontactsRelationship(relationshipId, body)
50485048
**Relationship**
50495049

50505050

5051-
_purecloud-platform-client-v2@213.1.0_
5051+
_purecloud-platform-client-v2@214.0.0_

‎docs/FaxApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,4 +401,4 @@ apiInstance.putFaxSettings(opts)
401401
**FaxConfig**
402402

403403

404-
_purecloud-platform-client-v2@213.1.0_
404+
_purecloud-platform-client-v2@214.0.0_

‎docs/FlowsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,4 +331,4 @@ apiInstance.postAnalyticsFlowsObservationsQuery(body)
331331
**FlowObservationQueryResponse**
332332

333333

334-
_purecloud-platform-client-v2@213.1.0_
334+
_purecloud-platform-client-v2@214.0.0_

‎docs/GamificationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3565,4 +3565,4 @@ apiInstance.putGamificationStatus(status)
35653565
**GamificationStatus**
35663566

35673567

3568-
_purecloud-platform-client-v2@213.1.0_
3568+
_purecloud-platform-client-v2@214.0.0_

‎docs/GeneralDataProtectionRegulationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,4 +223,4 @@ apiInstance.postGdprRequests(body, opts)
223223
**GDPRRequest**
224224

225225

226-
_purecloud-platform-client-v2@213.1.0_
226+
_purecloud-platform-client-v2@214.0.0_

‎docs/GeolocationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,4 +210,4 @@ apiInstance.patchUserGeolocation(userId, clientId, body)
210210
**Geolocation**
211211

212212

213-
_purecloud-platform-client-v2@213.1.0_
213+
_purecloud-platform-client-v2@214.0.0_

‎docs/GreetingsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -818,4 +818,4 @@ apiInstance.putUserGreetingsDefaults(userId, body)
818818
**DefaultGreetingList**
819819

820820

821-
_purecloud-platform-client-v2@213.1.0_
821+
_purecloud-platform-client-v2@214.0.0_

‎docs/GroupsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -977,4 +977,4 @@ apiInstance.putGroupDynamicsettings(groupId, body)
977977
void (no response body)
978978

979979

980-
_purecloud-platform-client-v2@213.1.0_
980+
_purecloud-platform-client-v2@214.0.0_

‎docs/IdentityProviderApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1845,4 +1845,4 @@ apiInstance.putIdentityprovidersSalesforce(body)
18451845
**IdentityProvider**
18461846

18471847

1848-
_purecloud-platform-client-v2@213.1.0_
1848+
_purecloud-platform-client-v2@214.0.0_

‎docs/InfrastructureAsCodeApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,4 +316,4 @@ apiInstance.postInfrastructureascodeJobs(body)
316316
**InfrastructureascodeJob**
317317

318318

319-
_purecloud-platform-client-v2@213.1.0_
319+
_purecloud-platform-client-v2@214.0.0_

‎docs/IntegrationsApi.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -593,8 +593,6 @@ GET /api/v2/integrations/actions/{actionId}/draft/function
593593

594594
Get draft function settings for Action
595595

596-
getIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
597-
598596
Requires ANY permissions:
599597

600598
* integrations:actionFunction:view
@@ -805,8 +803,6 @@ GET /api/v2/integrations/actions/{actionId}/function
805803

806804
Get published function settings for Action
807805

808-
getIntegrationsActionFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
809-
810806
Requires ANY permissions:
811807

812808
* integrations:actionFunction:view
@@ -1277,8 +1273,6 @@ GET /api/v2/integrations/actions/functions/runtimes
12771273

12781274
Get action function settings for Action
12791275

1280-
getIntegrationsActionsFunctionsRuntimes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1281-
12821276
Requires ANY permissions:
12831277

12841278
* integrations:actionFunction:view
@@ -3785,8 +3779,6 @@ POST /api/v2/integrations/actions/{actionId}/draft/function/upload
37853779

37863780
Create upload presigned URL for draft function package file.
37873781

3788-
postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3789-
37903782
Requires ANY permissions:
37913783

37923784
* integrations:actionFunction:edit
@@ -4435,8 +4427,6 @@ PUT /api/v2/integrations/actions/{actionId}/draft/function
44354427

44364428
Update draft function settings.
44374429

4438-
putIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4439-
44404430
Requires ANY permissions:
44414431

44424432
* integrations:actionFunction:edit
@@ -4742,4 +4732,4 @@ apiInstance.putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegration
47424732
**'String'**
47434733

47444734

4745-
_purecloud-platform-client-v2@213.1.0_
4735+
_purecloud-platform-client-v2@214.0.0_

‎docs/JourneyApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3786,4 +3786,4 @@ apiInstance.putJourneyViewVersion(viewId, versionId, body)
37863786
**JourneyView**
37873787

37883788

3789-
_purecloud-platform-client-v2@213.1.0_
3789+
_purecloud-platform-client-v2@214.0.0_

‎docs/KnowledgeApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6537,4 +6537,4 @@ apiInstance.putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,
65376537
**ServiceNowSourceResponse**
65386538

65396539

6540-
_purecloud-platform-client-v2@213.1.0_
6540+
_purecloud-platform-client-v2@214.0.0_

‎docs/LanguageUnderstandingApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1878,4 +1878,4 @@ apiInstance.putLanguageunderstandingDomainVersion(domainId, domainVersionId, bod
18781878
**NluDomainVersion**
18791879

18801880

1881-
_purecloud-platform-client-v2@213.1.0_
1881+
_purecloud-platform-client-v2@214.0.0_

‎docs/LanguagesApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,4 +432,4 @@ apiInstance.postLanguages(body)
432432
**Language**
433433

434434

435-
_purecloud-platform-client-v2@213.1.0_
435+
_purecloud-platform-client-v2@214.0.0_

‎docs/LearningApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1981,4 +1981,4 @@ apiInstance.putLearningModuleRule(moduleId, body)
19811981
**LearningModuleRule**
19821982

19831983

1984-
_purecloud-platform-client-v2@213.1.0_
1984+
_purecloud-platform-client-v2@214.0.0_

‎docs/LicenseApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -471,4 +471,4 @@ apiInstance.postLicenseUsers(opts)
471471
**{'String': Object}**
472472

473473

474-
_purecloud-platform-client-v2@213.1.0_
474+
_purecloud-platform-client-v2@214.0.0_

0 commit comments

Comments
 (0)