Skip to content

Commit 591a3e2

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent f3cc140 commit 591a3e2

90 files changed

Lines changed: 2239 additions & 224 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-02-05T08:51:45
1+
2026-02-09T09:15:38

docs/AIStudioApi.md

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

11381138

1139-
_purecloud-platform-client-v2@244.0.0_
1139+
_purecloud-platform-client-v2@245.0.0_

docs/AgentAssistantsApi.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,9 @@ let apiInstance = new platformClient.AgentAssistantsApi();
266266
267267
let assistantId = "assistantId_example"; // String | Assistant ID
268268
let opts = {
269-
'expand': "expand_example" // String | Which fields, if any, to expand.
269+
'expand': "expand_example", // String | Which fields, if any, to expand.
270+
'languageVariation': "languageVariation_example", // String | Language variation
271+
'fallbackToPrimaryAssistant': true // Boolean | Fall back to primary assistant if specified variation is not found
270272
};
271273
272274
apiInstance.getAssistant(assistantId, opts)
@@ -286,6 +288,8 @@ apiInstance.getAssistant(assistantId, opts)
286288
| ------------- | ------------- | ------------- | ------------- |
287289
**assistantId** | **String** | Assistant ID | |
288290
**expand** | **String** | Which fields, if any, to expand. | [optional] <br />**Values**: copilot |
291+
**languageVariation** | **String** | Language variation | [optional] |
292+
**fallbackToPrimaryAssistant** | **Boolean** | Fall back to primary assistant if specified variation is not found | [optional] |
289293

290294
### Return type
291295

@@ -1273,4 +1277,4 @@ apiInstance.putAssistantsAgentchecklist(agentChecklistId, body)
12731277
**AgentChecklist**
12741278

12751279

1276-
_purecloud-platform-client-v2@244.0.0_
1280+
_purecloud-platform-client-v2@245.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@244.0.0_
169+
_purecloud-platform-client-v2@245.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@244.0.0_
220+
_purecloud-platform-client-v2@245.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@244.0.0_
790+
_purecloud-platform-client-v2@245.0.0_

docs/AnalyticsApi.md

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ All URIs are relative to *https://api.mypurecloud.com*
123123
[**postAnalyticsSurveysAggregatesQuery**](AnalyticsApi#postAnalyticsSurveysAggregatesQuery) | **POST** /api/v2/analytics/surveys/aggregates/query | Query for survey aggregates
124124
[**postAnalyticsTaskmanagementAggregatesJobs**](AnalyticsApi#postAnalyticsTaskmanagementAggregatesJobs) | **POST** /api/v2/analytics/taskmanagement/aggregates/jobs | Query for task management aggregates asynchronously
125125
[**postAnalyticsTaskmanagementAggregatesQuery**](AnalyticsApi#postAnalyticsTaskmanagementAggregatesQuery) | **POST** /api/v2/analytics/taskmanagement/aggregates/query | Query for task management aggregates
126+
[**postAnalyticsTaskmanagementMetricsQuery**](AnalyticsApi#postAnalyticsTaskmanagementMetricsQuery) | **POST** /api/v2/analytics/taskmanagement/metrics/query | Query for task management observations
126127
[**postAnalyticsTeamsActivityQuery**](AnalyticsApi#postAnalyticsTeamsActivityQuery) | **POST** /api/v2/analytics/teams/activity/query | Query for team activity observations
127128
[**postAnalyticsTranscriptsAggregatesJobs**](AnalyticsApi#postAnalyticsTranscriptsAggregatesJobs) | **POST** /api/v2/analytics/transcripts/aggregates/jobs | Query for transcript aggregates asynchronously
128129
[**postAnalyticsTranscriptsAggregatesQuery**](AnalyticsApi#postAnalyticsTranscriptsAggregatesQuery) | **POST** /api/v2/analytics/transcripts/aggregates/query | Query for transcript aggregates
@@ -6321,6 +6322,64 @@ apiInstance.postAnalyticsTaskmanagementAggregatesQuery(body)
63216322
**TaskManagementAggregateQueryResponse**
63226323

63236324

6325+
## postAnalyticsTaskmanagementMetricsQuery
6326+
6327+
> TaskManagementObservationQueryResponse postAnalyticsTaskmanagementMetricsQuery(body, opts)
6328+
6329+
6330+
POST /api/v2/analytics/taskmanagement/metrics/query
6331+
6332+
Query for task management observations
6333+
6334+
postAnalyticsTaskmanagementMetricsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6335+
6336+
Requires ALL permissions:
6337+
6338+
* analytics:taskManagementObservation:view
6339+
6340+
### Example Usage
6341+
6342+
```{"language":"javascript"}
6343+
// Browser
6344+
const platformClient = require('platformClient');
6345+
// Node
6346+
const platformClient = require('purecloud-platform-client-v2');
6347+
6348+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
6349+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
6350+
6351+
let apiInstance = new platformClient.AnalyticsApi();
6352+
6353+
let body = {}; // Object | query
6354+
let opts = {
6355+
'after': "after_example", // String | The cursor that points to the end of the set of entities that has been returned. Used for pagination.
6356+
'pageSize': 3.4 // Number | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.
6357+
};
6358+
6359+
apiInstance.postAnalyticsTaskmanagementMetricsQuery(body, opts)
6360+
.then((data) => {
6361+
console.log(`postAnalyticsTaskmanagementMetricsQuery success! data: ${JSON.stringify(data, null, 2)}`);
6362+
})
6363+
.catch((err) => {
6364+
console.log('There was a failure calling postAnalyticsTaskmanagementMetricsQuery');
6365+
console.error(err);
6366+
});
6367+
```
6368+
6369+
### Parameters
6370+
6371+
6372+
| Name | Type | Description | Notes |
6373+
| ------------- | ------------- | ------------- | ------------- |
6374+
**body** | **Object** | query | |
6375+
**after** | **String** | The cursor that points to the end of the set of entities that has been returned. Used for pagination. | [optional] |
6376+
**pageSize** | **Number** | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. | [optional] |
6377+
6378+
### Return type
6379+
6380+
**TaskManagementObservationQueryResponse**
6381+
6382+
63246383
## postAnalyticsTeamsActivityQuery
63256384

63266385
> TeamActivityResponse postAnalyticsTeamsActivityQuery(body, opts)
@@ -6837,4 +6896,4 @@ apiInstance.putAnalyticsDataretentionSettings(body)
68376896
**AnalyticsDataRetentionResponse**
68386897

68396898

6840-
_purecloud-platform-client-v2@244.0.0_
6899+
_purecloud-platform-client-v2@245.0.0_

docs/ArchitectApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1327,7 +1327,7 @@ let id = "id_example"; // String | Consuming object ID
13271327
let version = "version_example"; // String | Consuming object version
13281328
let objectType = "objectType_example"; // String | Consuming object type. Only versioned types are allowed here.
13291329
let opts = {
1330-
'resourceType': ["resourceType_example"], // [String] | Types of consumed resources to show
1330+
'resourceType': ["resourceType_example"], // [String] | Types of consumed resources to show.
13311331
'pageNumber': 1, // Number | Page number
13321332
'pageSize': 25 // Number | Page size
13331333
};
@@ -1350,7 +1350,7 @@ apiInstance.getArchitectDependencytrackingConsumedresources(id, version, objectT
13501350
**id** | **String** | Consuming object ID | |
13511351
**version** | **String** | Consuming object version | |
13521352
**objectType** | **String** | Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, AGENTICVIRTUALAGENT, AGENTICVIRTUALAGENTVERSION, AUDIOCONNECTORBOT, BOTCONNECTORBOT, BOTCONNECTORINTEGRATION, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, CONVERSATIONCUSTOMATTRIBUTESCHEMA, DATAACTION, DATATABLE, DECISIONTABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, DIALOGFLOWCXAGENT, DIGITALAUDIO, DIGITALBOTCONNECTOR, DIGITALBOTCONNECTORINTEGRATION, DIGITALBOTFLOW, DIVISION, EMAILROUTE, EMERGENCYGROUP, FILE, FLOWACTION, FLOWDATATYPE, FLOWMILESTONE, FLOWOUTCOME, GRAMMAR, GROUP, GUIDE, GUIDEVERSION, IMAGE, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, INQUEUEEMAILFLOW, INQUEUESHORTMESSAGEFLOW, IVRCONFIGURATION, KNOWLEDGEBASE, KNOWLEDGEBASEDOCUMENT, KNOWLEDGESETTING, LANGUAGE, LEXBOT, LEXBOTALIAS, LEXV2BOT, LEXV2BOTALIAS, NLUDOMAIN, NUANCEMIXBOT, NUANCEMIXINTEGRATION, OAUTHCLIENT, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, RESPONSEASSET, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SMSPHONENUMBER, STTENGINE, SURVEYFORM, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, UTILIZATIONLABEL, VIDEO, VOICEFLOW, VOICEMAILFLOW, VOICESURVEYFLOW, WIDGET, WORKFLOW, WORKITEMFLOW, WORKTYPE |
1353-
**resourceType** | **[String]** | Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, AGENTICVIRTUALAGENT, AGENTICVIRTUALAGENTVERSION, AUDIOCONNECTORBOT, BOTCONNECTORBOT, BOTCONNECTORINTEGRATION, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, CONVERSATIONCUSTOMATTRIBUTESCHEMA, DATAACTION, DATATABLE, DECISIONTABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, DIALOGFLOWCXAGENT, DIGITALAUDIO, DIGITALBOTCONNECTOR, DIGITALBOTCONNECTORINTEGRATION, DIGITALBOTFLOW, DIVISION, EMAILROUTE, EMERGENCYGROUP, FILE, FLOWACTION, FLOWDATATYPE, FLOWMILESTONE, FLOWOUTCOME, GRAMMAR, GROUP, GUIDE, GUIDEVERSION, IMAGE, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, INQUEUEEMAILFLOW, INQUEUESHORTMESSAGEFLOW, IVRCONFIGURATION, KNOWLEDGEBASE, KNOWLEDGEBASEDOCUMENT, KNOWLEDGESETTING, LANGUAGE, LEXBOT, LEXBOTALIAS, LEXV2BOT, LEXV2BOTALIAS, NLUDOMAIN, NUANCEMIXBOT, NUANCEMIXINTEGRATION, OAUTHCLIENT, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, RESPONSEASSET, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SMSPHONENUMBER, STTENGINE, SURVEYFORM, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, UTILIZATIONLABEL, VIDEO, VOICEFLOW, VOICEMAILFLOW, VOICESURVEYFLOW, WIDGET, WORKFLOW, WORKITEMFLOW, WORKTYPE |
1353+
**resourceType** | **[String]** | Types of consumed resources to show. | [optional] |
13541354
**pageNumber** | **Number** | Page number | [optional] [default to 1] |
13551355
**pageSize** | **Number** | Page size | [optional] [default to 25] |
13561356

@@ -1412,7 +1412,7 @@ apiInstance.getArchitectDependencytrackingConsumingresources(id, objectType, opt
14121412
| ------------- | ------------- | ------------- | ------------- |
14131413
**id** | **String** | Consumed object ID | |
14141414
**objectType** | **String** | Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, AGENTICVIRTUALAGENT, AGENTICVIRTUALAGENTVERSION, AUDIOCONNECTORBOT, BOTCONNECTORBOT, BOTCONNECTORINTEGRATION, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, CONVERSATIONCUSTOMATTRIBUTESCHEMA, DATAACTION, DATATABLE, DECISIONTABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, DIALOGFLOWCXAGENT, DIGITALAUDIO, DIGITALBOTCONNECTOR, DIGITALBOTCONNECTORINTEGRATION, DIGITALBOTFLOW, DIVISION, EMAILROUTE, EMERGENCYGROUP, FILE, FLOWACTION, FLOWDATATYPE, FLOWMILESTONE, FLOWOUTCOME, GRAMMAR, GROUP, GUIDE, GUIDEVERSION, IMAGE, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, INQUEUEEMAILFLOW, INQUEUESHORTMESSAGEFLOW, IVRCONFIGURATION, KNOWLEDGEBASE, KNOWLEDGEBASEDOCUMENT, KNOWLEDGESETTING, LANGUAGE, LEXBOT, LEXBOTALIAS, LEXV2BOT, LEXV2BOTALIAS, NLUDOMAIN, NUANCEMIXBOT, NUANCEMIXINTEGRATION, OAUTHCLIENT, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, RESPONSEASSET, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SMSPHONENUMBER, STTENGINE, SURVEYFORM, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, UTILIZATIONLABEL, VIDEO, VOICEFLOW, VOICEMAILFLOW, VOICESURVEYFLOW, WIDGET, WORKFLOW, WORKITEMFLOW, WORKTYPE |
1415-
**resourceType** | **[String]** | Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, AGENTICVIRTUALAGENT, AGENTICVIRTUALAGENTVERSION, AUDIOCONNECTORBOT, BOTCONNECTORBOT, BOTCONNECTORINTEGRATION, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, CONVERSATIONCUSTOMATTRIBUTESCHEMA, DATAACTION, DATATABLE, DECISIONTABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, DIALOGFLOWCXAGENT, DIGITALAUDIO, DIGITALBOTCONNECTOR, DIGITALBOTCONNECTORINTEGRATION, DIGITALBOTFLOW, DIVISION, EMAILROUTE, EMERGENCYGROUP, FILE, FLOWACTION, FLOWDATATYPE, FLOWMILESTONE, FLOWOUTCOME, GRAMMAR, GROUP, GUIDE, GUIDEVERSION, IMAGE, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, INQUEUEEMAILFLOW, INQUEUESHORTMESSAGEFLOW, IVRCONFIGURATION, KNOWLEDGEBASE, KNOWLEDGEBASEDOCUMENT, KNOWLEDGESETTING, LANGUAGE, LEXBOT, LEXBOTALIAS, LEXV2BOT, LEXV2BOTALIAS, NLUDOMAIN, NUANCEMIXBOT, NUANCEMIXINTEGRATION, OAUTHCLIENT, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, RESPONSEASSET, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SMSPHONENUMBER, STTENGINE, SURVEYFORM, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, UTILIZATIONLABEL, VIDEO, VOICEFLOW, VOICEMAILFLOW, VOICESURVEYFLOW, WIDGET, WORKFLOW, WORKITEMFLOW, WORKTYPE |
1415+
**resourceType** | **[String]** | Types of consuming resources to show. Only versioned types are allowed here. | [optional] |
14161416
**version** | **String** | Object version | [optional] |
14171417
**pageNumber** | **Number** | Page number | [optional] [default to 1] |
14181418
**pageSize** | **Number** | Page size | [optional] [default to 25] |
@@ -8348,4 +8348,4 @@ apiInstance.putFlowsOutcome(flowOutcomeId, opts)
83488348
**Operation**
83498349

83508350

8351-
_purecloud-platform-client-v2@244.0.0_
8351+
_purecloud-platform-client-v2@245.0.0_

0 commit comments

Comments
 (0)