@knowledge-stack/ksapi 1.127.0 → 1.128.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/README.md +3 -2
- package/dist/apis/FoldersApi.d.ts +29 -8
- package/dist/apis/FoldersApi.js +23 -2
- package/dist/esm/apis/FoldersApi.d.ts +29 -8
- package/dist/esm/apis/FoldersApi.js +23 -2
- package/dist/esm/models/ContentsSortOrder.d.ts +34 -0
- package/dist/esm/models/ContentsSortOrder.js +52 -0
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/models/ContentsSortOrder.d.ts +34 -0
- package/dist/models/ContentsSortOrder.js +60 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/docs/ContentsSortOrder.md +33 -0
- package/docs/FoldersApi.md +25 -4
- package/package.json +1 -1
- package/src/apis/FoldersApi.ts +59 -7
- package/src/models/ContentsSortOrder.ts +62 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -59,6 +59,7 @@ docs/ColumnConfig.md
|
|
|
59
59
|
docs/ColumnReference.md
|
|
60
60
|
docs/CommonFileExclusionReason.md
|
|
61
61
|
docs/ConnectionConfig.md
|
|
62
|
+
docs/ContentsSortOrder.md
|
|
62
63
|
docs/CreateApiConnectionRequest.md
|
|
63
64
|
docs/CreateApiKeyRequest.md
|
|
64
65
|
docs/CreateApiKeyResponse.md
|
|
@@ -448,6 +449,7 @@ src/models/ColumnConfig.ts
|
|
|
448
449
|
src/models/ColumnReference.ts
|
|
449
450
|
src/models/CommonFileExclusionReason.ts
|
|
450
451
|
src/models/ConnectionConfig.ts
|
|
452
|
+
src/models/ContentsSortOrder.ts
|
|
451
453
|
src/models/CreateApiConnectionRequest.ts
|
|
452
454
|
src/models/CreateApiKeyRequest.ts
|
|
453
455
|
src/models/CreateApiKeyResponse.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.
|
|
1
|
+
# @knowledge-stack/ksapi@1.128.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -316,6 +316,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
316
316
|
- [ColumnReference](docs/ColumnReference.md)
|
|
317
317
|
- [CommonFileExclusionReason](docs/CommonFileExclusionReason.md)
|
|
318
318
|
- [ConnectionConfig](docs/ConnectionConfig.md)
|
|
319
|
+
- [ContentsSortOrder](docs/ContentsSortOrder.md)
|
|
319
320
|
- [CreateApiConnectionRequest](docs/CreateApiConnectionRequest.md)
|
|
320
321
|
- [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
|
|
321
322
|
- [CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
|
|
@@ -616,7 +617,7 @@ and is automatically generated by the
|
|
|
616
617
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
617
618
|
|
|
618
619
|
- API version: `0.1.0`
|
|
619
|
-
- Package version: `1.
|
|
620
|
+
- Package version: `1.128.0`
|
|
620
621
|
- Generator version: `7.21.0`
|
|
621
622
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
622
623
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
13
|
+
import type { ContentsSortOrder, CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
14
14
|
export interface CreateFolderOperationRequest {
|
|
15
15
|
createFolderRequest: CreateFolderRequest;
|
|
16
16
|
}
|
|
@@ -28,13 +28,20 @@ export interface GetFolderRequest {
|
|
|
28
28
|
export interface ListFolderContentsRequest {
|
|
29
29
|
folderId: string;
|
|
30
30
|
maxDepth?: number;
|
|
31
|
-
sortOrder?:
|
|
31
|
+
sortOrder?: ContentsSortOrder;
|
|
32
|
+
sortDir?: SortDirection;
|
|
33
|
+
ownerId?: string | null;
|
|
34
|
+
nameLike?: string | null;
|
|
32
35
|
withTags?: boolean;
|
|
33
36
|
limit?: number;
|
|
34
37
|
offset?: number;
|
|
35
38
|
approvalState?: Array<PathPartApprovalState> | null;
|
|
36
39
|
includeTagIds?: Array<string> | null;
|
|
37
40
|
excludeTagIds?: Array<string> | null;
|
|
41
|
+
createdAfter?: Date | null;
|
|
42
|
+
createdBefore?: Date | null;
|
|
43
|
+
updatedAfter?: Date | null;
|
|
44
|
+
updatedBefore?: Date | null;
|
|
38
45
|
}
|
|
39
46
|
export interface ListFoldersRequest {
|
|
40
47
|
parentPathPartId?: string | null;
|
|
@@ -160,36 +167,50 @@ export interface FoldersApiInterface {
|
|
|
160
167
|
* Creates request options for listFolderContents without sending the request
|
|
161
168
|
* @param {string} folderId
|
|
162
169
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
163
|
-
* @param {
|
|
170
|
+
* @param {ContentsSortOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
171
|
+
* @param {SortDirection} [sortDir] Sort direction; overrides the column\'s natural default
|
|
172
|
+
* @param {string} [ownerId] Filter to items owned by this user
|
|
173
|
+
* @param {string} [nameLike] Case-insensitive substring filter on the item name
|
|
164
174
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
165
175
|
* @param {number} [limit] Number of items per page
|
|
166
176
|
* @param {number} [offset] Number of items to skip
|
|
167
177
|
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
168
178
|
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
169
179
|
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
180
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
181
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
182
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
183
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
170
184
|
* @throws {RequiredError}
|
|
171
185
|
* @memberof FoldersApiInterface
|
|
172
186
|
*/
|
|
173
187
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
174
188
|
/**
|
|
175
|
-
* 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.
|
|
189
|
+
* 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.
|
|
176
190
|
* @summary List Folder Contents Handler
|
|
177
191
|
* @param {string} folderId
|
|
178
192
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
179
|
-
* @param {
|
|
193
|
+
* @param {ContentsSortOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
194
|
+
* @param {SortDirection} [sortDir] Sort direction; overrides the column\'s natural default
|
|
195
|
+
* @param {string} [ownerId] Filter to items owned by this user
|
|
196
|
+
* @param {string} [nameLike] Case-insensitive substring filter on the item name
|
|
180
197
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
181
198
|
* @param {number} [limit] Number of items per page
|
|
182
199
|
* @param {number} [offset] Number of items to skip
|
|
183
200
|
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
184
201
|
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
185
202
|
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
203
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
204
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
205
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
206
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
186
207
|
* @param {*} [options] Override http request option.
|
|
187
208
|
* @throws {RequiredError}
|
|
188
209
|
* @memberof FoldersApiInterface
|
|
189
210
|
*/
|
|
190
211
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
191
212
|
/**
|
|
192
|
-
* 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.
|
|
213
|
+
* 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.
|
|
193
214
|
* List Folder Contents Handler
|
|
194
215
|
*/
|
|
195
216
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
|
@@ -354,12 +375,12 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
354
375
|
*/
|
|
355
376
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
356
377
|
/**
|
|
357
|
-
* 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.
|
|
378
|
+
* 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.
|
|
358
379
|
* List Folder Contents Handler
|
|
359
380
|
*/
|
|
360
381
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
361
382
|
/**
|
|
362
|
-
* 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.
|
|
383
|
+
* 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.
|
|
363
384
|
* List Folder Contents Handler
|
|
364
385
|
*/
|
|
365
386
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
package/dist/apis/FoldersApi.js
CHANGED
|
@@ -276,6 +276,15 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
276
276
|
if (requestParameters['sortOrder'] != null) {
|
|
277
277
|
queryParameters['sort_order'] = requestParameters['sortOrder'];
|
|
278
278
|
}
|
|
279
|
+
if (requestParameters['sortDir'] != null) {
|
|
280
|
+
queryParameters['sort_dir'] = requestParameters['sortDir'];
|
|
281
|
+
}
|
|
282
|
+
if (requestParameters['ownerId'] != null) {
|
|
283
|
+
queryParameters['owner_id'] = requestParameters['ownerId'];
|
|
284
|
+
}
|
|
285
|
+
if (requestParameters['nameLike'] != null) {
|
|
286
|
+
queryParameters['name_like'] = requestParameters['nameLike'];
|
|
287
|
+
}
|
|
279
288
|
if (requestParameters['withTags'] != null) {
|
|
280
289
|
queryParameters['with_tags'] = requestParameters['withTags'];
|
|
281
290
|
}
|
|
@@ -294,6 +303,18 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
294
303
|
if (requestParameters['excludeTagIds'] != null) {
|
|
295
304
|
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
296
305
|
}
|
|
306
|
+
if (requestParameters['createdAfter'] != null) {
|
|
307
|
+
queryParameters['created_after'] = requestParameters['createdAfter'].toISOString();
|
|
308
|
+
}
|
|
309
|
+
if (requestParameters['createdBefore'] != null) {
|
|
310
|
+
queryParameters['created_before'] = requestParameters['createdBefore'].toISOString();
|
|
311
|
+
}
|
|
312
|
+
if (requestParameters['updatedAfter'] != null) {
|
|
313
|
+
queryParameters['updated_after'] = requestParameters['updatedAfter'].toISOString();
|
|
314
|
+
}
|
|
315
|
+
if (requestParameters['updatedBefore'] != null) {
|
|
316
|
+
queryParameters['updated_before'] = requestParameters['updatedBefore'].toISOString();
|
|
317
|
+
}
|
|
297
318
|
const headerParameters = {};
|
|
298
319
|
if (this.configuration && this.configuration.accessToken) {
|
|
299
320
|
const token = this.configuration.accessToken;
|
|
@@ -313,7 +334,7 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
313
334
|
});
|
|
314
335
|
}
|
|
315
336
|
/**
|
|
316
|
-
* 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.
|
|
337
|
+
* 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.
|
|
317
338
|
* List Folder Contents Handler
|
|
318
339
|
*/
|
|
319
340
|
listFolderContentsRaw(requestParameters, initOverrides) {
|
|
@@ -324,7 +345,7 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
324
345
|
});
|
|
325
346
|
}
|
|
326
347
|
/**
|
|
327
|
-
* 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.
|
|
348
|
+
* 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.
|
|
328
349
|
* List Folder Contents Handler
|
|
329
350
|
*/
|
|
330
351
|
listFolderContents(requestParameters, initOverrides) {
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
13
|
+
import type { ContentsSortOrder, CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
14
14
|
export interface CreateFolderOperationRequest {
|
|
15
15
|
createFolderRequest: CreateFolderRequest;
|
|
16
16
|
}
|
|
@@ -28,13 +28,20 @@ export interface GetFolderRequest {
|
|
|
28
28
|
export interface ListFolderContentsRequest {
|
|
29
29
|
folderId: string;
|
|
30
30
|
maxDepth?: number;
|
|
31
|
-
sortOrder?:
|
|
31
|
+
sortOrder?: ContentsSortOrder;
|
|
32
|
+
sortDir?: SortDirection;
|
|
33
|
+
ownerId?: string | null;
|
|
34
|
+
nameLike?: string | null;
|
|
32
35
|
withTags?: boolean;
|
|
33
36
|
limit?: number;
|
|
34
37
|
offset?: number;
|
|
35
38
|
approvalState?: Array<PathPartApprovalState> | null;
|
|
36
39
|
includeTagIds?: Array<string> | null;
|
|
37
40
|
excludeTagIds?: Array<string> | null;
|
|
41
|
+
createdAfter?: Date | null;
|
|
42
|
+
createdBefore?: Date | null;
|
|
43
|
+
updatedAfter?: Date | null;
|
|
44
|
+
updatedBefore?: Date | null;
|
|
38
45
|
}
|
|
39
46
|
export interface ListFoldersRequest {
|
|
40
47
|
parentPathPartId?: string | null;
|
|
@@ -160,36 +167,50 @@ export interface FoldersApiInterface {
|
|
|
160
167
|
* Creates request options for listFolderContents without sending the request
|
|
161
168
|
* @param {string} folderId
|
|
162
169
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
163
|
-
* @param {
|
|
170
|
+
* @param {ContentsSortOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
171
|
+
* @param {SortDirection} [sortDir] Sort direction; overrides the column\'s natural default
|
|
172
|
+
* @param {string} [ownerId] Filter to items owned by this user
|
|
173
|
+
* @param {string} [nameLike] Case-insensitive substring filter on the item name
|
|
164
174
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
165
175
|
* @param {number} [limit] Number of items per page
|
|
166
176
|
* @param {number} [offset] Number of items to skip
|
|
167
177
|
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
168
178
|
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
169
179
|
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
180
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
181
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
182
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
183
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
170
184
|
* @throws {RequiredError}
|
|
171
185
|
* @memberof FoldersApiInterface
|
|
172
186
|
*/
|
|
173
187
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
174
188
|
/**
|
|
175
|
-
* 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.
|
|
189
|
+
* 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.
|
|
176
190
|
* @summary List Folder Contents Handler
|
|
177
191
|
* @param {string} folderId
|
|
178
192
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
179
|
-
* @param {
|
|
193
|
+
* @param {ContentsSortOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
194
|
+
* @param {SortDirection} [sortDir] Sort direction; overrides the column\'s natural default
|
|
195
|
+
* @param {string} [ownerId] Filter to items owned by this user
|
|
196
|
+
* @param {string} [nameLike] Case-insensitive substring filter on the item name
|
|
180
197
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
181
198
|
* @param {number} [limit] Number of items per page
|
|
182
199
|
* @param {number} [offset] Number of items to skip
|
|
183
200
|
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
184
201
|
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
185
202
|
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
203
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
204
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
205
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
206
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
186
207
|
* @param {*} [options] Override http request option.
|
|
187
208
|
* @throws {RequiredError}
|
|
188
209
|
* @memberof FoldersApiInterface
|
|
189
210
|
*/
|
|
190
211
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
191
212
|
/**
|
|
192
|
-
* 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.
|
|
213
|
+
* 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.
|
|
193
214
|
* List Folder Contents Handler
|
|
194
215
|
*/
|
|
195
216
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
|
@@ -354,12 +375,12 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
354
375
|
*/
|
|
355
376
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
356
377
|
/**
|
|
357
|
-
* 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.
|
|
378
|
+
* 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.
|
|
358
379
|
* List Folder Contents Handler
|
|
359
380
|
*/
|
|
360
381
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
361
382
|
/**
|
|
362
|
-
* 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.
|
|
383
|
+
* 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.
|
|
363
384
|
* List Folder Contents Handler
|
|
364
385
|
*/
|
|
365
386
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
|
@@ -240,6 +240,15 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
240
240
|
if (requestParameters['sortOrder'] != null) {
|
|
241
241
|
queryParameters['sort_order'] = requestParameters['sortOrder'];
|
|
242
242
|
}
|
|
243
|
+
if (requestParameters['sortDir'] != null) {
|
|
244
|
+
queryParameters['sort_dir'] = requestParameters['sortDir'];
|
|
245
|
+
}
|
|
246
|
+
if (requestParameters['ownerId'] != null) {
|
|
247
|
+
queryParameters['owner_id'] = requestParameters['ownerId'];
|
|
248
|
+
}
|
|
249
|
+
if (requestParameters['nameLike'] != null) {
|
|
250
|
+
queryParameters['name_like'] = requestParameters['nameLike'];
|
|
251
|
+
}
|
|
243
252
|
if (requestParameters['withTags'] != null) {
|
|
244
253
|
queryParameters['with_tags'] = requestParameters['withTags'];
|
|
245
254
|
}
|
|
@@ -258,6 +267,18 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
258
267
|
if (requestParameters['excludeTagIds'] != null) {
|
|
259
268
|
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
260
269
|
}
|
|
270
|
+
if (requestParameters['createdAfter'] != null) {
|
|
271
|
+
queryParameters['created_after'] = requestParameters['createdAfter'].toISOString();
|
|
272
|
+
}
|
|
273
|
+
if (requestParameters['createdBefore'] != null) {
|
|
274
|
+
queryParameters['created_before'] = requestParameters['createdBefore'].toISOString();
|
|
275
|
+
}
|
|
276
|
+
if (requestParameters['updatedAfter'] != null) {
|
|
277
|
+
queryParameters['updated_after'] = requestParameters['updatedAfter'].toISOString();
|
|
278
|
+
}
|
|
279
|
+
if (requestParameters['updatedBefore'] != null) {
|
|
280
|
+
queryParameters['updated_before'] = requestParameters['updatedBefore'].toISOString();
|
|
281
|
+
}
|
|
261
282
|
const headerParameters = {};
|
|
262
283
|
if (this.configuration && this.configuration.accessToken) {
|
|
263
284
|
const token = this.configuration.accessToken;
|
|
@@ -277,7 +298,7 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
277
298
|
});
|
|
278
299
|
}
|
|
279
300
|
/**
|
|
280
|
-
* 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.
|
|
301
|
+
* 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.
|
|
281
302
|
* List Folder Contents Handler
|
|
282
303
|
*/
|
|
283
304
|
listFolderContentsRaw(requestParameters, initOverrides) {
|
|
@@ -288,7 +309,7 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
288
309
|
});
|
|
289
310
|
}
|
|
290
311
|
/**
|
|
291
|
-
* 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.
|
|
312
|
+
* 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.
|
|
292
313
|
* List Folder Contents Handler
|
|
293
314
|
*/
|
|
294
315
|
listFolderContents(requestParameters, initOverrides) {
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Sort options for the folder-contents listing.
|
|
14
|
+
*
|
|
15
|
+
* Superset of the base :class:`PathOrder` columns plus ``STATUS``
|
|
16
|
+
* (``approval_state``). Kept separate from ``PathOrder`` so the extra columns
|
|
17
|
+
* do not leak onto ``/folders`` or ``/path-parts``, and only apply at depth 1.
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export declare const ContentsSortOrder: {
|
|
21
|
+
readonly Logical: "LOGICAL";
|
|
22
|
+
readonly Name: "NAME";
|
|
23
|
+
readonly UpdatedAt: "UPDATED_AT";
|
|
24
|
+
readonly CreatedAt: "CREATED_AT";
|
|
25
|
+
readonly Status: "STATUS";
|
|
26
|
+
readonly Owner: "OWNER";
|
|
27
|
+
readonly Tags: "TAGS";
|
|
28
|
+
};
|
|
29
|
+
export type ContentsSortOrder = typeof ContentsSortOrder[keyof typeof ContentsSortOrder];
|
|
30
|
+
export declare function instanceOfContentsSortOrder(value: any): boolean;
|
|
31
|
+
export declare function ContentsSortOrderFromJSON(json: any): ContentsSortOrder;
|
|
32
|
+
export declare function ContentsSortOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentsSortOrder;
|
|
33
|
+
export declare function ContentsSortOrderToJSON(value?: ContentsSortOrder | null): any;
|
|
34
|
+
export declare function ContentsSortOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentsSortOrder;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Sort options for the folder-contents listing.
|
|
16
|
+
*
|
|
17
|
+
* Superset of the base :class:`PathOrder` columns plus ``STATUS``
|
|
18
|
+
* (``approval_state``). Kept separate from ``PathOrder`` so the extra columns
|
|
19
|
+
* do not leak onto ``/folders`` or ``/path-parts``, and only apply at depth 1.
|
|
20
|
+
* @export
|
|
21
|
+
*/
|
|
22
|
+
export const ContentsSortOrder = {
|
|
23
|
+
Logical: 'LOGICAL',
|
|
24
|
+
Name: 'NAME',
|
|
25
|
+
UpdatedAt: 'UPDATED_AT',
|
|
26
|
+
CreatedAt: 'CREATED_AT',
|
|
27
|
+
Status: 'STATUS',
|
|
28
|
+
Owner: 'OWNER',
|
|
29
|
+
Tags: 'TAGS'
|
|
30
|
+
};
|
|
31
|
+
export function instanceOfContentsSortOrder(value) {
|
|
32
|
+
for (const key in ContentsSortOrder) {
|
|
33
|
+
if (Object.prototype.hasOwnProperty.call(ContentsSortOrder, key)) {
|
|
34
|
+
if (ContentsSortOrder[key] === value) {
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
return false;
|
|
40
|
+
}
|
|
41
|
+
export function ContentsSortOrderFromJSON(json) {
|
|
42
|
+
return ContentsSortOrderFromJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
export function ContentsSortOrderFromJSONTyped(json, ignoreDiscriminator) {
|
|
45
|
+
return json;
|
|
46
|
+
}
|
|
47
|
+
export function ContentsSortOrderToJSON(value) {
|
|
48
|
+
return value;
|
|
49
|
+
}
|
|
50
|
+
export function ContentsSortOrderToJSONTyped(value, ignoreDiscriminator) {
|
|
51
|
+
return value;
|
|
52
|
+
}
|
|
@@ -47,6 +47,7 @@ export * from './ColumnConfig';
|
|
|
47
47
|
export * from './ColumnReference';
|
|
48
48
|
export * from './CommonFileExclusionReason';
|
|
49
49
|
export * from './ConnectionConfig';
|
|
50
|
+
export * from './ContentsSortOrder';
|
|
50
51
|
export * from './CreateApiConnectionRequest';
|
|
51
52
|
export * from './CreateApiKeyRequest';
|
|
52
53
|
export * from './CreateApiKeyResponse';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -49,6 +49,7 @@ export * from './ColumnConfig';
|
|
|
49
49
|
export * from './ColumnReference';
|
|
50
50
|
export * from './CommonFileExclusionReason';
|
|
51
51
|
export * from './ConnectionConfig';
|
|
52
|
+
export * from './ContentsSortOrder';
|
|
52
53
|
export * from './CreateApiConnectionRequest';
|
|
53
54
|
export * from './CreateApiKeyRequest';
|
|
54
55
|
export * from './CreateApiKeyResponse';
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Sort options for the folder-contents listing.
|
|
14
|
+
*
|
|
15
|
+
* Superset of the base :class:`PathOrder` columns plus ``STATUS``
|
|
16
|
+
* (``approval_state``). Kept separate from ``PathOrder`` so the extra columns
|
|
17
|
+
* do not leak onto ``/folders`` or ``/path-parts``, and only apply at depth 1.
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export declare const ContentsSortOrder: {
|
|
21
|
+
readonly Logical: "LOGICAL";
|
|
22
|
+
readonly Name: "NAME";
|
|
23
|
+
readonly UpdatedAt: "UPDATED_AT";
|
|
24
|
+
readonly CreatedAt: "CREATED_AT";
|
|
25
|
+
readonly Status: "STATUS";
|
|
26
|
+
readonly Owner: "OWNER";
|
|
27
|
+
readonly Tags: "TAGS";
|
|
28
|
+
};
|
|
29
|
+
export type ContentsSortOrder = typeof ContentsSortOrder[keyof typeof ContentsSortOrder];
|
|
30
|
+
export declare function instanceOfContentsSortOrder(value: any): boolean;
|
|
31
|
+
export declare function ContentsSortOrderFromJSON(json: any): ContentsSortOrder;
|
|
32
|
+
export declare function ContentsSortOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentsSortOrder;
|
|
33
|
+
export declare function ContentsSortOrderToJSON(value?: ContentsSortOrder | null): any;
|
|
34
|
+
export declare function ContentsSortOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentsSortOrder;
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.ContentsSortOrder = void 0;
|
|
17
|
+
exports.instanceOfContentsSortOrder = instanceOfContentsSortOrder;
|
|
18
|
+
exports.ContentsSortOrderFromJSON = ContentsSortOrderFromJSON;
|
|
19
|
+
exports.ContentsSortOrderFromJSONTyped = ContentsSortOrderFromJSONTyped;
|
|
20
|
+
exports.ContentsSortOrderToJSON = ContentsSortOrderToJSON;
|
|
21
|
+
exports.ContentsSortOrderToJSONTyped = ContentsSortOrderToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* Sort options for the folder-contents listing.
|
|
24
|
+
*
|
|
25
|
+
* Superset of the base :class:`PathOrder` columns plus ``STATUS``
|
|
26
|
+
* (``approval_state``). Kept separate from ``PathOrder`` so the extra columns
|
|
27
|
+
* do not leak onto ``/folders`` or ``/path-parts``, and only apply at depth 1.
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
exports.ContentsSortOrder = {
|
|
31
|
+
Logical: 'LOGICAL',
|
|
32
|
+
Name: 'NAME',
|
|
33
|
+
UpdatedAt: 'UPDATED_AT',
|
|
34
|
+
CreatedAt: 'CREATED_AT',
|
|
35
|
+
Status: 'STATUS',
|
|
36
|
+
Owner: 'OWNER',
|
|
37
|
+
Tags: 'TAGS'
|
|
38
|
+
};
|
|
39
|
+
function instanceOfContentsSortOrder(value) {
|
|
40
|
+
for (const key in exports.ContentsSortOrder) {
|
|
41
|
+
if (Object.prototype.hasOwnProperty.call(exports.ContentsSortOrder, key)) {
|
|
42
|
+
if (exports.ContentsSortOrder[key] === value) {
|
|
43
|
+
return true;
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
return false;
|
|
48
|
+
}
|
|
49
|
+
function ContentsSortOrderFromJSON(json) {
|
|
50
|
+
return ContentsSortOrderFromJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
function ContentsSortOrderFromJSONTyped(json, ignoreDiscriminator) {
|
|
53
|
+
return json;
|
|
54
|
+
}
|
|
55
|
+
function ContentsSortOrderToJSON(value) {
|
|
56
|
+
return value;
|
|
57
|
+
}
|
|
58
|
+
function ContentsSortOrderToJSONTyped(value, ignoreDiscriminator) {
|
|
59
|
+
return value;
|
|
60
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -47,6 +47,7 @@ export * from './ColumnConfig';
|
|
|
47
47
|
export * from './ColumnReference';
|
|
48
48
|
export * from './CommonFileExclusionReason';
|
|
49
49
|
export * from './ConnectionConfig';
|
|
50
|
+
export * from './ContentsSortOrder';
|
|
50
51
|
export * from './CreateApiConnectionRequest';
|
|
51
52
|
export * from './CreateApiKeyRequest';
|
|
52
53
|
export * from './CreateApiKeyResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -65,6 +65,7 @@ __exportStar(require("./ColumnConfig"), exports);
|
|
|
65
65
|
__exportStar(require("./ColumnReference"), exports);
|
|
66
66
|
__exportStar(require("./CommonFileExclusionReason"), exports);
|
|
67
67
|
__exportStar(require("./ConnectionConfig"), exports);
|
|
68
|
+
__exportStar(require("./ContentsSortOrder"), exports);
|
|
68
69
|
__exportStar(require("./CreateApiConnectionRequest"), exports);
|
|
69
70
|
__exportStar(require("./CreateApiKeyRequest"), exports);
|
|
70
71
|
__exportStar(require("./CreateApiKeyResponse"), exports);
|
|
@@ -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
|
+
|
package/docs/FoldersApi.md
CHANGED
|
@@ -321,11 +321,11 @@ example().catch(console.error);
|
|
|
321
321
|
|
|
322
322
|
## listFolderContents
|
|
323
323
|
|
|
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)
|
|
325
325
|
|
|
326
326
|
List Folder Contents Handler
|
|
327
327
|
|
|
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.
|
|
329
329
|
|
|
330
330
|
### Example
|
|
331
331
|
|
|
@@ -351,8 +351,14 @@ async function example() {
|
|
|
351
351
|
folderId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
352
352
|
// number | Maximum depth to traverse (1=direct children, default: 1) (optional)
|
|
353
353
|
maxDepth: 56,
|
|
354
|
-
//
|
|
354
|
+
// ContentsSortOrder | Sort order for results (default: LOGICAL) (optional)
|
|
355
355
|
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,
|
|
356
362
|
// boolean | Include tag IDs for each item (default: false) (optional)
|
|
357
363
|
withTags: true,
|
|
358
364
|
// number | Number of items per page (optional)
|
|
@@ -365,6 +371,14 @@ async function example() {
|
|
|
365
371
|
includeTagIds: ...,
|
|
366
372
|
// 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)
|
|
367
373
|
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,
|
|
368
382
|
} satisfies ListFolderContentsRequest;
|
|
369
383
|
|
|
370
384
|
try {
|
|
@@ -386,13 +400,20 @@ example().catch(console.error);
|
|
|
386
400
|
|------------- | ------------- | ------------- | -------------|
|
|
387
401
|
| **folderId** | `string` | | [Defaults to `undefined`] |
|
|
388
402
|
| **maxDepth** | `number` | Maximum depth to traverse (1=direct children, default: 1) | [Optional] [Defaults to `1`] |
|
|
389
|
-
| **sortOrder** | `
|
|
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\'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`] |
|
|
390
407
|
| **withTags** | `boolean` | Include tag IDs for each item (default: false) | [Optional] [Defaults to `false`] |
|
|
391
408
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
392
409
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
393
410
|
| **approvalState** | `Array<PathPartApprovalState>` | Keep only items in these approval states (repeatable): not_required, pending, approved. | [Optional] |
|
|
394
411
|
| **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] |
|
|
395
412
|
| **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`] |
|
|
396
417
|
|
|
397
418
|
### Return type
|
|
398
419
|
|
package/package.json
CHANGED
package/src/apis/FoldersApi.ts
CHANGED
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
import * as runtime from '../runtime';
|
|
17
17
|
import type {
|
|
18
|
+
ContentsSortOrder,
|
|
18
19
|
CreateFolderRequest,
|
|
19
20
|
ErrorResponse,
|
|
20
21
|
FolderAction,
|
|
@@ -31,6 +32,8 @@ import type {
|
|
|
31
32
|
UpdateFolderRequest,
|
|
32
33
|
} from '../models/index';
|
|
33
34
|
import {
|
|
35
|
+
ContentsSortOrderFromJSON,
|
|
36
|
+
ContentsSortOrderToJSON,
|
|
34
37
|
CreateFolderRequestFromJSON,
|
|
35
38
|
CreateFolderRequestToJSON,
|
|
36
39
|
ErrorResponseFromJSON,
|
|
@@ -82,13 +85,20 @@ export interface GetFolderRequest {
|
|
|
82
85
|
export interface ListFolderContentsRequest {
|
|
83
86
|
folderId: string;
|
|
84
87
|
maxDepth?: number;
|
|
85
|
-
sortOrder?:
|
|
88
|
+
sortOrder?: ContentsSortOrder;
|
|
89
|
+
sortDir?: SortDirection;
|
|
90
|
+
ownerId?: string | null;
|
|
91
|
+
nameLike?: string | null;
|
|
86
92
|
withTags?: boolean;
|
|
87
93
|
limit?: number;
|
|
88
94
|
offset?: number;
|
|
89
95
|
approvalState?: Array<PathPartApprovalState> | null;
|
|
90
96
|
includeTagIds?: Array<string> | null;
|
|
91
97
|
excludeTagIds?: Array<string> | null;
|
|
98
|
+
createdAfter?: Date | null;
|
|
99
|
+
createdBefore?: Date | null;
|
|
100
|
+
updatedAfter?: Date | null;
|
|
101
|
+
updatedBefore?: Date | null;
|
|
92
102
|
}
|
|
93
103
|
|
|
94
104
|
export interface ListFoldersRequest {
|
|
@@ -230,30 +240,44 @@ export interface FoldersApiInterface {
|
|
|
230
240
|
* Creates request options for listFolderContents without sending the request
|
|
231
241
|
* @param {string} folderId
|
|
232
242
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
233
|
-
* @param {
|
|
243
|
+
* @param {ContentsSortOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
244
|
+
* @param {SortDirection} [sortDir] Sort direction; overrides the column\'s natural default
|
|
245
|
+
* @param {string} [ownerId] Filter to items owned by this user
|
|
246
|
+
* @param {string} [nameLike] Case-insensitive substring filter on the item name
|
|
234
247
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
235
248
|
* @param {number} [limit] Number of items per page
|
|
236
249
|
* @param {number} [offset] Number of items to skip
|
|
237
250
|
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
238
251
|
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
239
252
|
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
253
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
254
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
255
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
256
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
240
257
|
* @throws {RequiredError}
|
|
241
258
|
* @memberof FoldersApiInterface
|
|
242
259
|
*/
|
|
243
260
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
244
261
|
|
|
245
262
|
/**
|
|
246
|
-
* 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.
|
|
263
|
+
* 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.
|
|
247
264
|
* @summary List Folder Contents Handler
|
|
248
265
|
* @param {string} folderId
|
|
249
266
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
250
|
-
* @param {
|
|
267
|
+
* @param {ContentsSortOrder} [sortOrder] Sort order for results (default: LOGICAL)
|
|
268
|
+
* @param {SortDirection} [sortDir] Sort direction; overrides the column\'s natural default
|
|
269
|
+
* @param {string} [ownerId] Filter to items owned by this user
|
|
270
|
+
* @param {string} [nameLike] Case-insensitive substring filter on the item name
|
|
251
271
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
252
272
|
* @param {number} [limit] Number of items per page
|
|
253
273
|
* @param {number} [offset] Number of items to skip
|
|
254
274
|
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
255
275
|
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
256
276
|
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
277
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
278
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
279
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
280
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
257
281
|
* @param {*} [options] Override http request option.
|
|
258
282
|
* @throws {RequiredError}
|
|
259
283
|
* @memberof FoldersApiInterface
|
|
@@ -261,7 +285,7 @@ export interface FoldersApiInterface {
|
|
|
261
285
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
262
286
|
|
|
263
287
|
/**
|
|
264
|
-
* 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.
|
|
288
|
+
* 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.
|
|
265
289
|
* List Folder Contents Handler
|
|
266
290
|
*/
|
|
267
291
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
|
@@ -634,6 +658,18 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
634
658
|
queryParameters['sort_order'] = requestParameters['sortOrder'];
|
|
635
659
|
}
|
|
636
660
|
|
|
661
|
+
if (requestParameters['sortDir'] != null) {
|
|
662
|
+
queryParameters['sort_dir'] = requestParameters['sortDir'];
|
|
663
|
+
}
|
|
664
|
+
|
|
665
|
+
if (requestParameters['ownerId'] != null) {
|
|
666
|
+
queryParameters['owner_id'] = requestParameters['ownerId'];
|
|
667
|
+
}
|
|
668
|
+
|
|
669
|
+
if (requestParameters['nameLike'] != null) {
|
|
670
|
+
queryParameters['name_like'] = requestParameters['nameLike'];
|
|
671
|
+
}
|
|
672
|
+
|
|
637
673
|
if (requestParameters['withTags'] != null) {
|
|
638
674
|
queryParameters['with_tags'] = requestParameters['withTags'];
|
|
639
675
|
}
|
|
@@ -658,6 +694,22 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
658
694
|
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
659
695
|
}
|
|
660
696
|
|
|
697
|
+
if (requestParameters['createdAfter'] != null) {
|
|
698
|
+
queryParameters['created_after'] = (requestParameters['createdAfter'] as any).toISOString();
|
|
699
|
+
}
|
|
700
|
+
|
|
701
|
+
if (requestParameters['createdBefore'] != null) {
|
|
702
|
+
queryParameters['created_before'] = (requestParameters['createdBefore'] as any).toISOString();
|
|
703
|
+
}
|
|
704
|
+
|
|
705
|
+
if (requestParameters['updatedAfter'] != null) {
|
|
706
|
+
queryParameters['updated_after'] = (requestParameters['updatedAfter'] as any).toISOString();
|
|
707
|
+
}
|
|
708
|
+
|
|
709
|
+
if (requestParameters['updatedBefore'] != null) {
|
|
710
|
+
queryParameters['updated_before'] = (requestParameters['updatedBefore'] as any).toISOString();
|
|
711
|
+
}
|
|
712
|
+
|
|
661
713
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
662
714
|
|
|
663
715
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -681,7 +733,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
681
733
|
}
|
|
682
734
|
|
|
683
735
|
/**
|
|
684
|
-
* 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.
|
|
736
|
+
* 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.
|
|
685
737
|
* List Folder Contents Handler
|
|
686
738
|
*/
|
|
687
739
|
async listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>> {
|
|
@@ -692,7 +744,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
692
744
|
}
|
|
693
745
|
|
|
694
746
|
/**
|
|
695
|
-
* 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.
|
|
747
|
+
* 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.
|
|
696
748
|
* List Folder Contents Handler
|
|
697
749
|
*/
|
|
698
750
|
async listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator> {
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Sort options for the folder-contents listing.
|
|
18
|
+
*
|
|
19
|
+
* Superset of the base :class:`PathOrder` columns plus ``STATUS``
|
|
20
|
+
* (``approval_state``). Kept separate from ``PathOrder`` so the extra columns
|
|
21
|
+
* do not leak onto ``/folders`` or ``/path-parts``, and only apply at depth 1.
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export const ContentsSortOrder = {
|
|
25
|
+
Logical: 'LOGICAL',
|
|
26
|
+
Name: 'NAME',
|
|
27
|
+
UpdatedAt: 'UPDATED_AT',
|
|
28
|
+
CreatedAt: 'CREATED_AT',
|
|
29
|
+
Status: 'STATUS',
|
|
30
|
+
Owner: 'OWNER',
|
|
31
|
+
Tags: 'TAGS'
|
|
32
|
+
} as const;
|
|
33
|
+
export type ContentsSortOrder = typeof ContentsSortOrder[keyof typeof ContentsSortOrder];
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
export function instanceOfContentsSortOrder(value: any): boolean {
|
|
37
|
+
for (const key in ContentsSortOrder) {
|
|
38
|
+
if (Object.prototype.hasOwnProperty.call(ContentsSortOrder, key)) {
|
|
39
|
+
if (ContentsSortOrder[key as keyof typeof ContentsSortOrder] === value) {
|
|
40
|
+
return true;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
return false;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export function ContentsSortOrderFromJSON(json: any): ContentsSortOrder {
|
|
48
|
+
return ContentsSortOrderFromJSONTyped(json, false);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function ContentsSortOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentsSortOrder {
|
|
52
|
+
return json as ContentsSortOrder;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export function ContentsSortOrderToJSON(value?: ContentsSortOrder | null): any {
|
|
56
|
+
return value as any;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function ContentsSortOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentsSortOrder {
|
|
60
|
+
return value as ContentsSortOrder;
|
|
61
|
+
}
|
|
62
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -49,6 +49,7 @@ export * from './ColumnConfig';
|
|
|
49
49
|
export * from './ColumnReference';
|
|
50
50
|
export * from './CommonFileExclusionReason';
|
|
51
51
|
export * from './ConnectionConfig';
|
|
52
|
+
export * from './ContentsSortOrder';
|
|
52
53
|
export * from './CreateApiConnectionRequest';
|
|
53
54
|
export * from './CreateApiKeyRequest';
|
|
54
55
|
export * from './CreateApiKeyResponse';
|