Skip to content

Commit 418ca5f

Browse files
author
ks-docs-sync[bot]
committed
chore(sync): pull latest SDK docs (2026-07-08)
1 parent 393a545 commit 418ca5f

9 files changed

Lines changed: 113 additions & 15 deletions

File tree

sdks/_generated-python/COMMIT

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
677e0276957386ee44e90efa674ede903be15ae7
1+
dfdfd6b3b939dfa82f6dcfa66bff55e2a7aa0833
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# ContentsSortOrder
2+
3+
Sort options for the folder-contents listing. Superset of the base :class:`PathOrder` columns plus ``STATUS`` (``approval_state``). Kept separate from ``PathOrder`` so the extra columns do not leak onto ``/folders`` or ``/path-parts``, and only apply at depth 1.
4+
5+
## Enum
6+
7+
* `LOGICAL` (value: `'LOGICAL'`)
8+
9+
* `NAME` (value: `'NAME'`)
10+
11+
* `UPDATED_AT` (value: `'UPDATED_AT'`)
12+
13+
* `CREATED_AT` (value: `'CREATED_AT'`)
14+
15+
* `STATUS` (value: `'STATUS'`)
16+
17+
* `OWNER` (value: `'OWNER'`)
18+
19+
* `TAGS` (value: `'TAGS'`)
20+
21+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
22+
23+

sdks/_generated-python/FoldersApi.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ Name | Type | Description | Notes
370370
[[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)
371371

372372
# **list_folder_contents**
373-
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator list_folder_contents(folder_id, max_depth=max_depth, sort_order=sort_order, with_tags=with_tags, limit=limit, offset=offset, approval_state=approval_state, include_tag_ids=include_tag_ids, exclude_tag_ids=exclude_tag_ids)
373+
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator list_folder_contents(folder_id, max_depth=max_depth, sort_order=sort_order, sort_dir=sort_dir, owner_id=owner_id, name_like=name_like, with_tags=with_tags, limit=limit, offset=offset, approval_state=approval_state, include_tag_ids=include_tag_ids, exclude_tag_ids=exclude_tag_ids, created_after=created_after, created_before=created_before, updated_after=updated_after, updated_before=updated_before)
374374
375375
List Folder Contents Handler
376376

@@ -385,6 +385,11 @@ When with_tags=true, each item includes a tags field with the full tag objects.
385385
result at the path_part layer: approval state on the item, tags matched by
386386
self-or-ancestor inheritance (include = OR, exclude wins).
387387

388+
``sort_dir``, ``owner_id``, ``name_like``, the created_at/updated_at range
389+
filters, and the STATUS/OWNER/TAGS sorts apply to the direct-children
390+
listing only (``max_depth=1``); combining them with a deeper traversal is a
391+
400.
392+
388393
This is the preferred way to list folder contents when you need document metadata.
389394
For generic path traversal of folders only, use GET /path-parts.
390395

@@ -395,9 +400,10 @@ For generic path traversal of folders only, use GET /path-parts.
395400

396401
```python
397402
import ksapi
403+
from ksapi.models.contents_sort_order import ContentsSortOrder
398404
from ksapi.models.paginated_response_annotated_union_folder_response_document_response_workflow_definition_response_workflow_run_response_data_source_response_data_source_schema_response_data_source_table_response_api_connection_response_discriminator import PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator
399-
from ksapi.models.path_order import PathOrder
400405
from ksapi.models.path_part_approval_state import PathPartApprovalState
406+
from ksapi.models.sort_direction import SortDirection
401407
from ksapi.rest import ApiException
402408
from pprint import pprint
403409

@@ -429,17 +435,24 @@ with ksapi.ApiClient(configuration) as api_client:
429435
api_instance = ksapi.FoldersApi(api_client)
430436
folder_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
431437
max_depth = 1 # int | Maximum depth to traverse (1=direct children, default: 1) (optional) (default to 1)
432-
sort_order = ksapi.PathOrder() # PathOrder | Sort order for results (default: LOGICAL) (optional)
438+
sort_order = ksapi.ContentsSortOrder() # ContentsSortOrder | Sort order for results (default: LOGICAL) (optional)
439+
sort_dir = ksapi.SortDirection() # SortDirection | Sort direction; overrides the column's natural default (optional)
440+
owner_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter to items owned by this user (optional)
441+
name_like = 'name_like_example' # str | Case-insensitive substring filter on the item name (optional)
433442
with_tags = False # bool | Include tag IDs for each item (default: false) (optional) (default to False)
434443
limit = 20 # int | Number of items per page (optional) (default to 20)
435444
offset = 0 # int | Number of items to skip (optional) (default to 0)
436445
approval_state = [ksapi.PathPartApprovalState()] # List[PathPartApprovalState] | Keep only items in these approval states (repeatable): not_required, pending, approved. (optional)
437446
include_tag_ids = None # List[UUID] | Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance). (optional)
438447
exclude_tag_ids = None # List[UUID] | Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids. (optional)
448+
created_after = '2013-10-20T19:20:30+01:00' # datetime | Only items created at or after this timestamp (inclusive) (optional)
449+
created_before = '2013-10-20T19:20:30+01:00' # datetime | Only items created strictly before this timestamp (optional)
450+
updated_after = '2013-10-20T19:20:30+01:00' # datetime | Only items updated at or after this timestamp (inclusive) (optional)
451+
updated_before = '2013-10-20T19:20:30+01:00' # datetime | Only items updated strictly before this timestamp (optional)
439452

440453
try:
441454
# List Folder Contents Handler
442-
api_response = api_instance.list_folder_contents(folder_id, max_depth=max_depth, sort_order=sort_order, with_tags=with_tags, limit=limit, offset=offset, approval_state=approval_state, include_tag_ids=include_tag_ids, exclude_tag_ids=exclude_tag_ids)
455+
api_response = api_instance.list_folder_contents(folder_id, max_depth=max_depth, sort_order=sort_order, sort_dir=sort_dir, owner_id=owner_id, name_like=name_like, with_tags=with_tags, limit=limit, offset=offset, approval_state=approval_state, include_tag_ids=include_tag_ids, exclude_tag_ids=exclude_tag_ids, created_after=created_after, created_before=created_before, updated_after=updated_after, updated_before=updated_before)
443456
print("The response of FoldersApi->list_folder_contents:\n")
444457
pprint(api_response)
445458
except Exception as e:
@@ -455,13 +468,20 @@ Name | Type | Description | Notes
455468
------------- | ------------- | ------------- | -------------
456469
**folder_id** | **UUID**| |
457470
**max_depth** | **int**| Maximum depth to traverse (1=direct children, default: 1) | [optional] [default to 1]
458-
**sort_order** | [**PathOrder**](.md)| Sort order for results (default: LOGICAL) | [optional]
471+
**sort_order** | [**ContentsSortOrder**](.md)| Sort order for results (default: LOGICAL) | [optional]
472+
**sort_dir** | [**SortDirection**](.md)| Sort direction; overrides the column's natural default | [optional]
473+
**owner_id** | **UUID**| Filter to items owned by this user | [optional]
474+
**name_like** | **str**| Case-insensitive substring filter on the item name | [optional]
459475
**with_tags** | **bool**| Include tag IDs for each item (default: false) | [optional] [default to False]
460476
**limit** | **int**| Number of items per page | [optional] [default to 20]
461477
**offset** | **int**| Number of items to skip | [optional] [default to 0]
462478
**approval_state** | [**List[PathPartApprovalState]**](PathPartApprovalState.md)| Keep only items in these approval states (repeatable): not_required, pending, approved. | [optional]
463479
**include_tag_ids** | [**List[UUID]**](UUID.md)| Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance). | [optional]
464480
**exclude_tag_ids** | [**List[UUID]**](UUID.md)| Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids. | [optional]
481+
**created_after** | **datetime**| Only items created at or after this timestamp (inclusive) | [optional]
482+
**created_before** | **datetime**| Only items created strictly before this timestamp | [optional]
483+
**updated_after** | **datetime**| Only items updated at or after this timestamp (inclusive) | [optional]
484+
**updated_before** | **datetime**| Only items updated strictly before this timestamp | [optional]
465485

466486
### Return type
467487

sdks/_generated-python/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version = "1.127.0"
1+
version = "1.128.0"

sdks/_generated-ts/COMMIT

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2a687ad69a5fafa5afb8a0649ec07cc41be488c2
1+
753035d25b84ce557029e56914b0bd7e666c6f24
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
2+
# ContentsSortOrder
3+
4+
Sort options for the folder-contents listing. Superset of the base :class:`PathOrder` columns plus ``STATUS`` (``approval_state``). Kept separate from ``PathOrder`` so the extra columns do not leak onto ``/folders`` or ``/path-parts``, and only apply at depth 1.
5+
6+
## Properties
7+
8+
Name | Type
9+
------------ | -------------
10+
11+
## Example
12+
13+
```typescript
14+
import type { ContentsSortOrder } from '@knowledge-stack/ksapi'
15+
16+
// TODO: Update the object below with actual values
17+
const example = {
18+
} satisfies ContentsSortOrder
19+
20+
console.log(example)
21+
22+
// Convert the instance to a JSON string
23+
const exampleJSON: string = JSON.stringify(example)
24+
console.log(exampleJSON)
25+
26+
// Parse the JSON string back to an object
27+
const exampleParsed = JSON.parse(exampleJSON) as ContentsSortOrder
28+
console.log(exampleParsed)
29+
```
30+
31+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
32+
33+

sdks/_generated-ts/FoldersApi.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -321,11 +321,11 @@ example().catch(console.error);
321321

322322
## listFolderContents
323323

324-
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset, approvalState, includeTagIds, excludeTagIds)
324+
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, sortDir, ownerId, nameLike, withTags, limit, offset, approvalState, includeTagIds, excludeTagIds, createdAfter, createdBefore, updatedAfter, updatedBefore)
325325
326326
List Folder Contents Handler
327327

328-
List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
328+
List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). ``sort_dir``, ``owner_id``, ``name_like``, the created_at/updated_at range filters, and the STATUS/OWNER/TAGS sorts apply to the direct-children listing only (``max_depth=1``); combining them with a deeper traversal is a 400. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
329329

330330
### Example
331331

@@ -351,8 +351,14 @@ async function example() {
351351
folderId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
352352
// number | Maximum depth to traverse (1=direct children, default: 1) (optional)
353353
maxDepth: 56,
354-
// PathOrder | Sort order for results (default: LOGICAL) (optional)
354+
// ContentsSortOrder | Sort order for results (default: LOGICAL) (optional)
355355
sortOrder: ...,
356+
// SortDirection | Sort direction; overrides the column\'s natural default (optional)
357+
sortDir: ...,
358+
// string | Filter to items owned by this user (optional)
359+
ownerId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
360+
// string | Case-insensitive substring filter on the item name (optional)
361+
nameLike: nameLike_example,
356362
// boolean | Include tag IDs for each item (default: false) (optional)
357363
withTags: true,
358364
// number | Number of items per page (optional)
@@ -365,6 +371,14 @@ async function example() {
365371
includeTagIds: ...,
366372
// Array<string> | Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids. (optional)
367373
excludeTagIds: ...,
374+
// Date | Only items created at or after this timestamp (inclusive) (optional)
375+
createdAfter: 2013-10-20T19:20:30+01:00,
376+
// Date | Only items created strictly before this timestamp (optional)
377+
createdBefore: 2013-10-20T19:20:30+01:00,
378+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
379+
updatedAfter: 2013-10-20T19:20:30+01:00,
380+
// Date | Only items updated strictly before this timestamp (optional)
381+
updatedBefore: 2013-10-20T19:20:30+01:00,
368382
} satisfies ListFolderContentsRequest;
369383

370384
try {
@@ -386,13 +400,20 @@ example().catch(console.error);
386400
|------------- | ------------- | ------------- | -------------|
387401
| **folderId** | `string` | | [Defaults to `undefined`] |
388402
| **maxDepth** | `number` | Maximum depth to traverse (1&#x3D;direct children, default: 1) | [Optional] [Defaults to `1`] |
389-
| **sortOrder** | `PathOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
403+
| **sortOrder** | `ContentsSortOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT, STATUS, OWNER, TAGS] |
404+
| **sortDir** | `SortDirection` | Sort direction; overrides the column\&#39;s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
405+
| **ownerId** | `string` | Filter to items owned by this user | [Optional] [Defaults to `undefined`] |
406+
| **nameLike** | `string` | Case-insensitive substring filter on the item name | [Optional] [Defaults to `undefined`] |
390407
| **withTags** | `boolean` | Include tag IDs for each item (default: false) | [Optional] [Defaults to `false`] |
391408
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
392409
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
393410
| **approvalState** | `Array<PathPartApprovalState>` | Keep only items in these approval states (repeatable): not_required, pending, approved. | [Optional] |
394411
| **includeTagIds** | `Array<string>` | Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance). | [Optional] |
395412
| **excludeTagIds** | `Array<string>` | Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids. | [Optional] |
413+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
414+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
415+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
416+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
396417

397418
### Return type
398419

sdks/_generated-ts/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Below this line is auto-generated reference content.
5454

5555
---
5656

57-
# @knowledge-stack/ksapi@1.127.0
57+
# @knowledge-stack/ksapi@1.128.0
5858

5959
A TypeScript SDK client for the localhost API.
6060

@@ -372,6 +372,7 @@ All URIs are relative to *http://localhost:8000*
372372
- [ColumnReference](docs/ColumnReference.md)
373373
- [CommonFileExclusionReason](docs/CommonFileExclusionReason.md)
374374
- [ConnectionConfig](docs/ConnectionConfig.md)
375+
- [ContentsSortOrder](docs/ContentsSortOrder.md)
375376
- [CreateApiConnectionRequest](docs/CreateApiConnectionRequest.md)
376377
- [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
377378
- [CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
@@ -672,7 +673,7 @@ and is automatically generated by the
672673
[OpenAPI Generator](https://openapi-generator.tech) project:
673674

674675
- API version: `0.1.0`
675-
- Package version: `1.127.0`
676+
- Package version: `1.128.0`
676677
- Generator version: `7.21.0`
677678
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
678679

sdks/_generated-ts/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"version": "1.127.0",
1+
"version": "1.128.0",

0 commit comments

Comments
 (0)