Skip to content

Commit 77b93a9

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent d879d24 commit 77b93a9

5,957 files changed

Lines changed: 7347 additions & 7622 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-01-12T14:06:26
1+
2026-01-16T09:07:35

docs/ADFS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@
2727

2828

2929

30-
_PureCloudPlatformClientV2 247.0.0_
30+
_PureCloudPlatformClientV2 248.0.0_

docs/AIStudioApi.md

Lines changed: 50 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ All URIs are relative to *https://api.mypurecloud.com*
2525
|[**post_guide_versions**](#post_guide_versions) | Create a guide version.|
2626
|[**post_guides**](#post_guides) | Create a guide.|
2727
|[**post_guides_jobs**](#post_guides_jobs) | Start a guide content generation job.|
28+
|[**post_guides_uploads**](#post_guides_uploads) | Generate presigned URL for uploading a file content to generate guide|
2829
|[**put_conversations_summaries_setting**](#put_conversations_summaries_setting) | Update a summary setting.|
2930

3031

@@ -83,8 +84,6 @@ void (empty response body)
8384

8485
Start the deletion of a guide.
8586

86-
delete_guide_jobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
87-
8887
Wraps DELETE /api/v2/guides/{guideId}/jobs
8988

9089
Requires ALL permissions:
@@ -239,8 +238,6 @@ except ApiException as e:
239238

240239
Get guide.
241240

242-
get_guide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
243-
244241
Wraps GET /api/v2/guides/{guideId}
245242

246243
Requires ALL permissions:
@@ -289,8 +286,6 @@ except ApiException as e:
289286

290287
Get the specified guide deletion job.
291288

292-
get_guide_job is a preview method and is subject to both breaking and non-breaking changes at any time without notice
293-
294289
Wraps GET /api/v2/guides/{guideId}/jobs/{jobId}
295290

296291
Requires ALL permissions:
@@ -341,8 +336,6 @@ except ApiException as e:
341336

342337
Get a guide version.
343338

344-
get_guide_version is a preview method and is subject to both breaking and non-breaking changes at any time without notice
345-
346339
Wraps GET /api/v2/guides/{guideId}/versions/{versionId}
347340

348341
Requires ALL permissions:
@@ -393,8 +386,6 @@ except ApiException as e:
393386

394387
Get the status of the publishing job for this guide version.
395388

396-
get_guide_version_job is a preview method and is subject to both breaking and non-breaking changes at any time without notice
397-
398389
Wraps GET /api/v2/guides/{guideId}/versions/{versionId}/jobs/{jobId}
399390

400391
Requires ALL permissions:
@@ -447,8 +438,6 @@ except ApiException as e:
447438

448439
Get all guides.
449440

450-
get_guides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
451-
452441
Wraps GET /api/v2/guides
453442

454443
Requires ALL permissions:
@@ -509,8 +498,6 @@ except ApiException as e:
509498

510499
Get the status of the guide content generation job.
511500

512-
get_guides_job is a preview method and is subject to both breaking and non-breaking changes at any time without notice
513-
514501
Wraps GET /api/v2/guides/jobs/{jobId}
515502

516503
Requires ALL permissions:
@@ -559,8 +546,6 @@ except ApiException as e:
559546

560547
Update a guide.
561548

562-
patch_guide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
563-
564549
Wraps PATCH /api/v2/guides/{guideId}
565550

566551
Requires ALL permissions:
@@ -611,8 +596,6 @@ except ApiException as e:
611596

612597
Update a guide version.
613598

614-
patch_guide_version is a preview method and is subject to both breaking and non-breaking changes at any time without notice
615-
616599
Wraps PATCH /api/v2/guides/{guideId}/versions/{versionId}
617600

618601
Requires ALL permissions:
@@ -814,8 +797,6 @@ except ApiException as e:
814797

815798
Start the publishing of a guide version.
816799

817-
post_guide_version_jobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
818-
819800
Wraps POST /api/v2/guides/{guideId}/versions/{versionId}/jobs
820801

821802
Requires ALL permissions:
@@ -868,8 +849,6 @@ except ApiException as e:
868849

869850
Create a guide version.
870851

871-
post_guide_versions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
872-
873852
Wraps POST /api/v2/guides/{guideId}/versions
874853

875854
Requires ALL permissions:
@@ -920,8 +899,6 @@ except ApiException as e:
920899

921900
Create a guide.
922901

923-
post_guides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
924-
925902
Wraps POST /api/v2/guides
926903

927904
Requires ALL permissions:
@@ -970,8 +947,6 @@ except ApiException as e:
970947

971948
Start a guide content generation job.
972949

973-
post_guides_jobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
974-
975950
Wraps POST /api/v2/guides/jobs
976951

977952
Requires ALL permissions:
@@ -1013,6 +988,54 @@ except ApiException as e:
1013988
[**GuideContentGenerationJob**](GuideContentGenerationJob)
1014989

1015990

991+
## post_guides_uploads
992+
993+
> [**UploadUrlResponse**](UploadUrlResponse) post_guides_uploads(body)
994+
995+
996+
Generate presigned URL for uploading a file content to generate guide
997+
998+
Wraps POST /api/v2/guides/uploads
999+
1000+
Requires ALL permissions:
1001+
1002+
* aiStudio:guide:upload
1003+
1004+
### Example
1005+
1006+
```{"language":"python"}
1007+
import time
1008+
import PureCloudPlatformClientV2
1009+
from PureCloudPlatformClientV2.rest import ApiException
1010+
from pprint import pprint
1011+
1012+
# Configure OAuth2 access token for authorization: PureCloud OAuth
1013+
PureCloudPlatformClientV2.configuration.access_token = 'YOUR_ACCESS_TOKEN'
1014+
1015+
# create an instance of the API class
1016+
api_instance = PureCloudPlatformClientV2.AIStudioApi()
1017+
body = PureCloudPlatformClientV2.UploadUrlRequest() # UploadUrlRequest | query
1018+
1019+
try:
1020+
# Generate presigned URL for uploading a file content to generate guide
1021+
api_response = api_instance.post_guides_uploads(body)
1022+
pprint(api_response)
1023+
except ApiException as e:
1024+
print("Exception when calling AIStudioApi->post_guides_uploads: %s\n" % e)
1025+
```
1026+
1027+
### Parameters
1028+
1029+
1030+
|Name | Type | Description | Notes|
1031+
|------------- | ------------- | ------------- | -------------|
1032+
| **body** | [**UploadUrlRequest**](UploadUrlRequest)| query | |
1033+
1034+
### Return type
1035+
1036+
[**UploadUrlResponse**](UploadUrlResponse)
1037+
1038+
10161039
## put_conversations_summaries_setting
10171040

10181041
> [**SummarySetting**](SummarySetting) put_conversations_summaries_setting(summary_setting_id, body)
@@ -1063,4 +1086,4 @@ except ApiException as e:
10631086
[**SummarySetting**](SummarySetting)
10641087

10651088

1066-
_PureCloudPlatformClientV2 247.0.0_
1089+
_PureCloudPlatformClientV2 248.0.0_

docs/AcceleratorInput.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212

1313

1414

15-
_PureCloudPlatformClientV2 247.0.0_
15+
_PureCloudPlatformClientV2 248.0.0_

docs/AcceleratorList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@
1919

2020

2121

22-
_PureCloudPlatformClientV2 247.0.0_
22+
_PureCloudPlatformClientV2 248.0.0_

docs/AcceleratorMetadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@
1717

1818

1919

20-
_PureCloudPlatformClientV2 247.0.0_
20+
_PureCloudPlatformClientV2 248.0.0_

docs/AcceleratorParameter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111

1212

1313

14-
_PureCloudPlatformClientV2 247.0.0_
14+
_PureCloudPlatformClientV2 248.0.0_

docs/AcceleratorSpecification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@
2222

2323

2424

25-
_PureCloudPlatformClientV2 247.0.0_
25+
_PureCloudPlatformClientV2 248.0.0_

docs/AcdEndDetailEventTopicAcdEndEvent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@
4141

4242

4343

44-
_PureCloudPlatformClientV2 247.0.0_
44+
_PureCloudPlatformClientV2 248.0.0_

docs/AcdStartDetailEventTopicAcdStartEvent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@
3232

3333

3434

35-
_PureCloudPlatformClientV2 247.0.0_
35+
_PureCloudPlatformClientV2 248.0.0_

0 commit comments

Comments
 (0)