Skip to content

Commit 2fd1554

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent 7a86b98 commit 2fd1554

86 files changed

Lines changed: 4485 additions & 416 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-07-30T10:39:09
1+
2025-08-03T06:44:48

docs/AIStudioApi.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ All URIs are relative to *https://api.mypurecloud.com*
1313
[**getGuideVersionJob**](AIStudioApi#getGuideVersionJob) | **GET** /api/v2/guides/{guideId}/versions/{versionId}/jobs/{jobId} | Get the status of the publishing job for this guide version.
1414
[**getGuides**](AIStudioApi#getGuides) | **GET** /api/v2/guides | Get all guides.
1515
[**getGuidesJob**](AIStudioApi#getGuidesJob) | **GET** /api/v2/guides/jobs/{jobId} | Get the status of the guide content generation job.
16+
[**patchGuide**](AIStudioApi#patchGuide) | **PATCH** /api/v2/guides/{guideId} | Update a guide.
1617
[**patchGuideVersion**](AIStudioApi#patchGuideVersion) | **PATCH** /api/v2/guides/{guideId}/versions/{versionId} | Update a guide version.
1718
[**postGuideVersionJobs**](AIStudioApi#postGuideVersionJobs) | **POST** /api/v2/guides/{guideId}/versions/{versionId}/jobs | Start the publishing of a guide version.
1819
[**postGuideVersions**](AIStudioApi#postGuideVersions) | **POST** /api/v2/guides/{guideId}/versions | Create a guide version.
@@ -407,6 +408,60 @@ apiInstance.getGuidesJob(jobId)
407408
**GuideContentGenerationJob**
408409

409410

411+
## patchGuide
412+
413+
> Guide patchGuide(guideId, body)
414+
415+
416+
PATCH /api/v2/guides/{guideId}
417+
418+
Update a guide.
419+
420+
patchGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
421+
422+
Requires ALL permissions:
423+
424+
* aiStudio:guide:edit
425+
426+
### Example Usage
427+
428+
```{"language":"javascript"}
429+
// Browser
430+
const platformClient = require('platformClient');
431+
// Node
432+
const platformClient = require('purecloud-platform-client-v2');
433+
434+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
435+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
436+
437+
let apiInstance = new platformClient.AIStudioApi();
438+
439+
let guideId = "guideId_example"; // String | Guide ID
440+
let body = {}; // Object |
441+
442+
apiInstance.patchGuide(guideId, body)
443+
.then((data) => {
444+
console.log(`patchGuide success! data: ${JSON.stringify(data, null, 2)}`);
445+
})
446+
.catch((err) => {
447+
console.log('There was a failure calling patchGuide');
448+
console.error(err);
449+
});
450+
```
451+
452+
### Parameters
453+
454+
455+
| Name | Type | Description | Notes |
456+
| ------------- | ------------- | ------------- | ------------- |
457+
**guideId** | **String** | Guide ID | |
458+
**body** | **Object** | | |
459+
460+
### Return type
461+
462+
**Guide**
463+
464+
410465
## patchGuideVersion
411466

412467
> GuideVersion patchGuideVersion(guideId, versionId, body)
@@ -679,4 +734,4 @@ apiInstance.postGuidesJobs(body)
679734
**GuideContentGenerationJob**
680735

681736

682-
_purecloud-platform-client-v2@227.0.0_
737+
_purecloud-platform-client-v2@228.0.0_

docs/AgentAssistantsApi.md

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

679679

680-
_purecloud-platform-client-v2@227.0.0_
680+
_purecloud-platform-client-v2@228.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@227.0.0_
116+
_purecloud-platform-client-v2@228.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@227.0.0_
220+
_purecloud-platform-client-v2@228.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@227.0.0_
790+
_purecloud-platform-client-v2@228.0.0_

0 commit comments

Comments
 (0)