Skip to content

Commit ba52706

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent a616380 commit ba52706

88 files changed

Lines changed: 2394 additions & 120 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-
2025-12-22T16:50:13
1+
2026-01-12T14:12:50

‎docs/AIStudioApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1111,4 +1111,4 @@ apiInstance.putConversationsSummariesSetting(summarySettingId, body)
11111111
**SummarySetting**
11121112

11131113

1114-
_purecloud-platform-client-v2@241.1.0_
1114+
_purecloud-platform-client-v2@242.0.0_

‎docs/AgentAssistantsApi.md‎

Lines changed: 111 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ All URIs are relative to *https://api.mypurecloud.com*
1212
[**deleteAssistantsAgentchecklist**](AgentAssistantsApi#deleteAssistantsAgentchecklist) | **DELETE** /api/v2/assistants/agentchecklists/{agentChecklistId} | Delete an agent checklist
1313
[**getAssistant**](AgentAssistantsApi#getAssistant) | **GET** /api/v2/assistants/{assistantId} | Get an assistant.
1414
[**getAssistantQueue**](AgentAssistantsApi#getAssistantQueue) | **GET** /api/v2/assistants/{assistantId}/queues/{queueId} | Get queue Information for an assistant.
15+
[**getAssistantQueueUsersJob**](AgentAssistantsApi#getAssistantQueueUsersJob) | **GET** /api/v2/assistants/{assistantId}/queues/{queueId}/users/jobs/{jobId} | Get job details.
1516
[**getAssistantQueues**](AgentAssistantsApi#getAssistantQueues) | **GET** /api/v2/assistants/{assistantId}/queues | Get all the queues associated with an assistant.
1617
[**getAssistants**](AgentAssistantsApi#getAssistants) | **GET** /api/v2/assistants | Get all assistants.
1718
[**getAssistantsAgentchecklist**](AgentAssistantsApi#getAssistantsAgentchecklist) | **GET** /api/v2/assistants/agentchecklists/{agentChecklistId} | Get an agent checklist
@@ -22,6 +23,7 @@ All URIs are relative to *https://api.mypurecloud.com*
2223
[**patchAssistantQueues**](AgentAssistantsApi#patchAssistantQueues) | **PATCH** /api/v2/assistants/{assistantId}/queues | Update Queues for an Assistant.
2324
[**postAssistantQueueUsersBulkAdd**](AgentAssistantsApi#postAssistantQueueUsersBulkAdd) | **POST** /api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/add | Bulk add users to assistant-queue (requires manual assignment mode).
2425
[**postAssistantQueueUsersBulkRemove**](AgentAssistantsApi#postAssistantQueueUsersBulkRemove) | **POST** /api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/remove | Bulk remove users from assistant-queue (requires manual assignment mode).
26+
[**postAssistantQueueUsersJobs**](AgentAssistantsApi#postAssistantQueueUsersJobs) | **POST** /api/v2/assistants/{assistantId}/queues/{queueId}/users/jobs | Start a new job to assistant-queue.
2527
[**postAssistantQueueUsersQuery**](AgentAssistantsApi#postAssistantQueueUsersQuery) | **POST** /api/v2/assistants/{assistantId}/queues/{queueId}/users/query | Query for users in the assistant-queue (requires manual assignment mode).
2628
[**postAssistants**](AgentAssistantsApi#postAssistants) | **POST** /api/v2/assistants | Create an Assistant.
2729
[**postAssistantsAgentchecklists**](AgentAssistantsApi#postAssistantsAgentchecklists) | **POST** /api/v2/assistants/agentchecklists | Create an agent checklist
@@ -346,6 +348,60 @@ apiInstance.getAssistantQueue(assistantId, queueId, opts)
346348
**AssistantQueue**
347349

348350

351+
## getAssistantQueueUsersJob
352+
353+
> AssistantQueueUsersJobsResponse getAssistantQueueUsersJob(assistantId, queueId, jobId)
354+
355+
356+
GET /api/v2/assistants/{assistantId}/queues/{queueId}/users/jobs/{jobId}
357+
358+
Get job details.
359+
360+
Requires ANY permissions:
361+
362+
* assistants:queueUserJob:view
363+
364+
### Example Usage
365+
366+
```{"language":"javascript"}
367+
// Browser
368+
const platformClient = require('platformClient');
369+
// Node
370+
const platformClient = require('purecloud-platform-client-v2');
371+
372+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
373+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
374+
375+
let apiInstance = new platformClient.AgentAssistantsApi();
376+
377+
let assistantId = "assistantId_example"; // String | Assistant ID
378+
let queueId = "queueId_example"; // String | Queue ID
379+
let jobId = "jobId_example"; // String | Job ID
380+
381+
apiInstance.getAssistantQueueUsersJob(assistantId, queueId, jobId)
382+
.then((data) => {
383+
console.log(`getAssistantQueueUsersJob success! data: ${JSON.stringify(data, null, 2)}`);
384+
})
385+
.catch((err) => {
386+
console.log('There was a failure calling getAssistantQueueUsersJob');
387+
console.error(err);
388+
});
389+
```
390+
391+
### Parameters
392+
393+
394+
| Name | Type | Description | Notes |
395+
| ------------- | ------------- | ------------- | ------------- |
396+
**assistantId** | **String** | Assistant ID | |
397+
**queueId** | **String** | Queue ID | |
398+
**jobId** | **String** | Job ID | |
399+
400+
### Return type
401+
402+
**AssistantQueueUsersJobsResponse**
403+
404+
349405
## getAssistantQueues
350406

351407
> AssistantQueueListing getAssistantQueues(assistantId, opts)
@@ -899,6 +955,60 @@ apiInstance.postAssistantQueueUsersBulkRemove(assistantId, queueId, body)
899955
**BulkResponse**
900956

901957

958+
## postAssistantQueueUsersJobs
959+
960+
> AssistantQueueUsersJobsResponse postAssistantQueueUsersJobs(assistantId, queueId, body)
961+
962+
963+
POST /api/v2/assistants/{assistantId}/queues/{queueId}/users/jobs
964+
965+
Start a new job to assistant-queue.
966+
967+
Requires ANY permissions:
968+
969+
* assistants:queueUserJob:add
970+
971+
### Example Usage
972+
973+
```{"language":"javascript"}
974+
// Browser
975+
const platformClient = require('platformClient');
976+
// Node
977+
const platformClient = require('purecloud-platform-client-v2');
978+
979+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
980+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
981+
982+
let apiInstance = new platformClient.AgentAssistantsApi();
983+
984+
let assistantId = "assistantId_example"; // String | Assistant ID
985+
let queueId = "queueId_example"; // String | Queue ID
986+
let body = {}; // Object |
987+
988+
apiInstance.postAssistantQueueUsersJobs(assistantId, queueId, body)
989+
.then((data) => {
990+
console.log(`postAssistantQueueUsersJobs success! data: ${JSON.stringify(data, null, 2)}`);
991+
})
992+
.catch((err) => {
993+
console.log('There was a failure calling postAssistantQueueUsersJobs');
994+
console.error(err);
995+
});
996+
```
997+
998+
### Parameters
999+
1000+
1001+
| Name | Type | Description | Notes |
1002+
| ------------- | ------------- | ------------- | ------------- |
1003+
**assistantId** | **String** | Assistant ID | |
1004+
**queueId** | **String** | Queue ID | |
1005+
**body** | **Object** | | |
1006+
1007+
### Return type
1008+
1009+
**AssistantQueueUsersJobsResponse**
1010+
1011+
9021012
## postAssistantQueueUsersQuery
9031013

9041014
> AssistantQueueUsersQueryResponse postAssistantQueueUsersQuery(assistantId, queueId, body, opts)
@@ -1163,4 +1273,4 @@ apiInstance.putAssistantsAgentchecklist(agentChecklistId, body)
11631273
**AgentChecklist**
11641274

11651275

1166-
_purecloud-platform-client-v2@241.1.0_
1276+
_purecloud-platform-client-v2@242.0.0_

‎docs/AgentCopilotApi.md‎

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

168168

169-
_purecloud-platform-client-v2@241.1.0_
169+
_purecloud-platform-client-v2@242.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@241.1.0_
220+
_purecloud-platform-client-v2@242.0.0_

‎docs/AlertingApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -787,4 +787,4 @@ apiInstance.putAlertingRule(ruleId, body)
787787
**CommonRule**
788788

789789

790-
_purecloud-platform-client-v2@241.1.0_
790+
_purecloud-platform-client-v2@242.0.0_

‎docs/AnalyticsApi.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4264,7 +4264,7 @@ apiInstance.postAnalyticsAgentcopilotsAggregatesQuery(body)
42644264

42654265
## postAnalyticsAgentsStatusCounts
42664266

4267-
> AnalyticsAgentStateCountsResponse postAnalyticsAgentsStatusCounts(body)
4267+
> AnalyticsAgentStateCountsResponse postAnalyticsAgentsStatusCounts(body, opts)
42684268
42694269

42704270
POST /api/v2/analytics/agents/status/counts
@@ -4289,8 +4289,11 @@ platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
42894289
let apiInstance = new platformClient.AnalyticsApi();
42904290
42914291
let body = {}; // Object | query
4292+
let opts = {
4293+
'groupBy': ["groupBy_example"] // [String] | Include to choose which groupings to count by and return. If not included it will return only counts grouped by segmentType
4294+
};
42924295
4293-
apiInstance.postAnalyticsAgentsStatusCounts(body)
4296+
apiInstance.postAnalyticsAgentsStatusCounts(body, opts)
42944297
.then((data) => {
42954298
console.log(`postAnalyticsAgentsStatusCounts success! data: ${JSON.stringify(data, null, 2)}`);
42964299
})
@@ -4306,6 +4309,7 @@ apiInstance.postAnalyticsAgentsStatusCounts(body)
43064309
| Name | Type | Description | Notes |
43074310
| ------------- | ------------- | ------------- | ------------- |
43084311
**body** | **Object** | query | |
4312+
**groupBy** | **[String]** | Include to choose which groupings to count by and return. If not included it will return only counts grouped by segmentType | [optional] <br />**Values**: segmentType, presence, routingStatus, isOutOfOffice |
43094313

43104314
### Return type
43114315

@@ -6833,4 +6837,4 @@ apiInstance.putAnalyticsDataretentionSettings(body)
68336837
**AnalyticsDataRetentionResponse**
68346838

68356839

6836-
_purecloud-platform-client-v2@241.1.0_
6840+
_purecloud-platform-client-v2@242.0.0_

0 commit comments

Comments
 (0)