Skip to content

Commit c839d1f

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent 18ad16c commit c839d1f

85 files changed

Lines changed: 2042 additions & 282 deletions

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-08-27T09:23:50
1+
2025-09-22T16:13:21

‎docs/AIStudioApi.md‎

Lines changed: 321 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ All URIs are relative to *https://api.mypurecloud.com*
66

77
| Method | HTTP request | Description |
88
| ------------- | ------------- | ------------- |
9+
[**deleteConversationsSummariesSetting**](AIStudioApi#deleteConversationsSummariesSetting) | **DELETE** /api/v2/conversations/summaries/settings/{summarySettingId} | Delete a summary setting.
910
[**deleteGuideJobs**](AIStudioApi#deleteGuideJobs) | **DELETE** /api/v2/guides/{guideId}/jobs | Start the deletion of a guide.
11+
[**getConversationsSummariesSetting**](AIStudioApi#getConversationsSummariesSetting) | **GET** /api/v2/conversations/summaries/settings/{summarySettingId} | Receive a summary setting.
12+
[**getConversationsSummariesSettings**](AIStudioApi#getConversationsSummariesSettings) | **GET** /api/v2/conversations/summaries/settings | Get all summary settings.
1013
[**getGuide**](AIStudioApi#getGuide) | **GET** /api/v2/guides/{guideId} | Get guide.
1114
[**getGuideJob**](AIStudioApi#getGuideJob) | **GET** /api/v2/guides/{guideId}/jobs/{jobId} | Get the specified guide deletion job.
1215
[**getGuideVersion**](AIStudioApi#getGuideVersion) | **GET** /api/v2/guides/{guideId}/versions/{versionId} | Get a guide version.
@@ -15,13 +18,66 @@ All URIs are relative to *https://api.mypurecloud.com*
1518
[**getGuidesJob**](AIStudioApi#getGuidesJob) | **GET** /api/v2/guides/jobs/{jobId} | Get the status of the guide content generation job.
1619
[**patchGuide**](AIStudioApi#patchGuide) | **PATCH** /api/v2/guides/{guideId} | Update a guide.
1720
[**patchGuideVersion**](AIStudioApi#patchGuideVersion) | **PATCH** /api/v2/guides/{guideId}/versions/{versionId} | Update a guide version.
21+
[**postConversationsSummariesPreview**](AIStudioApi#postConversationsSummariesPreview) | **POST** /api/v2/conversations/summaries/preview | Trigger summary preview event generation.
22+
[**postConversationsSummariesSettings**](AIStudioApi#postConversationsSummariesSettings) | **POST** /api/v2/conversations/summaries/settings | Create a summary setting.
1823
[**postGuideVersionJobs**](AIStudioApi#postGuideVersionJobs) | **POST** /api/v2/guides/{guideId}/versions/{versionId}/jobs | Start the publishing of a guide version.
1924
[**postGuideVersions**](AIStudioApi#postGuideVersions) | **POST** /api/v2/guides/{guideId}/versions | Create a guide version.
2025
[**postGuides**](AIStudioApi#postGuides) | **POST** /api/v2/guides | Create a guide.
2126
[**postGuidesJobs**](AIStudioApi#postGuidesJobs) | **POST** /api/v2/guides/jobs | Start a guide content generation job.
27+
[**putConversationsSummariesSetting**](AIStudioApi#putConversationsSummariesSetting) | **PUT** /api/v2/conversations/summaries/settings/{summarySettingId} | Update a summary setting.
2228

2329

2430

31+
## deleteConversationsSummariesSetting
32+
33+
> void deleteConversationsSummariesSetting(summarySettingId)
34+
35+
36+
DELETE /api/v2/conversations/summaries/settings/{summarySettingId}
37+
38+
Delete a summary setting.
39+
40+
Requires ALL permissions:
41+
42+
* aiStudio:summaryConfig:delete
43+
44+
### Example Usage
45+
46+
```{"language":"javascript"}
47+
// Browser
48+
const platformClient = require('platformClient');
49+
// Node
50+
const platformClient = require('purecloud-platform-client-v2');
51+
52+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
53+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
54+
55+
let apiInstance = new platformClient.AIStudioApi();
56+
57+
let summarySettingId = "summarySettingId_example"; // String | Summary setting id
58+
59+
apiInstance.deleteConversationsSummariesSetting(summarySettingId)
60+
.then(() => {
61+
console.log('deleteConversationsSummariesSetting returned successfully.');
62+
})
63+
.catch((err) => {
64+
console.log('There was a failure calling deleteConversationsSummariesSetting');
65+
console.error(err);
66+
});
67+
```
68+
69+
### Parameters
70+
71+
72+
| Name | Type | Description | Notes |
73+
| ------------- | ------------- | ------------- | ------------- |
74+
**summarySettingId** | **String** | Summary setting id | |
75+
76+
### Return type
77+
78+
void (no response body)
79+
80+
2581
## deleteGuideJobs
2682

2783
> GuideJob deleteGuideJobs(guideId)
@@ -74,6 +130,118 @@ apiInstance.deleteGuideJobs(guideId)
74130
**GuideJob**
75131

76132

133+
## getConversationsSummariesSetting
134+
135+
> SummarySetting getConversationsSummariesSetting(summarySettingId)
136+
137+
138+
GET /api/v2/conversations/summaries/settings/{summarySettingId}
139+
140+
Receive a summary setting.
141+
142+
Requires ALL permissions:
143+
144+
* aiStudio:summaryConfig:view
145+
146+
### Example Usage
147+
148+
```{"language":"javascript"}
149+
// Browser
150+
const platformClient = require('platformClient');
151+
// Node
152+
const platformClient = require('purecloud-platform-client-v2');
153+
154+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
155+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
156+
157+
let apiInstance = new platformClient.AIStudioApi();
158+
159+
let summarySettingId = "summarySettingId_example"; // String | Summary setting id
160+
161+
apiInstance.getConversationsSummariesSetting(summarySettingId)
162+
.then((data) => {
163+
console.log(`getConversationsSummariesSetting success! data: ${JSON.stringify(data, null, 2)}`);
164+
})
165+
.catch((err) => {
166+
console.log('There was a failure calling getConversationsSummariesSetting');
167+
console.error(err);
168+
});
169+
```
170+
171+
### Parameters
172+
173+
174+
| Name | Type | Description | Notes |
175+
| ------------- | ------------- | ------------- | ------------- |
176+
**summarySettingId** | **String** | Summary setting id | |
177+
178+
### Return type
179+
180+
**SummarySetting**
181+
182+
183+
## getConversationsSummariesSettings
184+
185+
> SummarySettingEntityListing getConversationsSummariesSettings(opts)
186+
187+
188+
GET /api/v2/conversations/summaries/settings
189+
190+
Get all summary settings.
191+
192+
Requires ALL permissions:
193+
194+
* aiStudio:summaryConfig:view
195+
196+
### Example Usage
197+
198+
```{"language":"javascript"}
199+
// Browser
200+
const platformClient = require('platformClient');
201+
// Node
202+
const platformClient = require('purecloud-platform-client-v2');
203+
204+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
205+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
206+
207+
let apiInstance = new platformClient.AIStudioApi();
208+
209+
let opts = {
210+
'language': "language_example", // String | Filter by matching language - case insensitive.
211+
'name': "name_example", // String | Filter by partially matching name - case insensitive.
212+
'sortBy': "dateModified", // String | Sort by. Default value dateModified.
213+
'sortOrder': "desc", // String | Sort Order. Default value desc.
214+
'pageNumber': 1, // Number | Page number.
215+
'pageSize': 25 // Number | Page size. The maximum page size is 100.
216+
};
217+
218+
apiInstance.getConversationsSummariesSettings(opts)
219+
.then((data) => {
220+
console.log(`getConversationsSummariesSettings success! data: ${JSON.stringify(data, null, 2)}`);
221+
})
222+
.catch((err) => {
223+
console.log('There was a failure calling getConversationsSummariesSettings');
224+
console.error(err);
225+
});
226+
```
227+
228+
### Parameters
229+
230+
231+
| Name | Type | Description | Notes |
232+
| ------------- | ------------- | ------------- | ------------- |
233+
**language** | **String** | Filter by matching language - case insensitive. | [optional] |
234+
**name** | **String** | Filter by partially matching name - case insensitive. | [optional] |
235+
**sortBy** | **String** | Sort by. Default value dateModified. | [optional] [default to dateModified]<br />**Values**: dateModified, name |
236+
**sortOrder** | **String** | Sort Order. Default value desc. | [optional] [default to desc]<br />**Values**: asc, desc |
237+
**pageNumber** | **Number** | Page number. | [optional] [default to 1] |
238+
**pageSize** | **Number** | Page size. The maximum page size is 100. | [optional] [default to 25] |
239+
240+
### Return type
241+
242+
**SummarySettingEntityListing**
243+
244+
77245
## getGuide
78246

79247
> Guide getGuide(guideId)
@@ -518,6 +686,106 @@ apiInstance.patchGuideVersion(guideId, versionId, body)
518686
**GuideVersion**
519687

520688

689+
## postConversationsSummariesPreview
690+
691+
> void postConversationsSummariesPreview(body)
692+
693+
694+
POST /api/v2/conversations/summaries/preview
695+
696+
Trigger summary preview event generation.
697+
698+
Requires ALL permissions:
699+
700+
* aiStudio:summaryPreview:view
701+
702+
### Example Usage
703+
704+
```{"language":"javascript"}
705+
// Browser
706+
const platformClient = require('platformClient');
707+
// Node
708+
const platformClient = require('purecloud-platform-client-v2');
709+
710+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
711+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
712+
713+
let apiInstance = new platformClient.AIStudioApi();
714+
715+
let body = {}; // Object |
716+
717+
apiInstance.postConversationsSummariesPreview(body)
718+
.then(() => {
719+
console.log('postConversationsSummariesPreview returned successfully.');
720+
})
721+
.catch((err) => {
722+
console.log('There was a failure calling postConversationsSummariesPreview');
723+
console.error(err);
724+
});
725+
```
726+
727+
### Parameters
728+
729+
730+
| Name | Type | Description | Notes |
731+
| ------------- | ------------- | ------------- | ------------- |
732+
**body** | **Object** | | |
733+
734+
### Return type
735+
736+
void (no response body)
737+
738+
739+
## postConversationsSummariesSettings
740+
741+
> SummarySetting postConversationsSummariesSettings(body)
742+
743+
744+
POST /api/v2/conversations/summaries/settings
745+
746+
Create a summary setting.
747+
748+
Requires ALL permissions:
749+
750+
* aiStudio:summaryConfig:add
751+
752+
### Example Usage
753+
754+
```{"language":"javascript"}
755+
// Browser
756+
const platformClient = require('platformClient');
757+
// Node
758+
const platformClient = require('purecloud-platform-client-v2');
759+
760+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
761+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
762+
763+
let apiInstance = new platformClient.AIStudioApi();
764+
765+
let body = {}; // Object |
766+
767+
apiInstance.postConversationsSummariesSettings(body)
768+
.then((data) => {
769+
console.log(`postConversationsSummariesSettings success! data: ${JSON.stringify(data, null, 2)}`);
770+
})
771+
.catch((err) => {
772+
console.log('There was a failure calling postConversationsSummariesSettings');
773+
console.error(err);
774+
});
775+
```
776+
777+
### Parameters
778+
779+
780+
| Name | Type | Description | Notes |
781+
| ------------- | ------------- | ------------- | ------------- |
782+
**body** | **Object** | | |
783+
784+
### Return type
785+
786+
**SummarySetting**
787+
788+
521789
## postGuideVersionJobs
522790

523791
> GuideVersionPublishJob postGuideVersionJobs(guideId, versionId, body)
@@ -734,4 +1002,56 @@ apiInstance.postGuidesJobs(body)
7341002
**GuideContentGenerationJob**
7351003

7361004

737-
_purecloud-platform-client-v2@230.0.0_
1005+
## putConversationsSummariesSetting
1006+
1007+
> SummarySetting putConversationsSummariesSetting(summarySettingId, body)
1008+
1009+
1010+
PUT /api/v2/conversations/summaries/settings/{summarySettingId}
1011+
1012+
Update a summary setting.
1013+
1014+
Requires ALL permissions:
1015+
1016+
* aiStudio:summaryConfig:edit
1017+
1018+
### Example Usage
1019+
1020+
```{"language":"javascript"}
1021+
// Browser
1022+
const platformClient = require('platformClient');
1023+
// Node
1024+
const platformClient = require('purecloud-platform-client-v2');
1025+
1026+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
1027+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
1028+
1029+
let apiInstance = new platformClient.AIStudioApi();
1030+
1031+
let summarySettingId = "summarySettingId_example"; // String | Summary setting id
1032+
let body = {}; // Object |
1033+
1034+
apiInstance.putConversationsSummariesSetting(summarySettingId, body)
1035+
.then((data) => {
1036+
console.log(`putConversationsSummariesSetting success! data: ${JSON.stringify(data, null, 2)}`);
1037+
})
1038+
.catch((err) => {
1039+
console.log('There was a failure calling putConversationsSummariesSetting');
1040+
console.error(err);
1041+
});
1042+
```
1043+
1044+
### Parameters
1045+
1046+
1047+
| Name | Type | Description | Notes |
1048+
| ------------- | ------------- | ------------- | ------------- |
1049+
**summarySettingId** | **String** | Summary setting id | |
1050+
**body** | **Object** | | |
1051+
1052+
### Return type
1053+
1054+
**SummarySetting**
1055+
1056+
1057+
_purecloud-platform-client-v2@231.0.0_

‎docs/AgentAssistantsApi.md‎

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

848848

849-
_purecloud-platform-client-v2@230.0.0_
849+
_purecloud-platform-client-v2@231.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@230.0.0_
116+
_purecloud-platform-client-v2@231.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@230.0.0_
220+
_purecloud-platform-client-v2@231.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@230.0.0_
790+
_purecloud-platform-client-v2@231.0.0_

0 commit comments

Comments
 (0)