Skip to content

Commit 46845bc

Browse files
author
ks-docs-sync[bot]
committed
chore(sync): pull latest SDK docs (2026-07-14)
1 parent 94560a7 commit 46845bc

67 files changed

Lines changed: 1399 additions & 233 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.

sdks/_generated-python/AgentApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Quota: consumes one MESSAGE before ``start_workflow``. Refund
2222
semantics distinguish cause:
2323

2424
* **Cancellation** (client disconnect → ``asyncio.CancelledError``,
25-
OR explicit ``DELETE /v1/workflows/{id}`` while we await
25+
OR explicit ``DELETE /v1/system-jobs/{id}`` while we await
2626
``handle.result()`` → Temporal-wrapped ``CancelledError``)
2727
**NO REFUND.** The user walked away or actively cancelled;
2828
that's their volition. We still best-effort cancel the

sdks/_generated-python/AuditEventsApi.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Same filters as ``list_audit_events`` but unpaginated — streams every
1919
matching event newest-first. Each row resolves the actor's name and the
2020
subject's name + path so an auditor can read the file directly in Excel.
2121

22+
With no `since`/`until` the export covers the entire audit log; pass either
23+
bound to narrow to an optional from/to window.
24+
2225
### Example
2326

2427
* Api Key Authentication (cookieAuth):
@@ -57,8 +60,8 @@ with ksapi.ApiClient(configuration) as api_client:
5760
api_instance = ksapi.AuditEventsApi(api_client)
5861
actor_user_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter to one actor (optional)
5962
kind = 'kind_example' # str | Filter to one event kind (optional)
60-
since = '2013-10-20T19:20:30+01:00' # datetime | Only events at or after this timestamp (optional)
61-
until = '2013-10-20T19:20:30+01:00' # datetime | Only events strictly before this timestamp (optional)
63+
since = '2013-10-20T19:20:30+01:00' # datetime | Only events at or after this timestamp (from). Omit to export the entire audit log. Must not be in the future or after `until`. (optional)
64+
until = '2013-10-20T19:20:30+01:00' # datetime | Only events strictly before this timestamp (to). Omit for no upper bound. Must not be in the future. (optional)
6265
subject_path_part_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Scope to one document/folder/run subject (optional)
6366
recursive = False # bool | Include the subject's descendants (needs subject) (optional) (default to False)
6467

@@ -80,8 +83,8 @@ Name | Type | Description | Notes
8083
------------- | ------------- | ------------- | -------------
8184
**actor_user_id** | **UUID**| Filter to one actor | [optional]
8285
**kind** | **str**| Filter to one event kind | [optional]
83-
**since** | **datetime**| Only events at or after this timestamp | [optional]
84-
**until** | **datetime**| Only events strictly before this timestamp | [optional]
86+
**since** | **datetime**| Only events at or after this timestamp (from). Omit to export the entire audit log. Must not be in the future or after `until`. | [optional]
87+
**until** | **datetime**| Only events strictly before this timestamp (to). Omit for no upper bound. Must not be in the future. | [optional]
8588
**subject_path_part_id** | **UUID**| Scope to one document/folder/run subject | [optional]
8689
**recursive** | **bool**| Include the subject's descendants (needs subject) | [optional] [default to False]
8790

@@ -116,8 +119,9 @@ List Audit Events Handler
116119
List the tenant's audit events, newest first (admin/owner only).
117120

118121
Returns every event in the caller's own tenant — ADMIN/OWNER bypass path
119-
permissions by design. Filter by actor, kind, time window, and/or a subject
120-
subtree. Each event carries its resolved actor name.
122+
permissions by design. Filter by actor, kind, an optional `since`(from)/
123+
`until`(to) window, and/or a subject subtree. Each event carries its
124+
resolved actor name.
121125

122126
### Example
123127

@@ -159,8 +163,8 @@ with ksapi.ApiClient(configuration) as api_client:
159163
api_instance = ksapi.AuditEventsApi(api_client)
160164
actor_user_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter to one actor (optional)
161165
kind = 'kind_example' # str | Filter to one event kind (optional)
162-
since = '2013-10-20T19:20:30+01:00' # datetime | Only events at or after this timestamp (optional)
163-
until = '2013-10-20T19:20:30+01:00' # datetime | Only events strictly before this timestamp (optional)
166+
since = '2013-10-20T19:20:30+01:00' # datetime | Only events at or after this timestamp (from). Omit for no lower bound. Must not be in the future or after `until`. (optional)
167+
until = '2013-10-20T19:20:30+01:00' # datetime | Only events strictly before this timestamp (to). Omit for no upper bound. Must not be in the future. (optional)
164168
subject_path_part_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Scope to one document/folder/run subject (optional)
165169
recursive = False # bool | Include the subject's descendants (needs subject) (optional) (default to False)
166170
sort_dir = ksapi.SortDirection() # SortDirection | Sort by timestamp (default: DESC, newest first) (optional)
@@ -185,8 +189,8 @@ Name | Type | Description | Notes
185189
------------- | ------------- | ------------- | -------------
186190
**actor_user_id** | **UUID**| Filter to one actor | [optional]
187191
**kind** | **str**| Filter to one event kind | [optional]
188-
**since** | **datetime**| Only events at or after this timestamp | [optional]
189-
**until** | **datetime**| Only events strictly before this timestamp | [optional]
192+
**since** | **datetime**| Only events at or after this timestamp (from). Omit for no lower bound. Must not be in the future or after `until`. | [optional]
193+
**until** | **datetime**| Only events strictly before this timestamp (to). Omit for no upper bound. Must not be in the future. | [optional]
190194
**subject_path_part_id** | **UUID**| Scope to one document/folder/run subject | [optional]
191195
**recursive** | **bool**| Include the subject's descendants (needs subject) | [optional] [default to False]
192196
**sort_dir** | [**SortDirection**](.md)| Sort by timestamp (default: DESC, newest first) | [optional]

sdks/_generated-python/COMMIT

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
fa91b6bfbe86c2bd14b91b2c299efd3fd1ec9488
1+
ea6a5bc8a412741e017afe6d4297426a58a8a0f1

sdks/_generated-python/CreateApiKeyResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**id** | **UUID** | |
1010
**name** | **str** | |
11-
**key** | **str** | |
11+
**key** | **str** | The raw API key, returned only at creation. Send it as `Authorization: Bearer <key>`. |
1212
**key_suffix** | **str** | |
1313
**created_at** | **datetime** | |
1414
**expires_at** | **datetime** | |
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# DataSourceDescribeResponse
2+
3+
Result of (re)describing a connector's modeled tables. Each modeled table gets a one-line summary embedded as a single Qdrant point for the agent's table search. Counts report how many tables were (re)summarized and (re)embedded this call; unchanged tables are skipped (the embed is content-hash gated), so a repeat call reports zeros.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**data_source_id** | **UUID** | |
10+
**tables_total** | **int** | Modeled tables considered |
11+
**summarized** | **int** | Tables whose summary was (re)generated |
12+
**embedded** | **int** | Tables whose Qdrant point was (re)written |
13+
14+
## Example
15+
16+
```python
17+
from ksapi.models.data_source_describe_response import DataSourceDescribeResponse
18+
19+
# TODO update the JSON string below
20+
json = "{}"
21+
# create an instance of DataSourceDescribeResponse from a JSON string
22+
data_source_describe_response_instance = DataSourceDescribeResponse.from_json(json)
23+
# print the JSON string representation of the object
24+
print(DataSourceDescribeResponse.to_json())
25+
26+
# convert the object into a dict
27+
data_source_describe_response_dict = data_source_describe_response_instance.to_dict()
28+
# create an instance of DataSourceDescribeResponse from a dict
29+
data_source_describe_response_from_dict = DataSourceDescribeResponse.from_dict(data_source_describe_response_dict)
30+
```
31+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32+
33+

sdks/_generated-python/DataSourceDescriptionResponse.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

sdks/_generated-python/DataSourceDetailResponse.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# DataSourceDetailResponse
22

3-
A connector plus the schemas (and their readable tables) the caller sees. ``description_document_id`` points at the connector's generated, ingested \"Database overview\" Document (a hidden system file); null until generated.
3+
A connector plus the schemas (and their readable tables) the caller sees.
44

55
## Properties
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**data_source** | [**DataSourceResponse**](DataSourceResponse.md) | |
1010
**schemas** | [**List[DataSourceSchemaResponse]**](DataSourceSchemaResponse.md) | |
11-
**description_document_id** | **UUID** | | [optional]
1211

1312
## Example
1413

sdks/_generated-python/DataSourceSchemaResponse.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Name | Type | Description | Notes
1616
**data_source_id** | **UUID** | |
1717
**schema_name** | **str** | Real namespace in the external DB |
1818
**is_default** | **bool** | True for the connection's default namespace |
19-
**description** | **str** | |
2019
**approval_state** | [**PathPartApprovalState**](PathPartApprovalState.md) | |
2120
**permissions** | [**ItemPermissions**](ItemPermissions.md) | |
2221
**created_at** | **datetime** | |
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# DataSourceSyncResponse
2+
3+
Result of reconciling modeled tables against the live external catalog.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**data_source_id** | **UUID** | |
10+
**updated** | **int** | Tables whose columns changed → column_config + summary refreshed |
11+
**unchanged** | **int** | Tables still present with no schema change |
12+
**deleted** | **int** | Tables dropped externally → soft-deleted + embedding purged |
13+
14+
## Example
15+
16+
```python
17+
from ksapi.models.data_source_sync_response import DataSourceSyncResponse
18+
19+
# TODO update the JSON string below
20+
json = "{}"
21+
# create an instance of DataSourceSyncResponse from a JSON string
22+
data_source_sync_response_instance = DataSourceSyncResponse.from_json(json)
23+
# print the JSON string representation of the object
24+
print(DataSourceSyncResponse.to_json())
25+
26+
# convert the object into a dict
27+
data_source_sync_response_dict = data_source_sync_response_instance.to_dict()
28+
# create an instance of DataSourceSyncResponse from a dict
29+
data_source_sync_response_from_dict = DataSourceSyncResponse.from_dict(data_source_sync_response_dict)
30+
```
31+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32+
33+

sdks/_generated-python/DataSourceTableResponse.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Name | Type | Description | Notes
1616
**data_source_id** | **UUID** | |
1717
**data_source_schema_id** | **UUID** | PDO id of the parent schema this table belongs to |
1818
**table_name** | **str** | |
19-
**description** | **str** | |
2019
**column_config** | **List[Dict[str, object]]** | |
2120
**approval_state** | [**PathPartApprovalState**](PathPartApprovalState.md) | |
2221
**permissions** | [**ItemPermissions**](ItemPermissions.md) | |

0 commit comments

Comments
 (0)