Skip to content

Commit bc02455

Browse files
feat(sdk): v4.15.3 - Auto-generated from unified API spec
Generated from unified API spec v4.15.3 Changes: - Auto-generated SDK updates This PR was automatically created by the API generation pipeline.
1 parent e0cf556 commit bc02455

File tree

962 files changed

+35215
-1181
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

962 files changed

+35215
-1181
lines changed

.openapi-generator/FILES

Lines changed: 231 additions & 6 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 122 additions & 4 deletions
Large diffs are not rendered by default.

docs/AIAgentsApi.md

Lines changed: 257 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,13 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**chat_with_ai_agent**](AIAgentsApi.md#chat_with_ai_agent) | **POST** /api/v3/organizations/{organisation}/ai/agents/{agentId}/chat | Chat with AI Agent
88
[**create_ai_agent**](AIAgentsApi.md#create_ai_agent) | **POST** /api/v3/organizations/{organisation}/ai/agents | Create AI Agent
9+
[**delete_agent_overlay**](AIAgentsApi.md#delete_agent_overlay) | **DELETE** /api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay | Delete Agent Overlay
910
[**delete_ai_agent**](AIAgentsApi.md#delete_ai_agent) | **DELETE** /api/v3/organizations/{organisation}/ai/agents/{agentId} | Delete Agent
11+
[**get_agent_overlay**](AIAgentsApi.md#get_agent_overlay) | **GET** /api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay | Get Agent Overlay
1012
[**get_ai_agent**](AIAgentsApi.md#get_ai_agent) | **GET** /api/v3/organizations/{organisation}/ai/agents/{agentId} | Get Agent Details
1113
[**list_ai_agents**](AIAgentsApi.md#list_ai_agents) | **GET** /api/v3/organizations/{organisation}/ai/agents | List AI Agents
1214
[**update_ai_agent**](AIAgentsApi.md#update_ai_agent) | **PUT** /api/v3/organizations/{organisation}/ai/agents/{agentId} | Update Agent
15+
[**upsert_agent_overlay**](AIAgentsApi.md#upsert_agent_overlay) | **PUT** /api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay | Upsert Agent Overlay
1316

1417

1518
# **chat_with_ai_agent**
@@ -223,6 +226,89 @@ Name | Type | Description | Notes
223226

224227
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
225228

229+
# **delete_agent_overlay**
230+
> DeleteAgentOverlay200Response delete_agent_overlay(organisation, agent_id)
231+
232+
Delete Agent Overlay
233+
234+
Removes the per-organisation overlay for a global agent, reverting it to platform defaults.
235+
236+
### Example
237+
238+
* Bearer (JWT) Authentication (BearerAuth):
239+
240+
```python
241+
import quantcdn
242+
from quantcdn.models.delete_agent_overlay200_response import DeleteAgentOverlay200Response
243+
from quantcdn.rest import ApiException
244+
from pprint import pprint
245+
246+
# Defining the host is optional and defaults to https://dashboard.quantcdn.io
247+
# See configuration.py for a list of all supported configuration parameters.
248+
configuration = quantcdn.Configuration(
249+
host = "https://dashboard.quantcdn.io"
250+
)
251+
252+
# The client must configure the authentication and authorization parameters
253+
# in accordance with the API server security policy.
254+
# Examples for each auth method are provided below, use the example that
255+
# satisfies your auth use case.
256+
257+
# Configure Bearer authorization (JWT): BearerAuth
258+
configuration = quantcdn.Configuration(
259+
access_token = os.environ["BEARER_TOKEN"]
260+
)
261+
262+
# Enter a context with an instance of the API client
263+
with quantcdn.ApiClient(configuration) as api_client:
264+
# Create an instance of the API class
265+
api_instance = quantcdn.AIAgentsApi(api_client)
266+
organisation = 'organisation_example' # str | The organisation ID
267+
agent_id = 'agent_id_example' # str | Global agent identifier
268+
269+
try:
270+
# Delete Agent Overlay
271+
api_response = api_instance.delete_agent_overlay(organisation, agent_id)
272+
print("The response of AIAgentsApi->delete_agent_overlay:\n")
273+
pprint(api_response)
274+
except Exception as e:
275+
print("Exception when calling AIAgentsApi->delete_agent_overlay: %s\n" % e)
276+
```
277+
278+
279+
280+
### Parameters
281+
282+
283+
Name | Type | Description | Notes
284+
------------- | ------------- | ------------- | -------------
285+
**organisation** | **str**| The organisation ID |
286+
**agent_id** | **str**| Global agent identifier |
287+
288+
### Return type
289+
290+
[**DeleteAgentOverlay200Response**](DeleteAgentOverlay200Response.md)
291+
292+
### Authorization
293+
294+
[BearerAuth](../README.md#BearerAuth)
295+
296+
### HTTP request headers
297+
298+
- **Content-Type**: Not defined
299+
- **Accept**: application/json
300+
301+
### HTTP response details
302+
303+
| Status code | Description | Response headers |
304+
|-------------|-------------|------------------|
305+
**200** | Overlay deleted — agent reverted to defaults | - |
306+
**403** | Access denied | - |
307+
**404** | Not a global agent | - |
308+
**500** | Failed to reset overlay | - |
309+
310+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
311+
226312
# **delete_ai_agent**
227313
> DeleteAIAgent200Response delete_ai_agent(organisation, agent_id)
228314
@@ -306,6 +392,89 @@ Name | Type | Description | Notes
306392

307393
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
308394

395+
# **get_agent_overlay**
396+
> GetAgentOverlay200Response get_agent_overlay(organisation, agent_id)
397+
398+
Get Agent Overlay
399+
400+
Returns the per-organisation overlay for a global agent, plus base agent metadata for UI context. If no overlay exists the response contains `overlay: null`. Overlays can only be created for global agents.
401+
402+
### Example
403+
404+
* Bearer (JWT) Authentication (BearerAuth):
405+
406+
```python
407+
import quantcdn
408+
from quantcdn.models.get_agent_overlay200_response import GetAgentOverlay200Response
409+
from quantcdn.rest import ApiException
410+
from pprint import pprint
411+
412+
# Defining the host is optional and defaults to https://dashboard.quantcdn.io
413+
# See configuration.py for a list of all supported configuration parameters.
414+
configuration = quantcdn.Configuration(
415+
host = "https://dashboard.quantcdn.io"
416+
)
417+
418+
# The client must configure the authentication and authorization parameters
419+
# in accordance with the API server security policy.
420+
# Examples for each auth method are provided below, use the example that
421+
# satisfies your auth use case.
422+
423+
# Configure Bearer authorization (JWT): BearerAuth
424+
configuration = quantcdn.Configuration(
425+
access_token = os.environ["BEARER_TOKEN"]
426+
)
427+
428+
# Enter a context with an instance of the API client
429+
with quantcdn.ApiClient(configuration) as api_client:
430+
# Create an instance of the API class
431+
api_instance = quantcdn.AIAgentsApi(api_client)
432+
organisation = 'organisation_example' # str | The organisation ID
433+
agent_id = 'agent_id_example' # str | Global agent identifier (e.g., 'quantgov-code')
434+
435+
try:
436+
# Get Agent Overlay
437+
api_response = api_instance.get_agent_overlay(organisation, agent_id)
438+
print("The response of AIAgentsApi->get_agent_overlay:\n")
439+
pprint(api_response)
440+
except Exception as e:
441+
print("Exception when calling AIAgentsApi->get_agent_overlay: %s\n" % e)
442+
```
443+
444+
445+
446+
### Parameters
447+
448+
449+
Name | Type | Description | Notes
450+
------------- | ------------- | ------------- | -------------
451+
**organisation** | **str**| The organisation ID |
452+
**agent_id** | **str**| Global agent identifier (e.g., 'quantgov-code') |
453+
454+
### Return type
455+
456+
[**GetAgentOverlay200Response**](GetAgentOverlay200Response.md)
457+
458+
### Authorization
459+
460+
[BearerAuth](../README.md#BearerAuth)
461+
462+
### HTTP request headers
463+
464+
- **Content-Type**: Not defined
465+
- **Accept**: application/json
466+
467+
### HTTP response details
468+
469+
| Status code | Description | Response headers |
470+
|-------------|-------------|------------------|
471+
**200** | Overlay retrieved (may be null if none set) | - |
472+
**403** | Access denied | - |
473+
**404** | Not a global agent | - |
474+
**500** | Failed to retrieve overlay | - |
475+
476+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
477+
309478
# **get_ai_agent**
310479
> GetAIAgent200Response get_ai_agent(organisation, agent_id)
311480
@@ -563,3 +732,91 @@ Name | Type | Description | Notes
563732

564733
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
565734

735+
# **upsert_agent_overlay**
736+
> UpsertAgentOverlay200Response upsert_agent_overlay(organisation, agent_id, upsert_agent_overlay_request)
737+
738+
Upsert Agent Overlay
739+
740+
Creates or replaces the per-organisation overlay for a global agent. PUT is full replacement — omitted optional fields are removed. Include `version` from a prior GET to enable compare-and-swap (409 on conflict). Omit for last-writer-wins.
741+
742+
### Example
743+
744+
* Bearer (JWT) Authentication (BearerAuth):
745+
746+
```python
747+
import quantcdn
748+
from quantcdn.models.upsert_agent_overlay200_response import UpsertAgentOverlay200Response
749+
from quantcdn.models.upsert_agent_overlay_request import UpsertAgentOverlayRequest
750+
from quantcdn.rest import ApiException
751+
from pprint import pprint
752+
753+
# Defining the host is optional and defaults to https://dashboard.quantcdn.io
754+
# See configuration.py for a list of all supported configuration parameters.
755+
configuration = quantcdn.Configuration(
756+
host = "https://dashboard.quantcdn.io"
757+
)
758+
759+
# The client must configure the authentication and authorization parameters
760+
# in accordance with the API server security policy.
761+
# Examples for each auth method are provided below, use the example that
762+
# satisfies your auth use case.
763+
764+
# Configure Bearer authorization (JWT): BearerAuth
765+
configuration = quantcdn.Configuration(
766+
access_token = os.environ["BEARER_TOKEN"]
767+
)
768+
769+
# Enter a context with an instance of the API client
770+
with quantcdn.ApiClient(configuration) as api_client:
771+
# Create an instance of the API class
772+
api_instance = quantcdn.AIAgentsApi(api_client)
773+
organisation = 'organisation_example' # str | The organisation ID
774+
agent_id = 'agent_id_example' # str | Global agent identifier
775+
upsert_agent_overlay_request = quantcdn.UpsertAgentOverlayRequest() # UpsertAgentOverlayRequest |
776+
777+
try:
778+
# Upsert Agent Overlay
779+
api_response = api_instance.upsert_agent_overlay(organisation, agent_id, upsert_agent_overlay_request)
780+
print("The response of AIAgentsApi->upsert_agent_overlay:\n")
781+
pprint(api_response)
782+
except Exception as e:
783+
print("Exception when calling AIAgentsApi->upsert_agent_overlay: %s\n" % e)
784+
```
785+
786+
787+
788+
### Parameters
789+
790+
791+
Name | Type | Description | Notes
792+
------------- | ------------- | ------------- | -------------
793+
**organisation** | **str**| The organisation ID |
794+
**agent_id** | **str**| Global agent identifier |
795+
**upsert_agent_overlay_request** | [**UpsertAgentOverlayRequest**](UpsertAgentOverlayRequest.md)| |
796+
797+
### Return type
798+
799+
[**UpsertAgentOverlay200Response**](UpsertAgentOverlay200Response.md)
800+
801+
### Authorization
802+
803+
[BearerAuth](../README.md#BearerAuth)
804+
805+
### HTTP request headers
806+
807+
- **Content-Type**: application/json
808+
- **Accept**: application/json
809+
810+
### HTTP response details
811+
812+
| Status code | Description | Response headers |
813+
|-------------|-------------|------------------|
814+
**200** | Overlay created or updated | - |
815+
**400** | Invalid request parameters | - |
816+
**403** | Access denied | - |
817+
**404** | Not a global agent | - |
818+
**409** | Version conflict — overlay was modified concurrently | - |
819+
**500** | Failed to save overlay | - |
820+
821+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
822+

0 commit comments

Comments
 (0)