@knowledge-stack/ksapi 2.12.1 → 2.14.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/README.md +2 -2
- package/dist/apis/FoldersApi.d.ts +29 -5
- package/dist/apis/FoldersApi.js +26 -2
- package/dist/esm/apis/FoldersApi.d.ts +29 -5
- package/dist/esm/apis/FoldersApi.js +26 -2
- package/dist/esm/models/ResolvedReferenceInput.d.ts +7 -0
- package/dist/esm/models/ResolvedReferenceInput.js +3 -0
- package/dist/esm/models/ResolvedReferenceOutput.d.ts +7 -0
- package/dist/esm/models/ResolvedReferenceOutput.js +3 -0
- package/dist/models/ResolvedReferenceInput.d.ts +7 -0
- package/dist/models/ResolvedReferenceInput.js +3 -0
- package/dist/models/ResolvedReferenceOutput.d.ts +7 -0
- package/dist/models/ResolvedReferenceOutput.js +3 -0
- package/docs/FoldersApi.md +26 -2
- package/docs/ResolvedReferenceInput.md +2 -0
- package/docs/ResolvedReferenceOutput.md +2 -0
- package/package.json +1 -1
- package/src/apis/FoldersApi.ts +63 -4
- package/src/models/ResolvedReferenceInput.ts +15 -0
- package/src/models/ResolvedReferenceOutput.ts +18 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@2.
|
|
1
|
+
# @knowledge-stack/ksapi@2.14.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -725,7 +725,7 @@ and is automatically generated by the
|
|
|
725
725
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
726
726
|
|
|
727
727
|
- API version: `0.1.0`
|
|
728
|
-
- Package version: `2.
|
|
728
|
+
- Package version: `2.14.0`
|
|
729
729
|
- Generator version: `7.21.0`
|
|
730
730
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
731
731
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { ContentsSortOrder, CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchItemsResponse, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
13
|
+
import type { ContentsSortOrder, CreateFolderRequest, DocumentType, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchItemsResponse, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
14
14
|
export interface CreateFolderOperationRequest {
|
|
15
15
|
createFolderRequest: CreateFolderRequest;
|
|
16
16
|
}
|
|
@@ -64,6 +64,14 @@ export interface SearchItemsRequest {
|
|
|
64
64
|
parentPathPartId?: string | null;
|
|
65
65
|
limit?: number;
|
|
66
66
|
offset?: number;
|
|
67
|
+
documentType?: Array<DocumentType>;
|
|
68
|
+
ownerId?: string | null;
|
|
69
|
+
createdAfter?: Date | null;
|
|
70
|
+
createdBefore?: Date | null;
|
|
71
|
+
updatedAfter?: Date | null;
|
|
72
|
+
updatedBefore?: Date | null;
|
|
73
|
+
includeTagIds?: Array<string> | null;
|
|
74
|
+
excludeTagIds?: Array<string> | null;
|
|
67
75
|
}
|
|
68
76
|
export interface UpdateFolderOperationRequest {
|
|
69
77
|
folderId: string;
|
|
@@ -264,12 +272,20 @@ export interface FoldersApiInterface {
|
|
|
264
272
|
* @param {string} [parentPathPartId] Scope search to descendants of this folder\'s path part
|
|
265
273
|
* @param {number} [limit] Number of items per page
|
|
266
274
|
* @param {number} [offset] Number of items to skip
|
|
275
|
+
* @param {Array<DocumentType>} [documentType] Only documents of these types; repeat the parameter to select several (default: every type, every item kind)
|
|
276
|
+
* @param {string} [ownerId] Only items owned by this user
|
|
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
|
|
281
|
+
* @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).
|
|
282
|
+
* @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.
|
|
267
283
|
* @throws {RequiredError}
|
|
268
284
|
* @memberof FoldersApiInterface
|
|
269
285
|
*/
|
|
270
286
|
searchItemsRequestOpts(requestParameters: SearchItemsRequest): Promise<runtime.RequestOpts>;
|
|
271
287
|
/**
|
|
272
|
-
* Search for folders, documents,
|
|
288
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
273
289
|
* @summary Search Items Handler
|
|
274
290
|
* @param {string} nameLike Case-insensitive partial name search
|
|
275
291
|
* @param {Array<SearchablePartType>} [partType] Filter by item type; repeat the parameter to select several (default: all searchable types)
|
|
@@ -278,13 +294,21 @@ export interface FoldersApiInterface {
|
|
|
278
294
|
* @param {string} [parentPathPartId] Scope search to descendants of this folder\'s path part
|
|
279
295
|
* @param {number} [limit] Number of items per page
|
|
280
296
|
* @param {number} [offset] Number of items to skip
|
|
297
|
+
* @param {Array<DocumentType>} [documentType] Only documents of these types; repeat the parameter to select several (default: every type, every item kind)
|
|
298
|
+
* @param {string} [ownerId] Only items owned by this user
|
|
299
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
300
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
301
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
302
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
303
|
+
* @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).
|
|
304
|
+
* @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.
|
|
281
305
|
* @param {*} [options] Override http request option.
|
|
282
306
|
* @throws {RequiredError}
|
|
283
307
|
* @memberof FoldersApiInterface
|
|
284
308
|
*/
|
|
285
309
|
searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>>;
|
|
286
310
|
/**
|
|
287
|
-
* Search for folders, documents,
|
|
311
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
288
312
|
* Search Items Handler
|
|
289
313
|
*/
|
|
290
314
|
searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse>;
|
|
@@ -403,12 +427,12 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
403
427
|
*/
|
|
404
428
|
searchItemsRequestOpts(requestParameters: SearchItemsRequest): Promise<runtime.RequestOpts>;
|
|
405
429
|
/**
|
|
406
|
-
* Search for folders, documents,
|
|
430
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
407
431
|
* Search Items Handler
|
|
408
432
|
*/
|
|
409
433
|
searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>>;
|
|
410
434
|
/**
|
|
411
|
-
* Search for folders, documents,
|
|
435
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
412
436
|
* Search Items Handler
|
|
413
437
|
*/
|
|
414
438
|
searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse>;
|
package/dist/apis/FoldersApi.js
CHANGED
|
@@ -461,6 +461,30 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
461
461
|
if (requestParameters['offset'] != null) {
|
|
462
462
|
queryParameters['offset'] = requestParameters['offset'];
|
|
463
463
|
}
|
|
464
|
+
if (requestParameters['documentType'] != null) {
|
|
465
|
+
queryParameters['document_type'] = requestParameters['documentType'];
|
|
466
|
+
}
|
|
467
|
+
if (requestParameters['ownerId'] != null) {
|
|
468
|
+
queryParameters['owner_id'] = requestParameters['ownerId'];
|
|
469
|
+
}
|
|
470
|
+
if (requestParameters['createdAfter'] != null) {
|
|
471
|
+
queryParameters['created_after'] = requestParameters['createdAfter'].toISOString();
|
|
472
|
+
}
|
|
473
|
+
if (requestParameters['createdBefore'] != null) {
|
|
474
|
+
queryParameters['created_before'] = requestParameters['createdBefore'].toISOString();
|
|
475
|
+
}
|
|
476
|
+
if (requestParameters['updatedAfter'] != null) {
|
|
477
|
+
queryParameters['updated_after'] = requestParameters['updatedAfter'].toISOString();
|
|
478
|
+
}
|
|
479
|
+
if (requestParameters['updatedBefore'] != null) {
|
|
480
|
+
queryParameters['updated_before'] = requestParameters['updatedBefore'].toISOString();
|
|
481
|
+
}
|
|
482
|
+
if (requestParameters['includeTagIds'] != null) {
|
|
483
|
+
queryParameters['include_tag_ids'] = requestParameters['includeTagIds'];
|
|
484
|
+
}
|
|
485
|
+
if (requestParameters['excludeTagIds'] != null) {
|
|
486
|
+
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
487
|
+
}
|
|
464
488
|
const headerParameters = {};
|
|
465
489
|
if (this.configuration && this.configuration.accessToken) {
|
|
466
490
|
const token = this.configuration.accessToken;
|
|
@@ -479,7 +503,7 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
479
503
|
});
|
|
480
504
|
}
|
|
481
505
|
/**
|
|
482
|
-
* Search for folders, documents,
|
|
506
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
483
507
|
* Search Items Handler
|
|
484
508
|
*/
|
|
485
509
|
searchItemsRaw(requestParameters, initOverrides) {
|
|
@@ -490,7 +514,7 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
490
514
|
});
|
|
491
515
|
}
|
|
492
516
|
/**
|
|
493
|
-
* Search for folders, documents,
|
|
517
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
494
518
|
* Search Items Handler
|
|
495
519
|
*/
|
|
496
520
|
searchItems(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 { ContentsSortOrder, CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchItemsResponse, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
13
|
+
import type { ContentsSortOrder, CreateFolderRequest, DocumentType, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchItemsResponse, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
14
14
|
export interface CreateFolderOperationRequest {
|
|
15
15
|
createFolderRequest: CreateFolderRequest;
|
|
16
16
|
}
|
|
@@ -64,6 +64,14 @@ export interface SearchItemsRequest {
|
|
|
64
64
|
parentPathPartId?: string | null;
|
|
65
65
|
limit?: number;
|
|
66
66
|
offset?: number;
|
|
67
|
+
documentType?: Array<DocumentType>;
|
|
68
|
+
ownerId?: string | null;
|
|
69
|
+
createdAfter?: Date | null;
|
|
70
|
+
createdBefore?: Date | null;
|
|
71
|
+
updatedAfter?: Date | null;
|
|
72
|
+
updatedBefore?: Date | null;
|
|
73
|
+
includeTagIds?: Array<string> | null;
|
|
74
|
+
excludeTagIds?: Array<string> | null;
|
|
67
75
|
}
|
|
68
76
|
export interface UpdateFolderOperationRequest {
|
|
69
77
|
folderId: string;
|
|
@@ -264,12 +272,20 @@ export interface FoldersApiInterface {
|
|
|
264
272
|
* @param {string} [parentPathPartId] Scope search to descendants of this folder\'s path part
|
|
265
273
|
* @param {number} [limit] Number of items per page
|
|
266
274
|
* @param {number} [offset] Number of items to skip
|
|
275
|
+
* @param {Array<DocumentType>} [documentType] Only documents of these types; repeat the parameter to select several (default: every type, every item kind)
|
|
276
|
+
* @param {string} [ownerId] Only items owned by this user
|
|
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
|
|
281
|
+
* @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).
|
|
282
|
+
* @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.
|
|
267
283
|
* @throws {RequiredError}
|
|
268
284
|
* @memberof FoldersApiInterface
|
|
269
285
|
*/
|
|
270
286
|
searchItemsRequestOpts(requestParameters: SearchItemsRequest): Promise<runtime.RequestOpts>;
|
|
271
287
|
/**
|
|
272
|
-
* Search for folders, documents,
|
|
288
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
273
289
|
* @summary Search Items Handler
|
|
274
290
|
* @param {string} nameLike Case-insensitive partial name search
|
|
275
291
|
* @param {Array<SearchablePartType>} [partType] Filter by item type; repeat the parameter to select several (default: all searchable types)
|
|
@@ -278,13 +294,21 @@ export interface FoldersApiInterface {
|
|
|
278
294
|
* @param {string} [parentPathPartId] Scope search to descendants of this folder\'s path part
|
|
279
295
|
* @param {number} [limit] Number of items per page
|
|
280
296
|
* @param {number} [offset] Number of items to skip
|
|
297
|
+
* @param {Array<DocumentType>} [documentType] Only documents of these types; repeat the parameter to select several (default: every type, every item kind)
|
|
298
|
+
* @param {string} [ownerId] Only items owned by this user
|
|
299
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
300
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
301
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
302
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
303
|
+
* @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).
|
|
304
|
+
* @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.
|
|
281
305
|
* @param {*} [options] Override http request option.
|
|
282
306
|
* @throws {RequiredError}
|
|
283
307
|
* @memberof FoldersApiInterface
|
|
284
308
|
*/
|
|
285
309
|
searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>>;
|
|
286
310
|
/**
|
|
287
|
-
* Search for folders, documents,
|
|
311
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
288
312
|
* Search Items Handler
|
|
289
313
|
*/
|
|
290
314
|
searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse>;
|
|
@@ -403,12 +427,12 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
403
427
|
*/
|
|
404
428
|
searchItemsRequestOpts(requestParameters: SearchItemsRequest): Promise<runtime.RequestOpts>;
|
|
405
429
|
/**
|
|
406
|
-
* Search for folders, documents,
|
|
430
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
407
431
|
* Search Items Handler
|
|
408
432
|
*/
|
|
409
433
|
searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>>;
|
|
410
434
|
/**
|
|
411
|
-
* Search for folders, documents,
|
|
435
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
412
436
|
* Search Items Handler
|
|
413
437
|
*/
|
|
414
438
|
searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse>;
|
|
@@ -425,6 +425,30 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
425
425
|
if (requestParameters['offset'] != null) {
|
|
426
426
|
queryParameters['offset'] = requestParameters['offset'];
|
|
427
427
|
}
|
|
428
|
+
if (requestParameters['documentType'] != null) {
|
|
429
|
+
queryParameters['document_type'] = requestParameters['documentType'];
|
|
430
|
+
}
|
|
431
|
+
if (requestParameters['ownerId'] != null) {
|
|
432
|
+
queryParameters['owner_id'] = requestParameters['ownerId'];
|
|
433
|
+
}
|
|
434
|
+
if (requestParameters['createdAfter'] != null) {
|
|
435
|
+
queryParameters['created_after'] = requestParameters['createdAfter'].toISOString();
|
|
436
|
+
}
|
|
437
|
+
if (requestParameters['createdBefore'] != null) {
|
|
438
|
+
queryParameters['created_before'] = requestParameters['createdBefore'].toISOString();
|
|
439
|
+
}
|
|
440
|
+
if (requestParameters['updatedAfter'] != null) {
|
|
441
|
+
queryParameters['updated_after'] = requestParameters['updatedAfter'].toISOString();
|
|
442
|
+
}
|
|
443
|
+
if (requestParameters['updatedBefore'] != null) {
|
|
444
|
+
queryParameters['updated_before'] = requestParameters['updatedBefore'].toISOString();
|
|
445
|
+
}
|
|
446
|
+
if (requestParameters['includeTagIds'] != null) {
|
|
447
|
+
queryParameters['include_tag_ids'] = requestParameters['includeTagIds'];
|
|
448
|
+
}
|
|
449
|
+
if (requestParameters['excludeTagIds'] != null) {
|
|
450
|
+
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
451
|
+
}
|
|
428
452
|
const headerParameters = {};
|
|
429
453
|
if (this.configuration && this.configuration.accessToken) {
|
|
430
454
|
const token = this.configuration.accessToken;
|
|
@@ -443,7 +467,7 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
443
467
|
});
|
|
444
468
|
}
|
|
445
469
|
/**
|
|
446
|
-
* Search for folders, documents,
|
|
470
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
447
471
|
* Search Items Handler
|
|
448
472
|
*/
|
|
449
473
|
searchItemsRaw(requestParameters, initOverrides) {
|
|
@@ -454,7 +478,7 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
454
478
|
});
|
|
455
479
|
}
|
|
456
480
|
/**
|
|
457
|
-
* Search for folders, documents,
|
|
481
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
458
482
|
* Search Items Handler
|
|
459
483
|
*/
|
|
460
484
|
searchItems(requestParameters, initOverrides) {
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { DocumentType } from './DocumentType';
|
|
12
13
|
import type { ReferenceType } from './ReferenceType';
|
|
13
14
|
/**
|
|
14
15
|
* A parsed reference enriched with display name and path from the database.
|
|
@@ -44,6 +45,12 @@ export interface ResolvedReferenceInput {
|
|
|
44
45
|
* @memberof ResolvedReferenceInput
|
|
45
46
|
*/
|
|
46
47
|
materializedPath?: string | null;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {DocumentType}
|
|
51
|
+
* @memberof ResolvedReferenceInput
|
|
52
|
+
*/
|
|
53
|
+
documentType?: DocumentType;
|
|
47
54
|
}
|
|
48
55
|
export declare const ResolvedReferenceInputPropertyValidationAttributesMap: {
|
|
49
56
|
[property: string]: {
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
|
|
14
15
|
import { ReferenceTypeFromJSON, ReferenceTypeToJSON, } from './ReferenceType';
|
|
15
16
|
export const ResolvedReferenceInputPropertyValidationAttributesMap = {};
|
|
16
17
|
/**
|
|
@@ -37,6 +38,7 @@ export function ResolvedReferenceInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
38
|
'entityId': json['entity_id'],
|
|
38
39
|
'displayName': json['display_name'],
|
|
39
40
|
'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
|
|
41
|
+
'documentType': json['document_type'] == null ? undefined : DocumentTypeFromJSON(json['document_type']),
|
|
40
42
|
};
|
|
41
43
|
}
|
|
42
44
|
export function ResolvedReferenceInputToJSON(json) {
|
|
@@ -51,5 +53,6 @@ export function ResolvedReferenceInputToJSONTyped(value, ignoreDiscriminator = f
|
|
|
51
53
|
'entity_id': value['entityId'],
|
|
52
54
|
'display_name': value['displayName'],
|
|
53
55
|
'materialized_path': value['materializedPath'],
|
|
56
|
+
'document_type': DocumentTypeToJSON(value['documentType']),
|
|
54
57
|
};
|
|
55
58
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { DocumentType } from './DocumentType';
|
|
12
13
|
/**
|
|
13
14
|
* A parsed reference enriched with display name and path from the database.
|
|
14
15
|
*
|
|
@@ -43,6 +44,12 @@ export interface ResolvedReferenceOutput {
|
|
|
43
44
|
* @memberof ResolvedReferenceOutput
|
|
44
45
|
*/
|
|
45
46
|
materializedPath?: string | null;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {DocumentType}
|
|
50
|
+
* @memberof ResolvedReferenceOutput
|
|
51
|
+
*/
|
|
52
|
+
documentType?: DocumentType;
|
|
46
53
|
}
|
|
47
54
|
export declare const ResolvedReferenceOutputPropertyValidationAttributesMap: {
|
|
48
55
|
[property: string]: {
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
|
|
14
15
|
export const ResolvedReferenceOutputPropertyValidationAttributesMap = {};
|
|
15
16
|
/**
|
|
16
17
|
* Check if a given object implements the ResolvedReferenceOutput interface.
|
|
@@ -36,6 +37,7 @@ export function ResolvedReferenceOutputFromJSONTyped(json, ignoreDiscriminator)
|
|
|
36
37
|
'entityId': json['entity_id'],
|
|
37
38
|
'displayName': json['display_name'],
|
|
38
39
|
'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
|
|
40
|
+
'documentType': json['document_type'] == null ? undefined : DocumentTypeFromJSON(json['document_type']),
|
|
39
41
|
};
|
|
40
42
|
}
|
|
41
43
|
export function ResolvedReferenceOutputToJSON(json) {
|
|
@@ -50,5 +52,6 @@ export function ResolvedReferenceOutputToJSONTyped(value, ignoreDiscriminator =
|
|
|
50
52
|
'entity_id': value['entityId'],
|
|
51
53
|
'display_name': value['displayName'],
|
|
52
54
|
'materialized_path': value['materializedPath'],
|
|
55
|
+
'document_type': DocumentTypeToJSON(value['documentType']),
|
|
53
56
|
};
|
|
54
57
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { DocumentType } from './DocumentType';
|
|
12
13
|
import type { ReferenceType } from './ReferenceType';
|
|
13
14
|
/**
|
|
14
15
|
* A parsed reference enriched with display name and path from the database.
|
|
@@ -44,6 +45,12 @@ export interface ResolvedReferenceInput {
|
|
|
44
45
|
* @memberof ResolvedReferenceInput
|
|
45
46
|
*/
|
|
46
47
|
materializedPath?: string | null;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {DocumentType}
|
|
51
|
+
* @memberof ResolvedReferenceInput
|
|
52
|
+
*/
|
|
53
|
+
documentType?: DocumentType;
|
|
47
54
|
}
|
|
48
55
|
export declare const ResolvedReferenceInputPropertyValidationAttributesMap: {
|
|
49
56
|
[property: string]: {
|
|
@@ -19,6 +19,7 @@ exports.ResolvedReferenceInputFromJSON = ResolvedReferenceInputFromJSON;
|
|
|
19
19
|
exports.ResolvedReferenceInputFromJSONTyped = ResolvedReferenceInputFromJSONTyped;
|
|
20
20
|
exports.ResolvedReferenceInputToJSON = ResolvedReferenceInputToJSON;
|
|
21
21
|
exports.ResolvedReferenceInputToJSONTyped = ResolvedReferenceInputToJSONTyped;
|
|
22
|
+
const DocumentType_1 = require("./DocumentType");
|
|
22
23
|
const ReferenceType_1 = require("./ReferenceType");
|
|
23
24
|
exports.ResolvedReferenceInputPropertyValidationAttributesMap = {};
|
|
24
25
|
/**
|
|
@@ -45,6 +46,7 @@ function ResolvedReferenceInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
45
46
|
'entityId': json['entity_id'],
|
|
46
47
|
'displayName': json['display_name'],
|
|
47
48
|
'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
|
|
49
|
+
'documentType': json['document_type'] == null ? undefined : (0, DocumentType_1.DocumentTypeFromJSON)(json['document_type']),
|
|
48
50
|
};
|
|
49
51
|
}
|
|
50
52
|
function ResolvedReferenceInputToJSON(json) {
|
|
@@ -59,5 +61,6 @@ function ResolvedReferenceInputToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
59
61
|
'entity_id': value['entityId'],
|
|
60
62
|
'display_name': value['displayName'],
|
|
61
63
|
'materialized_path': value['materializedPath'],
|
|
64
|
+
'document_type': (0, DocumentType_1.DocumentTypeToJSON)(value['documentType']),
|
|
62
65
|
};
|
|
63
66
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { DocumentType } from './DocumentType';
|
|
12
13
|
/**
|
|
13
14
|
* A parsed reference enriched with display name and path from the database.
|
|
14
15
|
*
|
|
@@ -43,6 +44,12 @@ export interface ResolvedReferenceOutput {
|
|
|
43
44
|
* @memberof ResolvedReferenceOutput
|
|
44
45
|
*/
|
|
45
46
|
materializedPath?: string | null;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {DocumentType}
|
|
50
|
+
* @memberof ResolvedReferenceOutput
|
|
51
|
+
*/
|
|
52
|
+
documentType?: DocumentType;
|
|
46
53
|
}
|
|
47
54
|
export declare const ResolvedReferenceOutputPropertyValidationAttributesMap: {
|
|
48
55
|
[property: string]: {
|
|
@@ -19,6 +19,7 @@ exports.ResolvedReferenceOutputFromJSON = ResolvedReferenceOutputFromJSON;
|
|
|
19
19
|
exports.ResolvedReferenceOutputFromJSONTyped = ResolvedReferenceOutputFromJSONTyped;
|
|
20
20
|
exports.ResolvedReferenceOutputToJSON = ResolvedReferenceOutputToJSON;
|
|
21
21
|
exports.ResolvedReferenceOutputToJSONTyped = ResolvedReferenceOutputToJSONTyped;
|
|
22
|
+
const DocumentType_1 = require("./DocumentType");
|
|
22
23
|
exports.ResolvedReferenceOutputPropertyValidationAttributesMap = {};
|
|
23
24
|
/**
|
|
24
25
|
* Check if a given object implements the ResolvedReferenceOutput interface.
|
|
@@ -44,6 +45,7 @@ function ResolvedReferenceOutputFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
44
45
|
'entityId': json['entity_id'],
|
|
45
46
|
'displayName': json['display_name'],
|
|
46
47
|
'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
|
|
48
|
+
'documentType': json['document_type'] == null ? undefined : (0, DocumentType_1.DocumentTypeFromJSON)(json['document_type']),
|
|
47
49
|
};
|
|
48
50
|
}
|
|
49
51
|
function ResolvedReferenceOutputToJSON(json) {
|
|
@@ -58,5 +60,6 @@ function ResolvedReferenceOutputToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
58
60
|
'entity_id': value['entityId'],
|
|
59
61
|
'display_name': value['displayName'],
|
|
60
62
|
'materialized_path': value['materializedPath'],
|
|
63
|
+
'document_type': (0, DocumentType_1.DocumentTypeToJSON)(value['documentType']),
|
|
61
64
|
};
|
|
62
65
|
}
|
package/docs/FoldersApi.md
CHANGED
|
@@ -546,11 +546,11 @@ example().catch(console.error);
|
|
|
546
546
|
|
|
547
547
|
## searchItems
|
|
548
548
|
|
|
549
|
-
> SearchItemsResponse searchItems(nameLike, partType, sortOrder, withTags, parentPathPartId, limit, offset)
|
|
549
|
+
> SearchItemsResponse searchItems(nameLike, partType, sortOrder, withTags, parentPathPartId, limit, offset, documentType, ownerId, createdAfter, createdBefore, updatedAfter, updatedBefore, includeTagIds, excludeTagIds)
|
|
550
550
|
|
|
551
551
|
Search Items Handler
|
|
552
552
|
|
|
553
|
-
Search for folders, documents,
|
|
553
|
+
Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
554
554
|
|
|
555
555
|
### Example
|
|
556
556
|
|
|
@@ -586,6 +586,22 @@ async function example() {
|
|
|
586
586
|
limit: 56,
|
|
587
587
|
// number | Number of items to skip (optional)
|
|
588
588
|
offset: 56,
|
|
589
|
+
// Array<DocumentType> | Only documents of these types; repeat the parameter to select several (default: every type, every item kind) (optional)
|
|
590
|
+
documentType: ...,
|
|
591
|
+
// string | Only items owned by this user (optional)
|
|
592
|
+
ownerId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
593
|
+
// Date | Only items created at or after this timestamp (inclusive) (optional)
|
|
594
|
+
createdAfter: 2013-10-20T19:20:30+01:00,
|
|
595
|
+
// Date | Only items created strictly before this timestamp (optional)
|
|
596
|
+
createdBefore: 2013-10-20T19:20:30+01:00,
|
|
597
|
+
// Date | Only items updated at or after this timestamp (inclusive) (optional)
|
|
598
|
+
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
599
|
+
// Date | Only items updated strictly before this timestamp (optional)
|
|
600
|
+
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
601
|
+
// 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)
|
|
602
|
+
includeTagIds: ...,
|
|
603
|
+
// 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)
|
|
604
|
+
excludeTagIds: ...,
|
|
589
605
|
} satisfies SearchItemsRequest;
|
|
590
606
|
|
|
591
607
|
try {
|
|
@@ -612,6 +628,14 @@ example().catch(console.error);
|
|
|
612
628
|
| **parentPathPartId** | `string` | Scope search to descendants of this folder\'s path part | [Optional] [Defaults to `undefined`] |
|
|
613
629
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
614
630
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
631
|
+
| **documentType** | `Array<DocumentType>` | Only documents of these types; repeat the parameter to select several (default: every type, every item kind) | [Optional] |
|
|
632
|
+
| **ownerId** | `string` | Only items owned by this user | [Optional] [Defaults to `undefined`] |
|
|
633
|
+
| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
634
|
+
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
635
|
+
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
636
|
+
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
637
|
+
| **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] |
|
|
638
|
+
| **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] |
|
|
615
639
|
|
|
616
640
|
### Return type
|
|
617
641
|
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`entityId` | string
|
|
12
12
|
`displayName` | string
|
|
13
13
|
`materializedPath` | string
|
|
14
|
+
`documentType` | [DocumentType](DocumentType.md)
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -23,6 +24,7 @@ const example = {
|
|
|
23
24
|
"entityId": null,
|
|
24
25
|
"displayName": null,
|
|
25
26
|
"materializedPath": null,
|
|
27
|
+
"documentType": null,
|
|
26
28
|
} satisfies ResolvedReferenceInput
|
|
27
29
|
|
|
28
30
|
console.log(example)
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`entityId` | string
|
|
12
12
|
`displayName` | string
|
|
13
13
|
`materializedPath` | string
|
|
14
|
+
`documentType` | [DocumentType](DocumentType.md)
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -23,6 +24,7 @@ const example = {
|
|
|
23
24
|
"entityId": null,
|
|
24
25
|
"displayName": null,
|
|
25
26
|
"materializedPath": null,
|
|
27
|
+
"documentType": null,
|
|
26
28
|
} satisfies ResolvedReferenceOutput
|
|
27
29
|
|
|
28
30
|
console.log(example)
|
package/package.json
CHANGED
package/src/apis/FoldersApi.ts
CHANGED
|
@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
|
|
|
17
17
|
import type {
|
|
18
18
|
ContentsSortOrder,
|
|
19
19
|
CreateFolderRequest,
|
|
20
|
+
DocumentType,
|
|
20
21
|
ErrorResponse,
|
|
21
22
|
FolderAction,
|
|
22
23
|
FolderActionResponse,
|
|
@@ -37,6 +38,8 @@ import {
|
|
|
37
38
|
ContentsSortOrderToJSON,
|
|
38
39
|
CreateFolderRequestFromJSON,
|
|
39
40
|
CreateFolderRequestToJSON,
|
|
41
|
+
DocumentTypeFromJSON,
|
|
42
|
+
DocumentTypeToJSON,
|
|
40
43
|
ErrorResponseFromJSON,
|
|
41
44
|
ErrorResponseToJSON,
|
|
42
45
|
FolderActionFromJSON,
|
|
@@ -126,6 +129,14 @@ export interface SearchItemsRequest {
|
|
|
126
129
|
parentPathPartId?: string | null;
|
|
127
130
|
limit?: number;
|
|
128
131
|
offset?: number;
|
|
132
|
+
documentType?: Array<DocumentType>;
|
|
133
|
+
ownerId?: string | null;
|
|
134
|
+
createdAfter?: Date | null;
|
|
135
|
+
createdBefore?: Date | null;
|
|
136
|
+
updatedAfter?: Date | null;
|
|
137
|
+
updatedBefore?: Date | null;
|
|
138
|
+
includeTagIds?: Array<string> | null;
|
|
139
|
+
excludeTagIds?: Array<string> | null;
|
|
129
140
|
}
|
|
130
141
|
|
|
131
142
|
export interface UpdateFolderOperationRequest {
|
|
@@ -346,13 +357,21 @@ export interface FoldersApiInterface {
|
|
|
346
357
|
* @param {string} [parentPathPartId] Scope search to descendants of this folder\'s path part
|
|
347
358
|
* @param {number} [limit] Number of items per page
|
|
348
359
|
* @param {number} [offset] Number of items to skip
|
|
360
|
+
* @param {Array<DocumentType>} [documentType] Only documents of these types; repeat the parameter to select several (default: every type, every item kind)
|
|
361
|
+
* @param {string} [ownerId] Only items owned by this user
|
|
362
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
363
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
364
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
365
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
366
|
+
* @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).
|
|
367
|
+
* @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.
|
|
349
368
|
* @throws {RequiredError}
|
|
350
369
|
* @memberof FoldersApiInterface
|
|
351
370
|
*/
|
|
352
371
|
searchItemsRequestOpts(requestParameters: SearchItemsRequest): Promise<runtime.RequestOpts>;
|
|
353
372
|
|
|
354
373
|
/**
|
|
355
|
-
* Search for folders, documents,
|
|
374
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
356
375
|
* @summary Search Items Handler
|
|
357
376
|
* @param {string} nameLike Case-insensitive partial name search
|
|
358
377
|
* @param {Array<SearchablePartType>} [partType] Filter by item type; repeat the parameter to select several (default: all searchable types)
|
|
@@ -361,6 +380,14 @@ export interface FoldersApiInterface {
|
|
|
361
380
|
* @param {string} [parentPathPartId] Scope search to descendants of this folder\'s path part
|
|
362
381
|
* @param {number} [limit] Number of items per page
|
|
363
382
|
* @param {number} [offset] Number of items to skip
|
|
383
|
+
* @param {Array<DocumentType>} [documentType] Only documents of these types; repeat the parameter to select several (default: every type, every item kind)
|
|
384
|
+
* @param {string} [ownerId] Only items owned by this user
|
|
385
|
+
* @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
|
|
386
|
+
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
387
|
+
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
388
|
+
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
389
|
+
* @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).
|
|
390
|
+
* @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.
|
|
364
391
|
* @param {*} [options] Override http request option.
|
|
365
392
|
* @throws {RequiredError}
|
|
366
393
|
* @memberof FoldersApiInterface
|
|
@@ -368,7 +395,7 @@ export interface FoldersApiInterface {
|
|
|
368
395
|
searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>>;
|
|
369
396
|
|
|
370
397
|
/**
|
|
371
|
-
* Search for folders, documents,
|
|
398
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
372
399
|
* Search Items Handler
|
|
373
400
|
*/
|
|
374
401
|
searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse>;
|
|
@@ -887,6 +914,38 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
887
914
|
queryParameters['offset'] = requestParameters['offset'];
|
|
888
915
|
}
|
|
889
916
|
|
|
917
|
+
if (requestParameters['documentType'] != null) {
|
|
918
|
+
queryParameters['document_type'] = requestParameters['documentType'];
|
|
919
|
+
}
|
|
920
|
+
|
|
921
|
+
if (requestParameters['ownerId'] != null) {
|
|
922
|
+
queryParameters['owner_id'] = requestParameters['ownerId'];
|
|
923
|
+
}
|
|
924
|
+
|
|
925
|
+
if (requestParameters['createdAfter'] != null) {
|
|
926
|
+
queryParameters['created_after'] = (requestParameters['createdAfter'] as any).toISOString();
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
if (requestParameters['createdBefore'] != null) {
|
|
930
|
+
queryParameters['created_before'] = (requestParameters['createdBefore'] as any).toISOString();
|
|
931
|
+
}
|
|
932
|
+
|
|
933
|
+
if (requestParameters['updatedAfter'] != null) {
|
|
934
|
+
queryParameters['updated_after'] = (requestParameters['updatedAfter'] as any).toISOString();
|
|
935
|
+
}
|
|
936
|
+
|
|
937
|
+
if (requestParameters['updatedBefore'] != null) {
|
|
938
|
+
queryParameters['updated_before'] = (requestParameters['updatedBefore'] as any).toISOString();
|
|
939
|
+
}
|
|
940
|
+
|
|
941
|
+
if (requestParameters['includeTagIds'] != null) {
|
|
942
|
+
queryParameters['include_tag_ids'] = requestParameters['includeTagIds'];
|
|
943
|
+
}
|
|
944
|
+
|
|
945
|
+
if (requestParameters['excludeTagIds'] != null) {
|
|
946
|
+
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
947
|
+
}
|
|
948
|
+
|
|
890
949
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
891
950
|
|
|
892
951
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -909,7 +968,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
909
968
|
}
|
|
910
969
|
|
|
911
970
|
/**
|
|
912
|
-
* Search for folders, documents,
|
|
971
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
913
972
|
* Search Items Handler
|
|
914
973
|
*/
|
|
915
974
|
async searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchItemsResponse>> {
|
|
@@ -920,7 +979,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
920
979
|
}
|
|
921
980
|
|
|
922
981
|
/**
|
|
923
|
-
* Search for folders, documents,
|
|
982
|
+
* Search for folders, documents, connectors, workflows and skills. Every word of the query must appear in the item\'s name or in a folder on the way to it; items named after the query rank above items that merely sit in a folder named after it. Matching is case-insensitive and served by trigram indexes, with a typo-tolerant fallback on names when nothing matches strictly. Results are filtered by the current user\'s path permissions. Owner, document type, timestamp and tag filters narrow both the page and ``counts_by_type``; ``part_type`` narrows the page only, so the chips keep every type\'s count.
|
|
924
983
|
* Search Items Handler
|
|
925
984
|
*/
|
|
926
985
|
async searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchItemsResponse> {
|
|
@@ -13,6 +13,13 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { DocumentType } from './DocumentType';
|
|
17
|
+
import {
|
|
18
|
+
DocumentTypeFromJSON,
|
|
19
|
+
DocumentTypeFromJSONTyped,
|
|
20
|
+
DocumentTypeToJSON,
|
|
21
|
+
DocumentTypeToJSONTyped,
|
|
22
|
+
} from './DocumentType';
|
|
16
23
|
import type { ReferenceType } from './ReferenceType';
|
|
17
24
|
import {
|
|
18
25
|
ReferenceTypeFromJSON,
|
|
@@ -55,6 +62,12 @@ export interface ResolvedReferenceInput {
|
|
|
55
62
|
* @memberof ResolvedReferenceInput
|
|
56
63
|
*/
|
|
57
64
|
materializedPath?: string | null;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {DocumentType}
|
|
68
|
+
* @memberof ResolvedReferenceInput
|
|
69
|
+
*/
|
|
70
|
+
documentType?: DocumentType;
|
|
58
71
|
}
|
|
59
72
|
|
|
60
73
|
|
|
@@ -100,6 +113,7 @@ export function ResolvedReferenceInputFromJSONTyped(json: any, ignoreDiscriminat
|
|
|
100
113
|
'entityId': json['entity_id'],
|
|
101
114
|
'displayName': json['display_name'],
|
|
102
115
|
'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
|
|
116
|
+
'documentType': json['document_type'] == null ? undefined : DocumentTypeFromJSON(json['document_type']),
|
|
103
117
|
};
|
|
104
118
|
}
|
|
105
119
|
|
|
@@ -118,6 +132,7 @@ export function ResolvedReferenceInputToJSONTyped(value?: ResolvedReferenceInput
|
|
|
118
132
|
'entity_id': value['entityId'],
|
|
119
133
|
'display_name': value['displayName'],
|
|
120
134
|
'materialized_path': value['materializedPath'],
|
|
135
|
+
'document_type': DocumentTypeToJSON(value['documentType']),
|
|
121
136
|
};
|
|
122
137
|
}
|
|
123
138
|
|
|
@@ -13,6 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { DocumentType } from './DocumentType';
|
|
17
|
+
import {
|
|
18
|
+
DocumentTypeFromJSON,
|
|
19
|
+
DocumentTypeFromJSONTyped,
|
|
20
|
+
DocumentTypeToJSON,
|
|
21
|
+
DocumentTypeToJSONTyped,
|
|
22
|
+
} from './DocumentType';
|
|
23
|
+
|
|
16
24
|
/**
|
|
17
25
|
* A parsed reference enriched with display name and path from the database.
|
|
18
26
|
*
|
|
@@ -47,7 +55,15 @@ export interface ResolvedReferenceOutput {
|
|
|
47
55
|
* @memberof ResolvedReferenceOutput
|
|
48
56
|
*/
|
|
49
57
|
materializedPath?: string | null;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @type {DocumentType}
|
|
61
|
+
* @memberof ResolvedReferenceOutput
|
|
62
|
+
*/
|
|
63
|
+
documentType?: DocumentType;
|
|
50
64
|
}
|
|
65
|
+
|
|
66
|
+
|
|
51
67
|
export const ResolvedReferenceOutputPropertyValidationAttributesMap: {
|
|
52
68
|
[property: string]: {
|
|
53
69
|
maxLength?: number,
|
|
@@ -90,6 +106,7 @@ export function ResolvedReferenceOutputFromJSONTyped(json: any, ignoreDiscrimina
|
|
|
90
106
|
'entityId': json['entity_id'],
|
|
91
107
|
'displayName': json['display_name'],
|
|
92
108
|
'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
|
|
109
|
+
'documentType': json['document_type'] == null ? undefined : DocumentTypeFromJSON(json['document_type']),
|
|
93
110
|
};
|
|
94
111
|
}
|
|
95
112
|
|
|
@@ -108,6 +125,7 @@ export function ResolvedReferenceOutputToJSONTyped(value?: ResolvedReferenceOutp
|
|
|
108
125
|
'entity_id': value['entityId'],
|
|
109
126
|
'display_name': value['displayName'],
|
|
110
127
|
'materialized_path': value['materializedPath'],
|
|
128
|
+
'document_type': DocumentTypeToJSON(value['documentType']),
|
|
111
129
|
};
|
|
112
130
|
}
|
|
113
131
|
|