@knowledge-stack/ksapi 1.57.0 → 1.59.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.
Files changed (77) hide show
  1. package/.openapi-generator/FILES +12 -2
  2. package/README.md +16 -6
  3. package/dist/apis/FoldersApi.d.ts +63 -4
  4. package/dist/apis/FoldersApi.js +64 -3
  5. package/dist/apis/PathPartsApi.d.ts +45 -1
  6. package/dist/apis/PathPartsApi.js +44 -0
  7. package/dist/apis/SectionsApi.d.ts +44 -0
  8. package/dist/apis/SectionsApi.js +43 -0
  9. package/dist/apis/WorkflowsApi.d.ts +144 -59
  10. package/dist/apis/WorkflowsApi.js +131 -49
  11. package/dist/esm/apis/FoldersApi.d.ts +63 -4
  12. package/dist/esm/apis/FoldersApi.js +64 -3
  13. package/dist/esm/apis/PathPartsApi.d.ts +45 -1
  14. package/dist/esm/apis/PathPartsApi.js +45 -1
  15. package/dist/esm/apis/SectionsApi.d.ts +44 -0
  16. package/dist/esm/apis/SectionsApi.js +43 -0
  17. package/dist/esm/apis/WorkflowsApi.d.ts +144 -59
  18. package/dist/esm/apis/WorkflowsApi.js +132 -50
  19. package/dist/esm/models/AncestryResponse.d.ts +48 -0
  20. package/dist/esm/models/AncestryResponse.js +45 -0
  21. package/dist/esm/models/PathPartAncestorItem.d.ts +96 -0
  22. package/dist/esm/models/PathPartAncestorItem.js +77 -0
  23. package/dist/esm/models/SearchSortOrder.d.ts +26 -0
  24. package/dist/esm/models/SearchSortOrder.js +44 -0
  25. package/dist/esm/models/SearchablePartType.d.ts +25 -0
  26. package/dist/esm/models/SearchablePartType.js +43 -0
  27. package/dist/esm/models/TemporalWorkflowStatusResponse.d.ts +83 -0
  28. package/dist/esm/models/TemporalWorkflowStatusResponse.js +66 -0
  29. package/dist/esm/models/WorkflowActionResponse.d.ts +1 -1
  30. package/dist/esm/models/WorkflowCancelResponse.d.ts +53 -0
  31. package/dist/esm/models/WorkflowCancelResponse.js +48 -0
  32. package/dist/esm/models/index.d.ts +6 -1
  33. package/dist/esm/models/index.js +6 -1
  34. package/dist/models/AncestryResponse.d.ts +48 -0
  35. package/dist/models/AncestryResponse.js +53 -0
  36. package/dist/models/PathPartAncestorItem.d.ts +96 -0
  37. package/dist/models/PathPartAncestorItem.js +85 -0
  38. package/dist/models/SearchSortOrder.d.ts +26 -0
  39. package/dist/models/SearchSortOrder.js +52 -0
  40. package/dist/models/SearchablePartType.d.ts +25 -0
  41. package/dist/models/SearchablePartType.js +51 -0
  42. package/dist/models/TemporalWorkflowStatusResponse.d.ts +83 -0
  43. package/dist/models/TemporalWorkflowStatusResponse.js +74 -0
  44. package/dist/models/WorkflowActionResponse.d.ts +1 -1
  45. package/dist/models/WorkflowCancelResponse.d.ts +53 -0
  46. package/dist/models/WorkflowCancelResponse.js +56 -0
  47. package/dist/models/index.d.ts +6 -1
  48. package/dist/models/index.js +6 -1
  49. package/docs/AncestryResponse.md +35 -0
  50. package/docs/FoldersApi.md +94 -4
  51. package/docs/PathPartAncestorItem.md +51 -0
  52. package/docs/PathPartsApi.md +75 -0
  53. package/docs/{WorkflowAction.md → SearchSortOrder.md} +5 -5
  54. package/docs/SearchablePartType.md +33 -0
  55. package/docs/SectionsApi.md +75 -0
  56. package/docs/TemporalWorkflowStatusResponse.md +47 -0
  57. package/docs/WorkflowActionResponse.md +1 -1
  58. package/docs/WorkflowCancelResponse.md +37 -0
  59. package/docs/WorkflowsApi.md +183 -36
  60. package/package.json +1 -1
  61. package/src/apis/FoldersApi.ts +136 -7
  62. package/src/apis/PathPartsApi.ts +88 -0
  63. package/src/apis/SectionsApi.ts +81 -0
  64. package/src/apis/WorkflowsApi.ts +249 -90
  65. package/src/models/AncestryResponse.ts +91 -0
  66. package/src/models/PathPartAncestorItem.ts +165 -0
  67. package/src/models/SearchSortOrder.ts +54 -0
  68. package/src/models/SearchablePartType.ts +53 -0
  69. package/src/models/TemporalWorkflowStatusResponse.ts +136 -0
  70. package/src/models/WorkflowActionResponse.ts +1 -1
  71. package/src/models/WorkflowCancelResponse.ts +92 -0
  72. package/src/models/index.ts +6 -1
  73. package/dist/esm/models/WorkflowAction.d.ts +0 -25
  74. package/dist/esm/models/WorkflowAction.js +0 -43
  75. package/dist/models/WorkflowAction.d.ts +0 -25
  76. package/dist/models/WorkflowAction.js +0 -51
  77. package/src/models/WorkflowAction.ts +0 -53
@@ -0,0 +1,53 @@
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
+ * Response for generic workflow cancellation.
14
+ * @export
15
+ * @interface WorkflowCancelResponse
16
+ */
17
+ export interface WorkflowCancelResponse {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof WorkflowCancelResponse
22
+ */
23
+ workflowId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof WorkflowCancelResponse
28
+ */
29
+ message: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the WorkflowCancelResponse interface.
33
+ */
34
+ export declare function instanceOfWorkflowCancelResponse(value: object): value is WorkflowCancelResponse;
35
+ export declare function WorkflowCancelResponseFromJSON(json: any): WorkflowCancelResponse;
36
+ export declare function WorkflowCancelResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowCancelResponse;
37
+ export declare function WorkflowCancelResponseToJSON(json: any): WorkflowCancelResponse;
38
+ export declare function WorkflowCancelResponseToJSONTyped(value?: WorkflowCancelResponse | null, ignoreDiscriminator?: boolean): any;
39
+ export declare const WorkflowCancelResponsePropertyValidationAttributesMap: {
40
+ [property: string]: {
41
+ maxLength?: number;
42
+ minLength?: number;
43
+ pattern?: string;
44
+ maximum?: number;
45
+ exclusiveMaximum?: boolean;
46
+ minimum?: number;
47
+ exclusiveMinimum?: boolean;
48
+ multipleOf?: number;
49
+ maxItems?: number;
50
+ minItems?: number;
51
+ uniqueItems?: boolean;
52
+ };
53
+ };
@@ -0,0 +1,56 @@
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.WorkflowCancelResponsePropertyValidationAttributesMap = void 0;
17
+ exports.instanceOfWorkflowCancelResponse = instanceOfWorkflowCancelResponse;
18
+ exports.WorkflowCancelResponseFromJSON = WorkflowCancelResponseFromJSON;
19
+ exports.WorkflowCancelResponseFromJSONTyped = WorkflowCancelResponseFromJSONTyped;
20
+ exports.WorkflowCancelResponseToJSON = WorkflowCancelResponseToJSON;
21
+ exports.WorkflowCancelResponseToJSONTyped = WorkflowCancelResponseToJSONTyped;
22
+ /**
23
+ * Check if a given object implements the WorkflowCancelResponse interface.
24
+ */
25
+ function instanceOfWorkflowCancelResponse(value) {
26
+ if (!('workflowId' in value) || value['workflowId'] === undefined)
27
+ return false;
28
+ if (!('message' in value) || value['message'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ function WorkflowCancelResponseFromJSON(json) {
33
+ return WorkflowCancelResponseFromJSONTyped(json, false);
34
+ }
35
+ function WorkflowCancelResponseFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'workflowId': json['workflow_id'],
41
+ 'message': json['message'],
42
+ };
43
+ }
44
+ function WorkflowCancelResponseToJSON(json) {
45
+ return WorkflowCancelResponseToJSONTyped(json, false);
46
+ }
47
+ function WorkflowCancelResponseToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'workflow_id': value['workflowId'],
53
+ 'message': value['message'],
54
+ };
55
+ }
56
+ exports.WorkflowCancelResponsePropertyValidationAttributesMap = {};
@@ -1,4 +1,5 @@
1
1
  export * from './AcceptInviteResponse';
2
+ export * from './AncestryResponse';
2
3
  export * from './ApiKeyResponse';
3
4
  export * from './Args';
4
5
  export * from './BrandingLogoType';
@@ -81,6 +82,7 @@ export * from './PartType';
81
82
  export * from './PasswordResetRequest';
82
83
  export * from './PasswordResetWithTokenRequest';
83
84
  export * from './PathOrder';
85
+ export * from './PathPartAncestorItem';
84
86
  export * from './PathPartResponse';
85
87
  export * from './PathPartTagsResponse';
86
88
  export * from './PermissionCapability';
@@ -95,7 +97,9 @@ export * from './ResolvedReferenceOutput';
95
97
  export * from './RootResponse';
96
98
  export * from './SSOInitiateResponse';
97
99
  export * from './ScoredChunkResponse';
100
+ export * from './SearchSortOrder';
98
101
  export * from './SearchType';
102
+ export * from './SearchablePartType';
99
103
  export * from './SectionContentItem';
100
104
  export * from './SectionContentItemOrChunkContentItem';
101
105
  export * from './SectionResponse';
@@ -108,6 +112,7 @@ export * from './SubtreeChunkGroup';
108
112
  export * from './SubtreeChunksResponse';
109
113
  export * from './SupportedLanguage';
110
114
  export * from './TagResponse';
115
+ export * from './TemporalWorkflowStatusResponse';
111
116
  export * from './TenantBrandingResponse';
112
117
  export * from './TenantResponse';
113
118
  export * from './TenantSettingsResponse';
@@ -135,7 +140,7 @@ export * from './UserMessageResponse';
135
140
  export * from './UserResponse';
136
141
  export * from './ValidationError';
137
142
  export * from './VersionChunkIdsResponse';
138
- export * from './WorkflowAction';
139
143
  export * from './WorkflowActionResponse';
144
+ export * from './WorkflowCancelResponse';
140
145
  export * from './WorkflowDetailResponse';
141
146
  export * from './WorkflowSummaryResponse';
@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  /* tslint:disable */
18
18
  /* eslint-disable */
19
19
  __exportStar(require("./AcceptInviteResponse"), exports);
20
+ __exportStar(require("./AncestryResponse"), exports);
20
21
  __exportStar(require("./ApiKeyResponse"), exports);
21
22
  __exportStar(require("./Args"), exports);
22
23
  __exportStar(require("./BrandingLogoType"), exports);
@@ -99,6 +100,7 @@ __exportStar(require("./PartType"), exports);
99
100
  __exportStar(require("./PasswordResetRequest"), exports);
100
101
  __exportStar(require("./PasswordResetWithTokenRequest"), exports);
101
102
  __exportStar(require("./PathOrder"), exports);
103
+ __exportStar(require("./PathPartAncestorItem"), exports);
102
104
  __exportStar(require("./PathPartResponse"), exports);
103
105
  __exportStar(require("./PathPartTagsResponse"), exports);
104
106
  __exportStar(require("./PermissionCapability"), exports);
@@ -113,7 +115,9 @@ __exportStar(require("./ResolvedReferenceOutput"), exports);
113
115
  __exportStar(require("./RootResponse"), exports);
114
116
  __exportStar(require("./SSOInitiateResponse"), exports);
115
117
  __exportStar(require("./ScoredChunkResponse"), exports);
118
+ __exportStar(require("./SearchSortOrder"), exports);
116
119
  __exportStar(require("./SearchType"), exports);
120
+ __exportStar(require("./SearchablePartType"), exports);
117
121
  __exportStar(require("./SectionContentItem"), exports);
118
122
  __exportStar(require("./SectionContentItemOrChunkContentItem"), exports);
119
123
  __exportStar(require("./SectionResponse"), exports);
@@ -126,6 +130,7 @@ __exportStar(require("./SubtreeChunkGroup"), exports);
126
130
  __exportStar(require("./SubtreeChunksResponse"), exports);
127
131
  __exportStar(require("./SupportedLanguage"), exports);
128
132
  __exportStar(require("./TagResponse"), exports);
133
+ __exportStar(require("./TemporalWorkflowStatusResponse"), exports);
129
134
  __exportStar(require("./TenantBrandingResponse"), exports);
130
135
  __exportStar(require("./TenantResponse"), exports);
131
136
  __exportStar(require("./TenantSettingsResponse"), exports);
@@ -153,7 +158,7 @@ __exportStar(require("./UserMessageResponse"), exports);
153
158
  __exportStar(require("./UserResponse"), exports);
154
159
  __exportStar(require("./ValidationError"), exports);
155
160
  __exportStar(require("./VersionChunkIdsResponse"), exports);
156
- __exportStar(require("./WorkflowAction"), exports);
157
161
  __exportStar(require("./WorkflowActionResponse"), exports);
162
+ __exportStar(require("./WorkflowCancelResponse"), exports);
158
163
  __exportStar(require("./WorkflowDetailResponse"), exports);
159
164
  __exportStar(require("./WorkflowSummaryResponse"), exports);
@@ -0,0 +1,35 @@
1
+
2
+ # AncestryResponse
3
+
4
+ Response containing the ancestry chain from root to target (inclusive).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `ancestors` | [Array<PathPartAncestorItem>](PathPartAncestorItem.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { AncestryResponse } from '@knowledge-stack/ksapi'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "ancestors": null,
20
+ } satisfies AncestryResponse
21
+
22
+ console.log(example)
23
+
24
+ // Convert the instance to a JSON string
25
+ const exampleJSON: string = JSON.stringify(example)
26
+ console.log(exampleJSON)
27
+
28
+ // Parse the JSON string back to an object
29
+ const exampleParsed = JSON.parse(exampleJSON) as AncestryResponse
30
+ console.log(exampleParsed)
31
+ ```
32
+
33
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
34
+
35
+
@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost:8000*
10
10
  | [**getFolder**](FoldersApi.md#getfolder) | **GET** /v1/folders/{folder_id} | Get Folder Handler |
11
11
  | [**listFolderContents**](FoldersApi.md#listfoldercontents) | **GET** /v1/folders/{folder_id}/contents | List Folder Contents Handler |
12
12
  | [**listFolders**](FoldersApi.md#listfolders) | **GET** /v1/folders | List Folders Handler |
13
+ | [**searchItems**](FoldersApi.md#searchitems) | **GET** /v1/folders/search | Search Items Handler |
13
14
  | [**updateFolder**](FoldersApi.md#updatefolderoperation) | **PATCH** /v1/folders/{folder_id} | Update Folder Handler |
14
15
 
15
16
 
@@ -318,7 +319,7 @@ No authorization required
318
319
 
319
320
  ## listFolderContents
320
321
 
321
- > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, nameLike, limit, offset, authorization, ksUat)
322
+ > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset, authorization, ksUat)
322
323
 
323
324
  List Folder Contents Handler
324
325
 
@@ -346,8 +347,6 @@ async function example() {
346
347
  sortOrder: ...,
347
348
  // boolean | Include tag IDs for each item (default: false) (optional)
348
349
  withTags: true,
349
- // string | Case-insensitive partial name search filter (optional)
350
- nameLike: nameLike_example,
351
350
  // number | Number of items per page (optional)
352
351
  limit: 56,
353
352
  // number | Number of items to skip (optional)
@@ -379,7 +378,6 @@ example().catch(console.error);
379
378
  | **maxDepth** | `number` | Maximum depth to traverse (1=direct children, default: 1) | [Optional] [Defaults to `1`] |
380
379
  | **sortOrder** | `PathOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
381
380
  | **withTags** | `boolean` | Include tag IDs for each item (default: false) | [Optional] [Defaults to `false`] |
382
- | **nameLike** | `string` | Case-insensitive partial name search filter | [Optional] [Defaults to `undefined`] |
383
381
  | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
384
382
  | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
385
383
  | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
@@ -494,6 +492,98 @@ No authorization required
494
492
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
495
493
 
496
494
 
495
+ ## searchItems
496
+
497
+ > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator searchItems(nameLike, sortOrder, partType, withTags, parentPathPartId, limit, offset, authorization, ksUat)
498
+
499
+ Search Items Handler
500
+
501
+ Search for folders and documents by name. Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions. When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
502
+
503
+ ### Example
504
+
505
+ ```ts
506
+ import {
507
+ Configuration,
508
+ FoldersApi,
509
+ } from '@knowledge-stack/ksapi';
510
+ import type { SearchItemsRequest } from '@knowledge-stack/ksapi';
511
+
512
+ async function example() {
513
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
514
+ const api = new FoldersApi();
515
+
516
+ const body = {
517
+ // string | Case-insensitive partial name search
518
+ nameLike: nameLike_example,
519
+ // SearchSortOrder | Sort order for results (default: NAME) (optional)
520
+ sortOrder: ...,
521
+ // SearchablePartType | Filter by item type (default: both folders and documents) (optional)
522
+ partType: ...,
523
+ // boolean | Include tags in the response (default: false) (optional)
524
+ withTags: true,
525
+ // string | Scope search to descendants of this folder\'s path part (optional)
526
+ parentPathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
527
+ // number | Number of items per page (optional)
528
+ limit: 56,
529
+ // number | Number of items to skip (optional)
530
+ offset: 56,
531
+ // string (optional)
532
+ authorization: authorization_example,
533
+ // string (optional)
534
+ ksUat: ksUat_example,
535
+ } satisfies SearchItemsRequest;
536
+
537
+ try {
538
+ const data = await api.searchItems(body);
539
+ console.log(data);
540
+ } catch (error) {
541
+ console.error(error);
542
+ }
543
+ }
544
+
545
+ // Run the test
546
+ example().catch(console.error);
547
+ ```
548
+
549
+ ### Parameters
550
+
551
+
552
+ | Name | Type | Description | Notes |
553
+ |------------- | ------------- | ------------- | -------------|
554
+ | **nameLike** | `string` | Case-insensitive partial name search | [Defaults to `undefined`] |
555
+ | **sortOrder** | `SearchSortOrder` | Sort order for results (default: NAME) | [Optional] [Defaults to `undefined`] [Enum: NAME, UPDATED_AT, CREATED_AT] |
556
+ | **partType** | `SearchablePartType` | Filter by item type (default: both folders and documents) | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT] |
557
+ | **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
558
+ | **parentPathPartId** | `string` | Scope search to descendants of this folder\'s path part | [Optional] [Defaults to `undefined`] |
559
+ | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
560
+ | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
561
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
562
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
563
+
564
+ ### Return type
565
+
566
+ [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md)
567
+
568
+ ### Authorization
569
+
570
+ No authorization required
571
+
572
+ ### HTTP request headers
573
+
574
+ - **Content-Type**: Not defined
575
+ - **Accept**: `application/json`
576
+
577
+
578
+ ### HTTP response details
579
+ | Status code | Description | Response headers |
580
+ |-------------|-------------|------------------|
581
+ | **200** | Successful Response | - |
582
+ | **422** | Validation Error | - |
583
+
584
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
585
+
586
+
497
587
  ## updateFolder
498
588
 
499
589
  > FolderResponse updateFolder(folderId, updateFolderRequest, authorization, ksUat)
@@ -0,0 +1,51 @@
1
+
2
+ # PathPartAncestorItem
3
+
4
+ Single ancestor item in an ancestry chain.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `pathPartId` | string
11
+ `name` | string
12
+ `partType` | [PartType](PartType.md)
13
+ `parentPathId` | string
14
+ `metadataObjId` | string
15
+ `materializedPath` | string
16
+ `systemManaged` | boolean
17
+ `createdAt` | Date
18
+ `updatedAt` | Date
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import type { PathPartAncestorItem } from '@knowledge-stack/ksapi'
24
+
25
+ // TODO: Update the object below with actual values
26
+ const example = {
27
+ "pathPartId": null,
28
+ "name": null,
29
+ "partType": null,
30
+ "parentPathId": null,
31
+ "metadataObjId": null,
32
+ "materializedPath": null,
33
+ "systemManaged": null,
34
+ "createdAt": null,
35
+ "updatedAt": null,
36
+ } satisfies PathPartAncestorItem
37
+
38
+ console.log(example)
39
+
40
+ // Convert the instance to a JSON string
41
+ const exampleJSON: string = JSON.stringify(example)
42
+ console.log(exampleJSON)
43
+
44
+ // Parse the JSON string back to an object
45
+ const exampleParsed = JSON.parse(exampleJSON) as PathPartAncestorItem
46
+ console.log(exampleParsed)
47
+ ```
48
+
49
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
50
+
51
+
@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost:8000*
7
7
  | [**bulkAddPathPartTags**](PathPartsApi.md#bulkaddpathparttags) | **POST** /v1/path-parts/{path_part_id}/tags | Bulk Add Path Part Tags Handler |
8
8
  | [**bulkRemovePathPartTags**](PathPartsApi.md#bulkremovepathparttags) | **DELETE** /v1/path-parts/{path_part_id}/tags | Bulk Remove Path Part Tags Handler |
9
9
  | [**getPathPart**](PathPartsApi.md#getpathpart) | **GET** /v1/path-parts/{path_part_id} | Get Path Part Handler |
10
+ | [**getPathPartAncestry**](PathPartsApi.md#getpathpartancestry) | **GET** /v1/path-parts/{path_part_id}/ancestry | Get Path Part Ancestry Handler |
10
11
  | [**getPathPartSubtreeChunks**](PathPartsApi.md#getpathpartsubtreechunks) | **GET** /v1/path-parts/{path_part_id}/subtree_chunks | Get Path Part Subtree Chunks Handler |
11
12
  | [**getPathPartTags**](PathPartsApi.md#getpathparttags) | **GET** /v1/path-parts/{path_part_id}/tags | Get Path Part Tags Handler |
12
13
  | [**listPathParts**](PathPartsApi.md#listpathparts) | **GET** /v1/path-parts | List Path Parts Handler |
@@ -241,6 +242,80 @@ No authorization required
241
242
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
242
243
 
243
244
 
245
+ ## getPathPartAncestry
246
+
247
+ > AncestryResponse getPathPartAncestry(pathPartId, authorization, ksUat)
248
+
249
+ Get Path Part Ancestry Handler
250
+
251
+ Get the full ancestry chain for a path part (root to leaf, inclusive). Returns all ancestors from the root down to and including the target path part. Authorization is checked on the leaf — if the user can read the leaf, they can navigate its ancestors.
252
+
253
+ ### Example
254
+
255
+ ```ts
256
+ import {
257
+ Configuration,
258
+ PathPartsApi,
259
+ } from '@knowledge-stack/ksapi';
260
+ import type { GetPathPartAncestryRequest } from '@knowledge-stack/ksapi';
261
+
262
+ async function example() {
263
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
264
+ const api = new PathPartsApi();
265
+
266
+ const body = {
267
+ // string
268
+ pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
269
+ // string (optional)
270
+ authorization: authorization_example,
271
+ // string (optional)
272
+ ksUat: ksUat_example,
273
+ } satisfies GetPathPartAncestryRequest;
274
+
275
+ try {
276
+ const data = await api.getPathPartAncestry(body);
277
+ console.log(data);
278
+ } catch (error) {
279
+ console.error(error);
280
+ }
281
+ }
282
+
283
+ // Run the test
284
+ example().catch(console.error);
285
+ ```
286
+
287
+ ### Parameters
288
+
289
+
290
+ | Name | Type | Description | Notes |
291
+ |------------- | ------------- | ------------- | -------------|
292
+ | **pathPartId** | `string` | | [Defaults to `undefined`] |
293
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
294
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
295
+
296
+ ### Return type
297
+
298
+ [**AncestryResponse**](AncestryResponse.md)
299
+
300
+ ### Authorization
301
+
302
+ No authorization required
303
+
304
+ ### HTTP request headers
305
+
306
+ - **Content-Type**: Not defined
307
+ - **Accept**: `application/json`
308
+
309
+
310
+ ### HTTP response details
311
+ | Status code | Description | Response headers |
312
+ |-------------|-------------|------------------|
313
+ | **200** | Successful Response | - |
314
+ | **422** | Validation Error | - |
315
+
316
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
317
+
318
+
244
319
  ## getPathPartSubtreeChunks
245
320
 
246
321
  > SubtreeChunksResponse getPathPartSubtreeChunks(pathPartId, authorization, ksUat)
@@ -1,7 +1,7 @@
1
1
 
2
- # WorkflowAction
2
+ # SearchSortOrder
3
3
 
4
- Supported workflow actions.
4
+ Sort order options for search results.
5
5
 
6
6
  ## Properties
7
7
 
@@ -11,11 +11,11 @@ Name | Type
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import type { WorkflowAction } from '@knowledge-stack/ksapi'
14
+ import type { SearchSortOrder } from '@knowledge-stack/ksapi'
15
15
 
16
16
  // TODO: Update the object below with actual values
17
17
  const example = {
18
- } satisfies WorkflowAction
18
+ } satisfies SearchSortOrder
19
19
 
20
20
  console.log(example)
21
21
 
@@ -24,7 +24,7 @@ const exampleJSON: string = JSON.stringify(example)
24
24
  console.log(exampleJSON)
25
25
 
26
26
  // Parse the JSON string back to an object
27
- const exampleParsed = JSON.parse(exampleJSON) as WorkflowAction
27
+ const exampleParsed = JSON.parse(exampleJSON) as SearchSortOrder
28
28
  console.log(exampleParsed)
29
29
  ```
30
30
 
@@ -0,0 +1,33 @@
1
+
2
+ # SearchablePartType
3
+
4
+ Part types that can be searched.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { SearchablePartType } from '@knowledge-stack/ksapi'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ } satisfies SearchablePartType
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 SearchablePartType
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
+
@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost:8000*
7
7
  | [**createSection**](SectionsApi.md#createsectionoperation) | **POST** /v1/sections | Create Section Handler |
8
8
  | [**deleteSection**](SectionsApi.md#deletesection) | **DELETE** /v1/sections/{section_id} | Delete Section Handler |
9
9
  | [**getSection**](SectionsApi.md#getsection) | **GET** /v1/sections/{section_id} | Get Section Handler |
10
+ | [**getSectionsBulk**](SectionsApi.md#getsectionsbulk) | **GET** /v1/sections/bulk | Get Sections Bulk Handler |
10
11
  | [**updateSection**](SectionsApi.md#updatesectionoperation) | **PATCH** /v1/sections/{section_id} | Update Section Handler |
11
12
 
12
13
 
@@ -233,6 +234,80 @@ No authorization required
233
234
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
234
235
 
235
236
 
237
+ ## getSectionsBulk
238
+
239
+ > Array<SectionResponse> getSectionsBulk(sectionIds, authorization, ksUat)
240
+
241
+ Get Sections Bulk Handler
242
+
243
+ Batch-fetch sections by ID. Returns sections with system_metadata. Non-existent IDs are silently skipped. Limited to 200 IDs per call.
244
+
245
+ ### Example
246
+
247
+ ```ts
248
+ import {
249
+ Configuration,
250
+ SectionsApi,
251
+ } from '@knowledge-stack/ksapi';
252
+ import type { GetSectionsBulkRequest } from '@knowledge-stack/ksapi';
253
+
254
+ async function example() {
255
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
256
+ const api = new SectionsApi();
257
+
258
+ const body = {
259
+ // Array<string> | Section IDs to fetch (max 200) (optional)
260
+ sectionIds: ...,
261
+ // string (optional)
262
+ authorization: authorization_example,
263
+ // string (optional)
264
+ ksUat: ksUat_example,
265
+ } satisfies GetSectionsBulkRequest;
266
+
267
+ try {
268
+ const data = await api.getSectionsBulk(body);
269
+ console.log(data);
270
+ } catch (error) {
271
+ console.error(error);
272
+ }
273
+ }
274
+
275
+ // Run the test
276
+ example().catch(console.error);
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+
282
+ | Name | Type | Description | Notes |
283
+ |------------- | ------------- | ------------- | -------------|
284
+ | **sectionIds** | `Array<string>` | Section IDs to fetch (max 200) | [Optional] |
285
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
286
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
287
+
288
+ ### Return type
289
+
290
+ [**Array&lt;SectionResponse&gt;**](SectionResponse.md)
291
+
292
+ ### Authorization
293
+
294
+ No authorization required
295
+
296
+ ### HTTP request headers
297
+
298
+ - **Content-Type**: Not defined
299
+ - **Accept**: `application/json`
300
+
301
+
302
+ ### HTTP response details
303
+ | Status code | Description | Response headers |
304
+ |-------------|-------------|------------------|
305
+ | **200** | Successful Response | - |
306
+ | **422** | Validation Error | - |
307
+
308
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
309
+
310
+
236
311
  ## updateSection
237
312
 
238
313
  > SectionResponse updateSection(sectionId, updateSectionRequest, authorization, ksUat)