Skip to content

Commit 4db4fd6

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent 3c8eb29 commit 4db4fd6

89 files changed

Lines changed: 2718 additions & 767 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-05-21T07:57:14
1+
2026-05-28T08:09:55

docs/AIStudioApi.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -228,12 +228,12 @@ platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
228228
let apiInstance = new platformClient.AIStudioApi();
229229
230230
let opts = {
231-
'language': "language_example", // String | Filter by matching language - case insensitive.
232-
'name': "name_example", // String | Filter by partially matching name - case insensitive.
233-
'sortBy': "dateModified", // String | Sort by. Default value dateModified.
234-
'sortOrder': "desc", // String | Sort Order. Default value desc.
235231
'pageNumber': 1, // Number | Page number.
236232
'pageSize': 25, // Number | Page size. The maximum page size is 100.
233+
'name': "name_example", // String | Filter by partially matching name - case insensitive.
234+
'sortOrder': "desc", // String | Sort Order. Default value desc.
235+
'language': "language_example", // String | Filter by matching language - case insensitive.
236+
'sortBy': "dateModified", // String | Sort by. Default value dateModified.
237237
'customHeaders': { // Object.<string, string> | Request Custom Headers
238238
'X-Service-Name': 'customer-service',
239239
'X-Request-ID': 'req-12345'
@@ -255,12 +255,12 @@ apiInstance.getConversationsSummariesSettings(opts)
255255

256256
| Name | Type | Description | Notes |
257257
| ------------- | ------------- | ------------- | ------------- |
258-
**language** | **String** | Filter by matching language - case insensitive. | [optional] |
259-
**name** | **String** | Filter by partially matching name - case insensitive. | [optional] |
260-
**sortBy** | **String** | Sort by. Default value dateModified. | [optional] [default to dateModified]<br />**Values**: dateModified, name |
261-
**sortOrder** | **String** | Sort Order. Default value desc. | [optional] [default to desc]<br />**Values**: asc, desc |
262258
**pageNumber** | **Number** | Page number. | [optional] [default to 1] |
263259
**pageSize** | **Number** | Page size. The maximum page size is 100. | [optional] [default to 25] |
260+
**name** | **String** | Filter by partially matching name - case insensitive. | [optional] |
261+
**sortOrder** | **String** | Sort Order. Default value desc. | [optional] [default to desc]<br />**Values**: asc, desc |
262+
**language** | **String** | Filter by matching language - case insensitive. | [optional] |
263+
**sortBy** | **String** | Sort by. Default value dateModified. | [optional] [default to dateModified]<br />**Values**: dateModified, name |
264264
**customHeaders** | **Object.<string, string>** | Request Custom Headers | [optional] |
265265

266266
### Return type
@@ -1277,4 +1277,4 @@ apiInstance.putConversationsSummariesSetting(summarySettingId, body, opts)
12771277
**SummarySetting**
12781278

12791279

1280-
_purecloud-platform-client-v2@252.1.0_
1280+
_purecloud-platform-client-v2@253.0.0_

docs/AgentAssistantsApi.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,7 @@ let opts = {
672672
'language': "language_example", // String | The agent checklist language filter applied to the listing.
673673
'sortOrder': "sortOrder_example", // String | The sort order for the listing
674674
'sortBy': "sortBy_example", // String | The field to sort by for the listing.
675+
'agentChecklistIds': ["agentChecklistIds_example"], // [String] | Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters.
675676
'customHeaders': { // Object.<string, string> | Request Custom Headers
676677
'X-Service-Name': 'customer-service',
677678
'X-Request-ID': 'req-12345'
@@ -700,6 +701,7 @@ apiInstance.getAssistantsAgentchecklists(opts)
700701
**language** | **String** | The agent checklist language filter applied to the listing. | [optional] |
701702
**sortOrder** | **String** | The sort order for the listing | [optional] <br />**Values**: asc, desc |
702703
**sortBy** | **String** | The field to sort by for the listing. | [optional] <br />**Values**: dateModified, language, name |
704+
**agentChecklistIds** | **[String]** | Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters. | [optional] |
703705
**customHeaders** | **Object.<string, string>** | Request Custom Headers | [optional] |
704706

705707
### Return type
@@ -1424,4 +1426,4 @@ apiInstance.putAssistantsAgentchecklist(agentChecklistId, body, opts)
14241426
**AgentChecklist**
14251427

14261428

1427-
_purecloud-platform-client-v2@252.1.0_
1429+
_purecloud-platform-client-v2@253.0.0_

docs/AgentCopilotApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,4 +185,4 @@ apiInstance.putAssistantCopilot(assistantId, body, opts)
185185
**Copilot**
186186

187187

188-
_purecloud-platform-client-v2@252.1.0_
188+
_purecloud-platform-client-v2@253.0.0_

docs/AgentUIApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,4 +245,4 @@ apiInstance.putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body, opts)
245245
**AutoAnswerSettings**
246246

247247

248-
_purecloud-platform-client-v2@252.1.0_
248+
_purecloud-platform-client-v2@253.0.0_

docs/AlertingApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -884,4 +884,4 @@ apiInstance.putAlertingRule(ruleId, body, opts)
884884
**CommonRule**
885885

886886

887-
_purecloud-platform-client-v2@252.1.0_
887+
_purecloud-platform-client-v2@253.0.0_

docs/AnalyticsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8336,4 +8336,4 @@ apiInstance.putAnalyticsDataretentionSettings(body, opts)
83368336
**AnalyticsDataRetentionResponse**
83378337

83388338

8339-
_purecloud-platform-client-v2@252.1.0_
8339+
_purecloud-platform-client-v2@253.0.0_

docs/ArchitectApi.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8265,7 +8265,9 @@ const platformClient = require('purecloud-platform-client-v2');
82658265
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
82668266
82678267
let apiInstance = new platformClient.ArchitectApi();
8268+
82688269
let opts = {
8270+
'body': null, // Object |
82698271
'customHeaders': { // Object.<string, string> | Request Custom Headers
82708272
'X-Service-Name': 'customer-service',
82718273
'X-Request-ID': 'req-12345'
@@ -8287,6 +8289,7 @@ apiInstance.postFlowsJobs(opts)
82878289

82888290
| Name | Type | Description | Notes |
82898291
| ------------- | ------------- | ------------- | ------------- |
8292+
**body** | **Object** | | [optional] |
82908293
**customHeaders** | **Object.<string, string>** | Request Custom Headers | [optional] |
82918294

82928295
### Return type
@@ -9317,4 +9320,4 @@ apiInstance.putFlowsOutcome(flowOutcomeId, opts)
93179320
**Operation**
93189321

93199322

9320-
_purecloud-platform-client-v2@252.1.0_
9323+
_purecloud-platform-client-v2@253.0.0_

docs/AssistantCopilotVariationsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,4 +309,4 @@ apiInstance.putAssistantVariation(assistantId, variationId, body, opts)
309309
**AssistantCopilotVariation**
310310

311311

312-
_purecloud-platform-client-v2@252.1.0_
312+
_purecloud-platform-client-v2@253.0.0_

docs/AuditApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,4 +425,4 @@ apiInstance.postAuditsQueryRealtimeRelated(body, opts)
425425
**AuditRealtimeRelatedResultsResponse**
426426

427427

428-
_purecloud-platform-client-v2@252.1.0_
428+
_purecloud-platform-client-v2@253.0.0_

0 commit comments

Comments
 (0)