@knowledge-stack/ksapi 1.1.0 → 1.3.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 (63) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/README.md +2 -2
  3. package/dist/apis/FoldersApi.d.ts +179 -0
  4. package/dist/apis/FoldersApi.js +206 -0
  5. package/dist/apis/PathPartsApi.d.ts +65 -0
  6. package/dist/apis/PathPartsApi.js +79 -0
  7. package/dist/apis/index.d.ts +2 -0
  8. package/dist/apis/index.js +2 -0
  9. package/dist/esm/apis/FoldersApi.d.ts +179 -0
  10. package/dist/esm/apis/FoldersApi.js +202 -0
  11. package/dist/esm/apis/PathPartsApi.d.ts +65 -0
  12. package/dist/esm/apis/PathPartsApi.js +75 -0
  13. package/dist/esm/apis/index.d.ts +2 -0
  14. package/dist/esm/apis/index.js +2 -0
  15. package/dist/esm/models/CreateFolderRequest.d.ts +53 -0
  16. package/dist/esm/models/CreateFolderRequest.js +53 -0
  17. package/dist/esm/models/FolderResponse.d.ts +83 -0
  18. package/dist/esm/models/FolderResponse.js +68 -0
  19. package/dist/esm/models/PaginatedResponseFolderResponse.d.ts +66 -0
  20. package/dist/esm/models/PaginatedResponseFolderResponse.js +70 -0
  21. package/dist/esm/models/PaginatedResponsePathPartResponse.d.ts +66 -0
  22. package/dist/esm/models/PaginatedResponsePathPartResponse.js +70 -0
  23. package/dist/esm/models/PartType.d.ts +30 -0
  24. package/dist/esm/models/PartType.js +48 -0
  25. package/dist/esm/models/PathOrder.d.ts +32 -0
  26. package/dist/esm/models/PathOrder.js +50 -0
  27. package/dist/esm/models/PathPartResponse.d.ts +84 -0
  28. package/dist/esm/models/PathPartResponse.js +69 -0
  29. package/dist/esm/models/UpdateFolderRequest.d.ts +53 -0
  30. package/dist/esm/models/UpdateFolderRequest.js +49 -0
  31. package/dist/esm/models/index.d.ts +8 -0
  32. package/dist/esm/models/index.js +8 -0
  33. package/dist/models/CreateFolderRequest.d.ts +53 -0
  34. package/dist/models/CreateFolderRequest.js +61 -0
  35. package/dist/models/FolderResponse.d.ts +83 -0
  36. package/dist/models/FolderResponse.js +76 -0
  37. package/dist/models/PaginatedResponseFolderResponse.d.ts +66 -0
  38. package/dist/models/PaginatedResponseFolderResponse.js +78 -0
  39. package/dist/models/PaginatedResponsePathPartResponse.d.ts +66 -0
  40. package/dist/models/PaginatedResponsePathPartResponse.js +78 -0
  41. package/dist/models/PartType.d.ts +30 -0
  42. package/dist/models/PartType.js +56 -0
  43. package/dist/models/PathOrder.d.ts +32 -0
  44. package/dist/models/PathOrder.js +58 -0
  45. package/dist/models/PathPartResponse.d.ts +84 -0
  46. package/dist/models/PathPartResponse.js +77 -0
  47. package/dist/models/UpdateFolderRequest.d.ts +53 -0
  48. package/dist/models/UpdateFolderRequest.js +57 -0
  49. package/dist/models/index.d.ts +8 -0
  50. package/dist/models/index.js +8 -0
  51. package/package.json +1 -1
  52. package/src/apis/FoldersApi.ts +386 -0
  53. package/src/apis/PathPartsApi.ts +132 -0
  54. package/src/apis/index.ts +2 -0
  55. package/src/models/CreateFolderRequest.ts +96 -0
  56. package/src/models/FolderResponse.ts +137 -0
  57. package/src/models/PaginatedResponseFolderResponse.ts +130 -0
  58. package/src/models/PaginatedResponsePathPartResponse.ts +130 -0
  59. package/src/models/PartType.ts +58 -0
  60. package/src/models/PathOrder.ts +60 -0
  61. package/src/models/PathPartResponse.ts +147 -0
  62. package/src/models/UpdateFolderRequest.ts +94 -0
  63. package/src/models/index.ts +8 -0
@@ -0,0 +1,386 @@
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
+ import * as runtime from '../runtime';
17
+ import type {
18
+ CreateFolderRequest,
19
+ FolderResponse,
20
+ HTTPValidationError,
21
+ PaginatedResponseFolderResponse,
22
+ PathOrder,
23
+ UpdateFolderRequest,
24
+ } from '../models/index';
25
+ import {
26
+ CreateFolderRequestFromJSON,
27
+ CreateFolderRequestToJSON,
28
+ FolderResponseFromJSON,
29
+ FolderResponseToJSON,
30
+ HTTPValidationErrorFromJSON,
31
+ HTTPValidationErrorToJSON,
32
+ PaginatedResponseFolderResponseFromJSON,
33
+ PaginatedResponseFolderResponseToJSON,
34
+ PathOrderFromJSON,
35
+ PathOrderToJSON,
36
+ UpdateFolderRequestFromJSON,
37
+ UpdateFolderRequestToJSON,
38
+ } from '../models/index';
39
+
40
+ export interface CreateFolderOperationRequest {
41
+ createFolderRequest: CreateFolderRequest;
42
+ ksUat?: string;
43
+ }
44
+
45
+ export interface DeleteFolderRequest {
46
+ folderId: string;
47
+ ksUat?: string;
48
+ }
49
+
50
+ export interface GetFolderRequest {
51
+ folderId: string;
52
+ ksUat?: string;
53
+ }
54
+
55
+ export interface ListFoldersRequest {
56
+ parentId?: string;
57
+ sortOrder?: PathOrder;
58
+ limit?: number;
59
+ offset?: number;
60
+ ksUat?: string;
61
+ }
62
+
63
+ export interface UpdateFolderOperationRequest {
64
+ folderId: string;
65
+ updateFolderRequest: UpdateFolderRequest;
66
+ ksUat?: string;
67
+ }
68
+
69
+ /**
70
+ * FoldersApi - interface
71
+ *
72
+ * @export
73
+ * @interface FoldersApiInterface
74
+ */
75
+ export interface FoldersApiInterface {
76
+ /**
77
+ * Create a new folder. The folder is created as a child of the specified parent folder. It is automatically added to the end of the parent\'s children list.
78
+ * @summary Create Folder Handler
79
+ * @param {CreateFolderRequest} createFolderRequest
80
+ * @param {string} [ksUat]
81
+ * @param {*} [options] Override http request option.
82
+ * @throws {RequiredError}
83
+ * @memberof FoldersApiInterface
84
+ */
85
+ createFolderRaw(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>>;
86
+
87
+ /**
88
+ * Create a new folder. The folder is created as a child of the specified parent folder. It is automatically added to the end of the parent\'s children list.
89
+ * Create Folder Handler
90
+ */
91
+ createFolder(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
92
+
93
+ /**
94
+ * Delete a folder and all its contents. WARNING: This cascades to all children due to parent_id ON DELETE CASCADE. The root folder cannot be deleted.
95
+ * @summary Delete Folder Handler
96
+ * @param {string} folderId
97
+ * @param {string} [ksUat]
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ * @memberof FoldersApiInterface
101
+ */
102
+ deleteFolderRaw(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
103
+
104
+ /**
105
+ * Delete a folder and all its contents. WARNING: This cascades to all children due to parent_id ON DELETE CASCADE. The root folder cannot be deleted.
106
+ * Delete Folder Handler
107
+ */
108
+ deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
109
+
110
+ /**
111
+ * Get a folder by its folder ID.
112
+ * @summary Get Folder Handler
113
+ * @param {string} folderId
114
+ * @param {string} [ksUat]
115
+ * @param {*} [options] Override http request option.
116
+ * @throws {RequiredError}
117
+ * @memberof FoldersApiInterface
118
+ */
119
+ getFolderRaw(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>>;
120
+
121
+ /**
122
+ * Get a folder by its folder ID.
123
+ * Get Folder Handler
124
+ */
125
+ getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
126
+
127
+ /**
128
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
129
+ * @summary List Folders Handler
130
+ * @param {string} [parentId] Parent folder PathPart ID (defaults to root)
131
+ * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
132
+ * @param {number} [limit] Number of items per page
133
+ * @param {number} [offset] Number of items to skip
134
+ * @param {string} [ksUat]
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ * @memberof FoldersApiInterface
138
+ */
139
+ listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>>;
140
+
141
+ /**
142
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
143
+ * List Folders Handler
144
+ */
145
+ listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
146
+
147
+ /**
148
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
149
+ * @summary Update Folder Handler
150
+ * @param {string} folderId
151
+ * @param {UpdateFolderRequest} updateFolderRequest
152
+ * @param {string} [ksUat]
153
+ * @param {*} [options] Override http request option.
154
+ * @throws {RequiredError}
155
+ * @memberof FoldersApiInterface
156
+ */
157
+ updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>>;
158
+
159
+ /**
160
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
161
+ * Update Folder Handler
162
+ */
163
+ updateFolder(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
164
+
165
+ }
166
+
167
+ /**
168
+ *
169
+ */
170
+ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
171
+
172
+ /**
173
+ * Create a new folder. The folder is created as a child of the specified parent folder. It is automatically added to the end of the parent\'s children list.
174
+ * Create Folder Handler
175
+ */
176
+ async createFolderRaw(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>> {
177
+ if (requestParameters['createFolderRequest'] == null) {
178
+ throw new runtime.RequiredError(
179
+ 'createFolderRequest',
180
+ 'Required parameter "createFolderRequest" was null or undefined when calling createFolder().'
181
+ );
182
+ }
183
+
184
+ const queryParameters: any = {};
185
+
186
+ const headerParameters: runtime.HTTPHeaders = {};
187
+
188
+ headerParameters['Content-Type'] = 'application/json';
189
+
190
+
191
+ let urlPath = `/v1/folders`;
192
+
193
+ const response = await this.request({
194
+ path: urlPath,
195
+ method: 'POST',
196
+ headers: headerParameters,
197
+ query: queryParameters,
198
+ body: CreateFolderRequestToJSON(requestParameters['createFolderRequest']),
199
+ }, initOverrides);
200
+
201
+ return new runtime.JSONApiResponse(response, (jsonValue) => FolderResponseFromJSON(jsonValue));
202
+ }
203
+
204
+ /**
205
+ * Create a new folder. The folder is created as a child of the specified parent folder. It is automatically added to the end of the parent\'s children list.
206
+ * Create Folder Handler
207
+ */
208
+ async createFolder(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse> {
209
+ const response = await this.createFolderRaw(requestParameters, initOverrides);
210
+ return await response.value();
211
+ }
212
+
213
+ /**
214
+ * Delete a folder and all its contents. WARNING: This cascades to all children due to parent_id ON DELETE CASCADE. The root folder cannot be deleted.
215
+ * Delete Folder Handler
216
+ */
217
+ async deleteFolderRaw(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
218
+ if (requestParameters['folderId'] == null) {
219
+ throw new runtime.RequiredError(
220
+ 'folderId',
221
+ 'Required parameter "folderId" was null or undefined when calling deleteFolder().'
222
+ );
223
+ }
224
+
225
+ const queryParameters: any = {};
226
+
227
+ const headerParameters: runtime.HTTPHeaders = {};
228
+
229
+
230
+ let urlPath = `/v1/folders/{folder_id}`;
231
+ urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
232
+
233
+ const response = await this.request({
234
+ path: urlPath,
235
+ method: 'DELETE',
236
+ headers: headerParameters,
237
+ query: queryParameters,
238
+ }, initOverrides);
239
+
240
+ return new runtime.VoidApiResponse(response);
241
+ }
242
+
243
+ /**
244
+ * Delete a folder and all its contents. WARNING: This cascades to all children due to parent_id ON DELETE CASCADE. The root folder cannot be deleted.
245
+ * Delete Folder Handler
246
+ */
247
+ async deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
248
+ await this.deleteFolderRaw(requestParameters, initOverrides);
249
+ }
250
+
251
+ /**
252
+ * Get a folder by its folder ID.
253
+ * Get Folder Handler
254
+ */
255
+ async getFolderRaw(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>> {
256
+ if (requestParameters['folderId'] == null) {
257
+ throw new runtime.RequiredError(
258
+ 'folderId',
259
+ 'Required parameter "folderId" was null or undefined when calling getFolder().'
260
+ );
261
+ }
262
+
263
+ const queryParameters: any = {};
264
+
265
+ const headerParameters: runtime.HTTPHeaders = {};
266
+
267
+
268
+ let urlPath = `/v1/folders/{folder_id}`;
269
+ urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
270
+
271
+ const response = await this.request({
272
+ path: urlPath,
273
+ method: 'GET',
274
+ headers: headerParameters,
275
+ query: queryParameters,
276
+ }, initOverrides);
277
+
278
+ return new runtime.JSONApiResponse(response, (jsonValue) => FolderResponseFromJSON(jsonValue));
279
+ }
280
+
281
+ /**
282
+ * Get a folder by its folder ID.
283
+ * Get Folder Handler
284
+ */
285
+ async getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse> {
286
+ const response = await this.getFolderRaw(requestParameters, initOverrides);
287
+ return await response.value();
288
+ }
289
+
290
+ /**
291
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
292
+ * List Folders Handler
293
+ */
294
+ async listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>> {
295
+ const queryParameters: any = {};
296
+
297
+ if (requestParameters['parentId'] != null) {
298
+ queryParameters['parent_id'] = requestParameters['parentId'];
299
+ }
300
+
301
+ if (requestParameters['sortOrder'] != null) {
302
+ queryParameters['sort_order'] = requestParameters['sortOrder'];
303
+ }
304
+
305
+ if (requestParameters['limit'] != null) {
306
+ queryParameters['limit'] = requestParameters['limit'];
307
+ }
308
+
309
+ if (requestParameters['offset'] != null) {
310
+ queryParameters['offset'] = requestParameters['offset'];
311
+ }
312
+
313
+ const headerParameters: runtime.HTTPHeaders = {};
314
+
315
+
316
+ let urlPath = `/v1/folders`;
317
+
318
+ const response = await this.request({
319
+ path: urlPath,
320
+ method: 'GET',
321
+ headers: headerParameters,
322
+ query: queryParameters,
323
+ }, initOverrides);
324
+
325
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseFolderResponseFromJSON(jsonValue));
326
+ }
327
+
328
+ /**
329
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
330
+ * List Folders Handler
331
+ */
332
+ async listFolders(requestParameters: ListFoldersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse> {
333
+ const response = await this.listFoldersRaw(requestParameters, initOverrides);
334
+ return await response.value();
335
+ }
336
+
337
+ /**
338
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
339
+ * Update Folder Handler
340
+ */
341
+ async updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>> {
342
+ if (requestParameters['folderId'] == null) {
343
+ throw new runtime.RequiredError(
344
+ 'folderId',
345
+ 'Required parameter "folderId" was null or undefined when calling updateFolder().'
346
+ );
347
+ }
348
+
349
+ if (requestParameters['updateFolderRequest'] == null) {
350
+ throw new runtime.RequiredError(
351
+ 'updateFolderRequest',
352
+ 'Required parameter "updateFolderRequest" was null or undefined when calling updateFolder().'
353
+ );
354
+ }
355
+
356
+ const queryParameters: any = {};
357
+
358
+ const headerParameters: runtime.HTTPHeaders = {};
359
+
360
+ headerParameters['Content-Type'] = 'application/json';
361
+
362
+
363
+ let urlPath = `/v1/folders/{folder_id}`;
364
+ urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
365
+
366
+ const response = await this.request({
367
+ path: urlPath,
368
+ method: 'PATCH',
369
+ headers: headerParameters,
370
+ query: queryParameters,
371
+ body: UpdateFolderRequestToJSON(requestParameters['updateFolderRequest']),
372
+ }, initOverrides);
373
+
374
+ return new runtime.JSONApiResponse(response, (jsonValue) => FolderResponseFromJSON(jsonValue));
375
+ }
376
+
377
+ /**
378
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
379
+ * Update Folder Handler
380
+ */
381
+ async updateFolder(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse> {
382
+ const response = await this.updateFolderRaw(requestParameters, initOverrides);
383
+ return await response.value();
384
+ }
385
+
386
+ }
@@ -0,0 +1,132 @@
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
+ import * as runtime from '../runtime';
17
+ import type {
18
+ HTTPValidationError,
19
+ PaginatedResponsePathPartResponse,
20
+ PathOrder,
21
+ } from '../models/index';
22
+ import {
23
+ HTTPValidationErrorFromJSON,
24
+ HTTPValidationErrorToJSON,
25
+ PaginatedResponsePathPartResponseFromJSON,
26
+ PaginatedResponsePathPartResponseToJSON,
27
+ PathOrderFromJSON,
28
+ PathOrderToJSON,
29
+ } from '../models/index';
30
+
31
+ export interface ListPathPartsRequest {
32
+ parentId?: string;
33
+ includeDocuments?: boolean;
34
+ maxDepth?: number;
35
+ sortOrder?: PathOrder;
36
+ limit?: number;
37
+ offset?: number;
38
+ ksUat?: string;
39
+ }
40
+
41
+ /**
42
+ * PathPartsApi - interface
43
+ *
44
+ * @export
45
+ * @interface PathPartsApiInterface
46
+ */
47
+ export interface PathPartsApiInterface {
48
+ /**
49
+ * List path parts under a parent with flexible filtering and traversal. This is a generic endpoint for traversing the path hierarchy. It can return folders, documents, or both depending on the filters provided. - If parent_id is not provided, lists contents of the root folder. - If include_documents is True, includes both FOLDER and DOCUMENT types. Documents act as traversal boundaries (their children are not traversed). - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.
50
+ * @summary List Path Parts Handler
51
+ * @param {string} [parentId] Parent PathPart ID (defaults to root)
52
+ * @param {boolean} [includeDocuments] Include documents in results (default: False, folders only)
53
+ * @param {number} [maxDepth] Maximum depth to traverse (1 &#x3D; direct children, default: 1)
54
+ * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
55
+ * @param {number} [limit] Number of items per page
56
+ * @param {number} [offset] Number of items to skip
57
+ * @param {string} [ksUat]
58
+ * @param {*} [options] Override http request option.
59
+ * @throws {RequiredError}
60
+ * @memberof PathPartsApiInterface
61
+ */
62
+ listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>>;
63
+
64
+ /**
65
+ * List path parts under a parent with flexible filtering and traversal. This is a generic endpoint for traversing the path hierarchy. It can return folders, documents, or both depending on the filters provided. - If parent_id is not provided, lists contents of the root folder. - If include_documents is True, includes both FOLDER and DOCUMENT types. Documents act as traversal boundaries (their children are not traversed). - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.
66
+ * List Path Parts Handler
67
+ */
68
+ listPathParts(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse>;
69
+
70
+ }
71
+
72
+ /**
73
+ *
74
+ */
75
+ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterface {
76
+
77
+ /**
78
+ * List path parts under a parent with flexible filtering and traversal. This is a generic endpoint for traversing the path hierarchy. It can return folders, documents, or both depending on the filters provided. - If parent_id is not provided, lists contents of the root folder. - If include_documents is True, includes both FOLDER and DOCUMENT types. Documents act as traversal boundaries (their children are not traversed). - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.
79
+ * List Path Parts Handler
80
+ */
81
+ async listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>> {
82
+ const queryParameters: any = {};
83
+
84
+ if (requestParameters['parentId'] != null) {
85
+ queryParameters['parent_id'] = requestParameters['parentId'];
86
+ }
87
+
88
+ if (requestParameters['includeDocuments'] != null) {
89
+ queryParameters['include_documents'] = requestParameters['includeDocuments'];
90
+ }
91
+
92
+ if (requestParameters['maxDepth'] != null) {
93
+ queryParameters['max_depth'] = requestParameters['maxDepth'];
94
+ }
95
+
96
+ if (requestParameters['sortOrder'] != null) {
97
+ queryParameters['sort_order'] = requestParameters['sortOrder'];
98
+ }
99
+
100
+ if (requestParameters['limit'] != null) {
101
+ queryParameters['limit'] = requestParameters['limit'];
102
+ }
103
+
104
+ if (requestParameters['offset'] != null) {
105
+ queryParameters['offset'] = requestParameters['offset'];
106
+ }
107
+
108
+ const headerParameters: runtime.HTTPHeaders = {};
109
+
110
+
111
+ let urlPath = `/v1/path-parts`;
112
+
113
+ const response = await this.request({
114
+ path: urlPath,
115
+ method: 'GET',
116
+ headers: headerParameters,
117
+ query: queryParameters,
118
+ }, initOverrides);
119
+
120
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponsePathPartResponseFromJSON(jsonValue));
121
+ }
122
+
123
+ /**
124
+ * List path parts under a parent with flexible filtering and traversal. This is a generic endpoint for traversing the path hierarchy. It can return folders, documents, or both depending on the filters provided. - If parent_id is not provided, lists contents of the root folder. - If include_documents is True, includes both FOLDER and DOCUMENT types. Documents act as traversal boundaries (their children are not traversed). - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.
125
+ * List Path Parts Handler
126
+ */
127
+ async listPathParts(requestParameters: ListPathPartsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse> {
128
+ const response = await this.listPathPartsRaw(requestParameters, initOverrides);
129
+ return await response.value();
130
+ }
131
+
132
+ }
package/src/apis/index.ts CHANGED
@@ -2,6 +2,8 @@
2
2
  /* eslint-disable */
3
3
  export * from './AuthApi';
4
4
  export * from './DefaultApi';
5
+ export * from './FoldersApi';
5
6
  export * from './InvitesApi';
7
+ export * from './PathPartsApi';
6
8
  export * from './TenantsApi';
7
9
  export * from './UsersApi';
@@ -0,0 +1,96 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * Request to create a new folder.
18
+ * @export
19
+ * @interface CreateFolderRequest
20
+ */
21
+ export interface CreateFolderRequest {
22
+ /**
23
+ * Folder name
24
+ * @type {string}
25
+ * @memberof CreateFolderRequest
26
+ */
27
+ name: string;
28
+ /**
29
+ * Parent folder PathPart ID
30
+ * @type {string}
31
+ * @memberof CreateFolderRequest
32
+ */
33
+ parentId: string;
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the CreateFolderRequest interface.
38
+ */
39
+ export function instanceOfCreateFolderRequest(value: object): value is CreateFolderRequest {
40
+ if (!('name' in value) || value['name'] === undefined) return false;
41
+ if (!('parentId' in value) || value['parentId'] === undefined) return false;
42
+ return true;
43
+ }
44
+
45
+ export function CreateFolderRequestFromJSON(json: any): CreateFolderRequest {
46
+ return CreateFolderRequestFromJSONTyped(json, false);
47
+ }
48
+
49
+ export function CreateFolderRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFolderRequest {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+
55
+ 'name': json['name'],
56
+ 'parentId': json['parent_id'],
57
+ };
58
+ }
59
+
60
+ export function CreateFolderRequestToJSON(json: any): CreateFolderRequest {
61
+ return CreateFolderRequestToJSONTyped(json, false);
62
+ }
63
+
64
+ export function CreateFolderRequestToJSONTyped(value?: CreateFolderRequest | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'name': value['name'],
72
+ 'parent_id': value['parentId'],
73
+ };
74
+ }
75
+
76
+ export const CreateFolderRequestPropertyValidationAttributesMap: {
77
+ [property: string]: {
78
+ maxLength?: number,
79
+ minLength?: number,
80
+ pattern?: string,
81
+ maximum?: number,
82
+ exclusiveMaximum?: boolean,
83
+ minimum?: number,
84
+ exclusiveMinimum?: boolean,
85
+ multipleOf?: number,
86
+ maxItems?: number,
87
+ minItems?: number,
88
+ uniqueItems?: boolean
89
+ }
90
+ } = {
91
+ name: {
92
+ maxLength: 255,
93
+ minLength: 1,
94
+ },
95
+ }
96
+