Skip to content

Commit cca956b

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent 3d04205 commit cca956b

89 files changed

Lines changed: 6017 additions & 2756 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.

‎.lastupdated‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2026-03-25T22:16:49
1+
2026-04-03T11:21:44

‎docs/AIStudioApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1277,4 +1277,4 @@ apiInstance.putConversationsSummariesSetting(summarySettingId, body, opts)
12771277
**SummarySetting**
12781278

12791279

1280-
_purecloud-platform-client-v2@249.1.0_
1280+
_purecloud-platform-client-v2@250.0.0_

‎docs/AgentAssistantsApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1424,4 +1424,4 @@ apiInstance.putAssistantsAgentchecklist(agentChecklistId, body, opts)
14241424
**AgentChecklist**
14251425

14261426

1427-
_purecloud-platform-client-v2@249.1.0_
1427+
_purecloud-platform-client-v2@250.0.0_

‎docs/AgentCopilotApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,4 +185,4 @@ apiInstance.putAssistantCopilot(assistantId, body, opts)
185185
**Copilot**
186186

187187

188-
_purecloud-platform-client-v2@249.1.0_
188+
_purecloud-platform-client-v2@250.0.0_

‎docs/AgentUIApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,4 +245,4 @@ apiInstance.putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body, opts)
245245
**AutoAnswerSettings**
246246

247247

248-
_purecloud-platform-client-v2@249.1.0_
248+
_purecloud-platform-client-v2@250.0.0_

‎docs/AlertingApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -884,4 +884,4 @@ apiInstance.putAlertingRule(ruleId, body, opts)
884884
**CommonRule**
885885

886886

887-
_purecloud-platform-client-v2@249.1.0_
887+
_purecloud-platform-client-v2@250.0.0_

‎docs/AnalyticsApi.md‎

Lines changed: 303 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ All URIs are relative to *https://api.mypurecloud.com*
1212
[**deleteAnalyticsCasemanagementAggregatesJob**](AnalyticsApi#deleteAnalyticsCasemanagementAggregatesJob) | **DELETE** /api/v2/analytics/casemanagement/aggregates/jobs/{jobId} | Delete/cancel an async request for case management aggregates
1313
[**deleteAnalyticsConversationsAggregatesJob**](AnalyticsApi#deleteAnalyticsConversationsAggregatesJob) | **DELETE** /api/v2/analytics/conversations/aggregates/jobs/{jobId} | Delete/cancel an async request for conversation aggregates
1414
[**deleteAnalyticsConversationsDetailsJob**](AnalyticsApi#deleteAnalyticsConversationsDetailsJob) | **DELETE** /api/v2/analytics/conversations/details/jobs/{jobId} | Delete/cancel an async details job
15+
[**deleteAnalyticsCopilotsAggregatesJob**](AnalyticsApi#deleteAnalyticsCopilotsAggregatesJob) | **DELETE** /api/v2/analytics/copilots/aggregates/jobs/{jobId} | Delete/cancel an async request for copilot aggregates
1516
[**deleteAnalyticsEvaluationsAggregatesJob**](AnalyticsApi#deleteAnalyticsEvaluationsAggregatesJob) | **DELETE** /api/v2/analytics/evaluations/aggregates/jobs/{jobId} | Delete/cancel an async request for evaluation aggregates
1617
[**deleteAnalyticsFlowexecutionsAggregatesJob**](AnalyticsApi#deleteAnalyticsFlowexecutionsAggregatesJob) | **DELETE** /api/v2/analytics/flowexecutions/aggregates/jobs/{jobId} | Delete/cancel an async request for flow execution aggregates
1718
[**deleteAnalyticsFlowsAggregatesJob**](AnalyticsApi#deleteAnalyticsFlowsAggregatesJob) | **DELETE** /api/v2/analytics/flows/aggregates/jobs/{jobId} | Delete/cancel an async request for flow aggregates
@@ -43,6 +44,8 @@ All URIs are relative to *https://api.mypurecloud.com*
4344
[**getAnalyticsConversationsDetailsJob**](AnalyticsApi#getAnalyticsConversationsDetailsJob) | **GET** /api/v2/analytics/conversations/details/jobs/{jobId} | Get status for async query for conversation details
4445
[**getAnalyticsConversationsDetailsJobResults**](AnalyticsApi#getAnalyticsConversationsDetailsJobResults) | **GET** /api/v2/analytics/conversations/details/jobs/{jobId}/results | Fetch a page of results for an async details job
4546
[**getAnalyticsConversationsDetailsJobsAvailability**](AnalyticsApi#getAnalyticsConversationsDetailsJobsAvailability) | **GET** /api/v2/analytics/conversations/details/jobs/availability | Lookup the datalake availability date and time
47+
[**getAnalyticsCopilotsAggregatesJob**](AnalyticsApi#getAnalyticsCopilotsAggregatesJob) | **GET** /api/v2/analytics/copilots/aggregates/jobs/{jobId} | Get status for async query for copilot aggregates
48+
[**getAnalyticsCopilotsAggregatesJobResults**](AnalyticsApi#getAnalyticsCopilotsAggregatesJobResults) | **GET** /api/v2/analytics/copilots/aggregates/jobs/{jobId}/results | Fetch a page of results for an async aggregates query
4649
[**getAnalyticsDataextractionDownload**](AnalyticsApi#getAnalyticsDataextractionDownload) | **GET** /api/v2/analytics/dataextraction/downloads/{downloadId} | Get analytics data warehouse file download
4750
[**getAnalyticsDataextractionDownloadsMetadata**](AnalyticsApi#getAnalyticsDataextractionDownloadsMetadata) | **GET** /api/v2/analytics/dataextraction/downloads/metadata | Get metadata on files available for extraction
4851
[**getAnalyticsDataretentionSettings**](AnalyticsApi#getAnalyticsDataretentionSettings) | **GET** /api/v2/analytics/dataretention/settings | Get analytics data retention setting
@@ -95,6 +98,8 @@ All URIs are relative to *https://api.mypurecloud.com*
9598
[**postAnalyticsConversationsAggregatesQuery**](AnalyticsApi#postAnalyticsConversationsAggregatesQuery) | **POST** /api/v2/analytics/conversations/aggregates/query | Query for conversation aggregates
9699
[**postAnalyticsConversationsDetailsJobs**](AnalyticsApi#postAnalyticsConversationsDetailsJobs) | **POST** /api/v2/analytics/conversations/details/jobs | Query for conversation details asynchronously
97100
[**postAnalyticsConversationsDetailsQuery**](AnalyticsApi#postAnalyticsConversationsDetailsQuery) | **POST** /api/v2/analytics/conversations/details/query | Query for conversation details
101+
[**postAnalyticsCopilotsAggregatesJobs**](AnalyticsApi#postAnalyticsCopilotsAggregatesJobs) | **POST** /api/v2/analytics/copilots/aggregates/jobs | Query for copilot aggregates asynchronously
102+
[**postAnalyticsCopilotsAggregatesQuery**](AnalyticsApi#postAnalyticsCopilotsAggregatesQuery) | **POST** /api/v2/analytics/copilots/aggregates/query | Query for copilot aggregates
98103
[**postAnalyticsDataextractionDownloadsBulk**](AnalyticsApi#postAnalyticsDataextractionDownloadsBulk) | **POST** /api/v2/analytics/dataextraction/downloads/bulk | Get download URLs for analytics data warehouse files
99104
[**postAnalyticsEvaluationsAggregatesJobs**](AnalyticsApi#postAnalyticsEvaluationsAggregatesJobs) | **POST** /api/v2/analytics/evaluations/aggregates/jobs | Query for evaluation aggregates asynchronously
100105
[**postAnalyticsEvaluationsAggregatesQuery**](AnalyticsApi#postAnalyticsEvaluationsAggregatesQuery) | **POST** /api/v2/analytics/evaluations/aggregates/query | Query for evaluation aggregates
@@ -491,6 +496,65 @@ apiInstance.deleteAnalyticsConversationsDetailsJob(jobId, opts)
491496
void (no response body)
492497

493498

499+
## deleteAnalyticsCopilotsAggregatesJob
500+
501+
> void deleteAnalyticsCopilotsAggregatesJob(jobId, opts)
502+
503+
504+
DELETE /api/v2/analytics/copilots/aggregates/jobs/{jobId}
505+
506+
Delete/cancel an async request for copilot aggregates
507+
508+
deleteAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
509+
510+
Requires ANY permissions:
511+
512+
* analytics:copilotsAggregate:view
513+
514+
### Example Usage
515+
516+
```{"language":"javascript"}
517+
// Browser
518+
const platformClient = require('platformClient');
519+
// Node
520+
const platformClient = require('purecloud-platform-client-v2');
521+
522+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
523+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
524+
525+
let apiInstance = new platformClient.AnalyticsApi();
526+
527+
let jobId = "jobId_example"; // String | jobId
528+
let opts = {
529+
'customHeaders': { // Object.<string, string> | Request Custom Headers
530+
'X-Service-Name': 'customer-service',
531+
'X-Request-ID': 'req-12345'
532+
}
533+
};
534+
535+
apiInstance.deleteAnalyticsCopilotsAggregatesJob(jobId, opts)
536+
.then(() => {
537+
console.log('deleteAnalyticsCopilotsAggregatesJob returned successfully.');
538+
})
539+
.catch((err) => {
540+
console.log('There was a failure calling deleteAnalyticsCopilotsAggregatesJob');
541+
console.error(err);
542+
});
543+
```
544+
545+
### Parameters
546+
547+
548+
| Name | Type | Description | Notes |
549+
| ------------- | ------------- | ------------- | ------------- |
550+
**jobId** | **String** | jobId | |
551+
**customHeaders** | **Object.<string, string>** | Request Custom Headers | [optional] |
552+
553+
### Return type
554+
555+
void (no response body)
556+
557+
494558
## deleteAnalyticsEvaluationsAggregatesJob
495559

496560
> void deleteAnalyticsEvaluationsAggregatesJob(jobId, opts)
@@ -2364,6 +2428,126 @@ apiInstance.getAnalyticsConversationsDetailsJobsAvailability(opts)
23642428
**DataAvailabilityResponse**
23652429

23662430

2431+
## getAnalyticsCopilotsAggregatesJob
2432+
2433+
> AsyncQueryStatus getAnalyticsCopilotsAggregatesJob(jobId, opts)
2434+
2435+
2436+
GET /api/v2/analytics/copilots/aggregates/jobs/{jobId}
2437+
2438+
Get status for async query for copilot aggregates
2439+
2440+
getAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2441+
2442+
Requires ANY permissions:
2443+
2444+
* analytics:copilotsAggregate:view
2445+
2446+
### Example Usage
2447+
2448+
```{"language":"javascript"}
2449+
// Browser
2450+
const platformClient = require('platformClient');
2451+
// Node
2452+
const platformClient = require('purecloud-platform-client-v2');
2453+
2454+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
2455+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
2456+
2457+
let apiInstance = new platformClient.AnalyticsApi();
2458+
2459+
let jobId = "jobId_example"; // String | jobId
2460+
let opts = {
2461+
'customHeaders': { // Object.<string, string> | Request Custom Headers
2462+
'X-Service-Name': 'customer-service',
2463+
'X-Request-ID': 'req-12345'
2464+
}
2465+
};
2466+
2467+
apiInstance.getAnalyticsCopilotsAggregatesJob(jobId, opts)
2468+
.then((data) => {
2469+
console.log(`getAnalyticsCopilotsAggregatesJob success! data: ${JSON.stringify(data, null, 2)}`);
2470+
})
2471+
.catch((err) => {
2472+
console.log('There was a failure calling getAnalyticsCopilotsAggregatesJob');
2473+
console.error(err);
2474+
});
2475+
```
2476+
2477+
### Parameters
2478+
2479+
2480+
| Name | Type | Description | Notes |
2481+
| ------------- | ------------- | ------------- | ------------- |
2482+
**jobId** | **String** | jobId | |
2483+
**customHeaders** | **Object.<string, string>** | Request Custom Headers | [optional] |
2484+
2485+
### Return type
2486+
2487+
**AsyncQueryStatus**
2488+
2489+
2490+
## getAnalyticsCopilotsAggregatesJobResults
2491+
2492+
> CopilotAsyncAggregateQueryResponse getAnalyticsCopilotsAggregatesJobResults(jobId, opts)
2493+
2494+
2495+
GET /api/v2/analytics/copilots/aggregates/jobs/{jobId}/results
2496+
2497+
Fetch a page of results for an async aggregates query
2498+
2499+
getAnalyticsCopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2500+
2501+
Requires ANY permissions:
2502+
2503+
* analytics:copilotsAggregate:view
2504+
2505+
### Example Usage
2506+
2507+
```{"language":"javascript"}
2508+
// Browser
2509+
const platformClient = require('platformClient');
2510+
// Node
2511+
const platformClient = require('purecloud-platform-client-v2');
2512+
2513+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
2514+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
2515+
2516+
let apiInstance = new platformClient.AnalyticsApi();
2517+
2518+
let jobId = "jobId_example"; // String | jobId
2519+
let opts = {
2520+
'cursor': "cursor_example", // String | Cursor token to retrieve next page
2521+
'customHeaders': { // Object.<string, string> | Request Custom Headers
2522+
'X-Service-Name': 'customer-service',
2523+
'X-Request-ID': 'req-12345'
2524+
}
2525+
};
2526+
2527+
apiInstance.getAnalyticsCopilotsAggregatesJobResults(jobId, opts)
2528+
.then((data) => {
2529+
console.log(`getAnalyticsCopilotsAggregatesJobResults success! data: ${JSON.stringify(data, null, 2)}`);
2530+
})
2531+
.catch((err) => {
2532+
console.log('There was a failure calling getAnalyticsCopilotsAggregatesJobResults');
2533+
console.error(err);
2534+
});
2535+
```
2536+
2537+
### Parameters
2538+
2539+
2540+
| Name | Type | Description | Notes |
2541+
| ------------- | ------------- | ------------- | ------------- |
2542+
**jobId** | **String** | jobId | |
2543+
**cursor** | **String** | Cursor token to retrieve next page | [optional] |
2544+
**customHeaders** | **Object.<string, string>** | Request Custom Headers | [optional] |
2545+
2546+
### Return type
2547+
2548+
**CopilotAsyncAggregateQueryResponse**
2549+
2550+
23672551
## getAnalyticsDataextractionDownload
23682552

23692553
> void getAnalyticsDataextractionDownload(downloadId, opts)
@@ -5460,6 +5644,124 @@ apiInstance.postAnalyticsConversationsDetailsQuery(body, opts)
54605644
**AnalyticsConversationQueryResponse**
54615645

54625646

5647+
## postAnalyticsCopilotsAggregatesJobs
5648+
5649+
> AsyncQueryResponse postAnalyticsCopilotsAggregatesJobs(body, opts)
5650+
5651+
5652+
POST /api/v2/analytics/copilots/aggregates/jobs
5653+
5654+
Query for copilot aggregates asynchronously
5655+
5656+
postAnalyticsCopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5657+
5658+
Requires ANY permissions:
5659+
5660+
* analytics:copilotsAggregate:view
5661+
5662+
### Example Usage
5663+
5664+
```{"language":"javascript"}
5665+
// Browser
5666+
const platformClient = require('platformClient');
5667+
// Node
5668+
const platformClient = require('purecloud-platform-client-v2');
5669+
5670+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
5671+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
5672+
5673+
let apiInstance = new platformClient.AnalyticsApi();
5674+
5675+
let body = {}; // Object | query
5676+
let opts = {
5677+
'customHeaders': { // Object.<string, string> | Request Custom Headers
5678+
'X-Service-Name': 'customer-service',
5679+
'X-Request-ID': 'req-12345'
5680+
}
5681+
};
5682+
5683+
apiInstance.postAnalyticsCopilotsAggregatesJobs(body, opts)
5684+
.then((data) => {
5685+
console.log(`postAnalyticsCopilotsAggregatesJobs success! data: ${JSON.stringify(data, null, 2)}`);
5686+
})
5687+
.catch((err) => {
5688+
console.log('There was a failure calling postAnalyticsCopilotsAggregatesJobs');
5689+
console.error(err);
5690+
});
5691+
```
5692+
5693+
### Parameters
5694+
5695+
5696+
| Name | Type | Description | Notes |
5697+
| ------------- | ------------- | ------------- | ------------- |
5698+
**body** | **Object** | query | |
5699+
**customHeaders** | **Object.<string, string>** | Request Custom Headers | [optional] |
5700+
5701+
### Return type
5702+
5703+
**AsyncQueryResponse**
5704+
5705+
5706+
## postAnalyticsCopilotsAggregatesQuery
5707+
5708+
> CopilotAggregateQueryResponse postAnalyticsCopilotsAggregatesQuery(body, opts)
5709+
5710+
5711+
POST /api/v2/analytics/copilots/aggregates/query
5712+
5713+
Query for copilot aggregates
5714+
5715+
postAnalyticsCopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5716+
5717+
Requires ANY permissions:
5718+
5719+
* analytics:copilotsAggregate:view
5720+
5721+
### Example Usage
5722+
5723+
```{"language":"javascript"}
5724+
// Browser
5725+
const platformClient = require('platformClient');
5726+
// Node
5727+
const platformClient = require('purecloud-platform-client-v2');
5728+
5729+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
5730+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
5731+
5732+
let apiInstance = new platformClient.AnalyticsApi();
5733+
5734+
let body = {}; // Object | query
5735+
let opts = {
5736+
'customHeaders': { // Object.<string, string> | Request Custom Headers
5737+
'X-Service-Name': 'customer-service',
5738+
'X-Request-ID': 'req-12345'
5739+
}
5740+
};
5741+
5742+
apiInstance.postAnalyticsCopilotsAggregatesQuery(body, opts)
5743+
.then((data) => {
5744+
console.log(`postAnalyticsCopilotsAggregatesQuery success! data: ${JSON.stringify(data, null, 2)}`);
5745+
})
5746+
.catch((err) => {
5747+
console.log('There was a failure calling postAnalyticsCopilotsAggregatesQuery');
5748+
console.error(err);
5749+
});
5750+
```
5751+
5752+
### Parameters
5753+
5754+
5755+
| Name | Type | Description | Notes |
5756+
| ------------- | ------------- | ------------- | ------------- |
5757+
**body** | **Object** | query | |
5758+
**customHeaders** | **Object.<string, string>** | Request Custom Headers | [optional] |
5759+
5760+
### Return type
5761+
5762+
**CopilotAggregateQueryResponse**
5763+
5764+
54635765
## postAnalyticsDataextractionDownloadsBulk
54645766

54655767
> DataExtractionFileUrlListing postAnalyticsDataextractionDownloadsBulk(body, opts)
@@ -7098,8 +7400,6 @@ POST /api/v2/analytics/taskmanagement/metrics/query
70987400

70997401
Query for task management observations
71007402

7101-
postAnalyticsTaskmanagementMetricsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7102-
71037403
Requires ALL permissions:
71047404

71057405
* analytics:taskManagementObservation:view
@@ -7734,4 +8034,4 @@ apiInstance.putAnalyticsDataretentionSettings(body, opts)
77348034
**AnalyticsDataRetentionResponse**
77358035

77368036

7737-
_purecloud-platform-client-v2@249.1.0_
8037+
_purecloud-platform-client-v2@250.0.0_

‎docs/ArchitectApi.md‎

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

92539253

9254-
_purecloud-platform-client-v2@249.1.0_
9254+
_purecloud-platform-client-v2@250.0.0_

0 commit comments

Comments
 (0)