@knowledge-stack/ksapi 1.8.0 → 1.9.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 (43) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +2 -2
  3. package/dist/apis/DocumentVersionsApi.d.ts +36 -1
  4. package/dist/apis/DocumentVersionsApi.js +41 -0
  5. package/dist/apis/FoldersApi.d.ts +38 -1
  6. package/dist/apis/FoldersApi.js +44 -0
  7. package/dist/apis/PathPartsApi.d.ts +4 -6
  8. package/dist/apis/PathPartsApi.js +2 -5
  9. package/dist/esm/apis/DocumentVersionsApi.d.ts +36 -1
  10. package/dist/esm/apis/DocumentVersionsApi.js +42 -1
  11. package/dist/esm/apis/FoldersApi.d.ts +38 -1
  12. package/dist/esm/apis/FoldersApi.js +45 -1
  13. package/dist/esm/apis/PathPartsApi.d.ts +4 -6
  14. package/dist/esm/apis/PathPartsApi.js +2 -5
  15. package/dist/esm/models/DocumentContentPathPart.d.ts +119 -0
  16. package/dist/esm/models/DocumentContentPathPart.js +83 -0
  17. package/dist/esm/models/FolderDocumentResponse.d.ts +138 -0
  18. package/dist/esm/models/FolderDocumentResponse.js +88 -0
  19. package/dist/esm/models/PaginatedResponseDocumentContentPathPart.d.ts +66 -0
  20. package/dist/esm/models/PaginatedResponseDocumentContentPathPart.js +70 -0
  21. package/dist/esm/models/PaginatedResponseFolderDocumentResponse.d.ts +66 -0
  22. package/dist/esm/models/PaginatedResponseFolderDocumentResponse.js +70 -0
  23. package/dist/esm/models/index.d.ts +4 -0
  24. package/dist/esm/models/index.js +4 -0
  25. package/dist/models/DocumentContentPathPart.d.ts +119 -0
  26. package/dist/models/DocumentContentPathPart.js +91 -0
  27. package/dist/models/FolderDocumentResponse.d.ts +138 -0
  28. package/dist/models/FolderDocumentResponse.js +96 -0
  29. package/dist/models/PaginatedResponseDocumentContentPathPart.d.ts +66 -0
  30. package/dist/models/PaginatedResponseDocumentContentPathPart.js +78 -0
  31. package/dist/models/PaginatedResponseFolderDocumentResponse.d.ts +66 -0
  32. package/dist/models/PaginatedResponseFolderDocumentResponse.js +78 -0
  33. package/dist/models/index.d.ts +4 -0
  34. package/dist/models/index.js +4 -0
  35. package/package.json +1 -1
  36. package/src/apis/DocumentVersionsApi.ts +82 -0
  37. package/src/apis/FoldersApi.ts +88 -0
  38. package/src/apis/PathPartsApi.ts +4 -10
  39. package/src/models/DocumentContentPathPart.ts +205 -0
  40. package/src/models/FolderDocumentResponse.ts +234 -0
  41. package/src/models/PaginatedResponseDocumentContentPathPart.ts +130 -0
  42. package/src/models/PaginatedResponseFolderDocumentResponse.ts +130 -0
  43. package/src/models/index.ts +4 -0
@@ -26,12 +26,14 @@ src/models/CreateFolderRequest.ts
26
26
  src/models/CreatePasswordUserRequest.ts
27
27
  src/models/CreateSectionRequest.ts
28
28
  src/models/CreateTenantRequest.ts
29
+ src/models/DocumentContentPathPart.ts
29
30
  src/models/DocumentOrigin.ts
30
31
  src/models/DocumentResponse.ts
31
32
  src/models/DocumentType.ts
32
33
  src/models/DocumentVersionResponse.ts
33
34
  src/models/EmailSentResponse.ts
34
35
  src/models/EmailVerificationRequest.ts
36
+ src/models/FolderDocumentResponse.ts
35
37
  src/models/FolderResponse.ts
36
38
  src/models/HTTPValidationError.ts
37
39
  src/models/HealthCheckResponse.ts
@@ -40,8 +42,10 @@ src/models/InviteResponse.ts
40
42
  src/models/InviteStatus.ts
41
43
  src/models/InviteUserRequest.ts
42
44
  src/models/OAuth2Config.ts
45
+ src/models/PaginatedResponseDocumentContentPathPart.ts
43
46
  src/models/PaginatedResponseDocumentResponse.ts
44
47
  src/models/PaginatedResponseDocumentVersionResponse.ts
48
+ src/models/PaginatedResponseFolderDocumentResponse.ts
45
49
  src/models/PaginatedResponseFolderResponse.ts
46
50
  src/models/PaginatedResponseInviteResponse.ts
47
51
  src/models/PaginatedResponsePathPartResponse.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @knowledge-stack/ksapi@1.8.0
1
+ ## @knowledge-stack/ksapi@1.9.0
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @knowledge-stack/ksapi@1.8.0 --save
39
+ npm install @knowledge-stack/ksapi@1.9.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { DocumentVersionResponse, PaginatedResponseDocumentVersionResponse } from '../models/index';
13
+ import type { DocumentVersionResponse, PaginatedResponseDocumentContentPathPart, PaginatedResponseDocumentVersionResponse } from '../models/index';
14
14
  export interface CreateDocumentVersionRequest {
15
15
  documentId: string;
16
16
  ksUat?: string;
@@ -23,6 +23,13 @@ export interface GetDocumentVersionRequest {
23
23
  versionId: string;
24
24
  ksUat?: string;
25
25
  }
26
+ export interface GetDocumentVersionContentsRequest {
27
+ versionId: string;
28
+ sectionId?: string;
29
+ limit?: number;
30
+ offset?: number;
31
+ ksUat?: string;
32
+ }
26
33
  export interface ListDocumentVersionsRequest {
27
34
  documentId: string;
28
35
  limit?: number;
@@ -81,6 +88,24 @@ export interface DocumentVersionsApiInterface {
81
88
  * Get Document Version Handler
82
89
  */
83
90
  getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
91
+ /**
92
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
93
+ * @summary Get Document Version Contents Handler
94
+ * @param {string} versionId DocumentVersion ID
95
+ * @param {string} [sectionId] Optional section ID to scope traversal to a subtree
96
+ * @param {number} [limit] Number of items per page
97
+ * @param {number} [offset] Number of items to skip
98
+ * @param {string} [ksUat]
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ * @memberof DocumentVersionsApiInterface
102
+ */
103
+ getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>>;
104
+ /**
105
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
106
+ * Get Document Version Contents Handler
107
+ */
108
+ getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart>;
84
109
  /**
85
110
  * List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
86
111
  * @summary List Document Versions Handler
@@ -133,6 +158,16 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
133
158
  * Get Document Version Handler
134
159
  */
135
160
  getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
161
+ /**
162
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
163
+ * Get Document Version Contents Handler
164
+ */
165
+ getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>>;
166
+ /**
167
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
168
+ * Get Document Version Contents Handler
169
+ */
170
+ getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart>;
136
171
  /**
137
172
  * List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
138
173
  * List Document Versions Handler
@@ -124,6 +124,47 @@ class DocumentVersionsApi extends runtime.BaseAPI {
124
124
  return yield response.value();
125
125
  });
126
126
  }
127
+ /**
128
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
129
+ * Get Document Version Contents Handler
130
+ */
131
+ getDocumentVersionContentsRaw(requestParameters, initOverrides) {
132
+ return __awaiter(this, void 0, void 0, function* () {
133
+ if (requestParameters['versionId'] == null) {
134
+ throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getDocumentVersionContents().');
135
+ }
136
+ const queryParameters = {};
137
+ if (requestParameters['sectionId'] != null) {
138
+ queryParameters['section_id'] = requestParameters['sectionId'];
139
+ }
140
+ if (requestParameters['limit'] != null) {
141
+ queryParameters['limit'] = requestParameters['limit'];
142
+ }
143
+ if (requestParameters['offset'] != null) {
144
+ queryParameters['offset'] = requestParameters['offset'];
145
+ }
146
+ const headerParameters = {};
147
+ let urlPath = `/v1/document_versions/{version_id}/contents`;
148
+ urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
149
+ const response = yield this.request({
150
+ path: urlPath,
151
+ method: 'GET',
152
+ headers: headerParameters,
153
+ query: queryParameters,
154
+ }, initOverrides);
155
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseDocumentContentPathPartFromJSON)(jsonValue));
156
+ });
157
+ }
158
+ /**
159
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
160
+ * Get Document Version Contents Handler
161
+ */
162
+ getDocumentVersionContents(requestParameters, initOverrides) {
163
+ return __awaiter(this, void 0, void 0, function* () {
164
+ const response = yield this.getDocumentVersionContentsRaw(requestParameters, initOverrides);
165
+ return yield response.value();
166
+ });
167
+ }
127
168
  /**
128
169
  * List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
129
170
  * List Document Versions Handler
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { CreateFolderRequest, FolderResponse, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
13
+ import type { CreateFolderRequest, FolderResponse, PaginatedResponseFolderDocumentResponse, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
14
14
  export interface CreateFolderOperationRequest {
15
15
  createFolderRequest: CreateFolderRequest;
16
16
  ksUat?: string;
@@ -23,6 +23,14 @@ export interface GetFolderRequest {
23
23
  folderId: string;
24
24
  ksUat?: string;
25
25
  }
26
+ export interface ListFolderContentsRequest {
27
+ folderId: string;
28
+ maxDepth?: number;
29
+ sortOrder?: PathOrder;
30
+ limit?: number;
31
+ offset?: number;
32
+ ksUat?: string;
33
+ }
26
34
  export interface ListFoldersRequest {
27
35
  parentId?: string;
28
36
  sortOrder?: PathOrder;
@@ -87,6 +95,25 @@ export interface FoldersApiInterface {
87
95
  * Get Folder Handler
88
96
  */
89
97
  getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
98
+ /**
99
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
100
+ * @summary List Folder Contents Handler
101
+ * @param {string} folderId
102
+ * @param {number} [maxDepth] Maximum depth to traverse (1&#x3D;direct children, default: 1)
103
+ * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
104
+ * @param {number} [limit] Number of items per page
105
+ * @param {number} [offset] Number of items to skip
106
+ * @param {string} [ksUat]
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ * @memberof FoldersApiInterface
110
+ */
111
+ listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
112
+ /**
113
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
114
+ * List Folder Contents Handler
115
+ */
116
+ listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
90
117
  /**
91
118
  * 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.
92
119
  * @summary List Folders Handler
@@ -156,6 +183,16 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
156
183
  * Get Folder Handler
157
184
  */
158
185
  getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
186
+ /**
187
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
188
+ * List Folder Contents Handler
189
+ */
190
+ listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
191
+ /**
192
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
193
+ * List Folder Contents Handler
194
+ */
195
+ listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
159
196
  /**
160
197
  * 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.
161
198
  * List Folders Handler
@@ -125,6 +125,50 @@ class FoldersApi extends runtime.BaseAPI {
125
125
  return yield response.value();
126
126
  });
127
127
  }
128
+ /**
129
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
130
+ * List Folder Contents Handler
131
+ */
132
+ listFolderContentsRaw(requestParameters, initOverrides) {
133
+ return __awaiter(this, void 0, void 0, function* () {
134
+ if (requestParameters['folderId'] == null) {
135
+ throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling listFolderContents().');
136
+ }
137
+ const queryParameters = {};
138
+ if (requestParameters['maxDepth'] != null) {
139
+ queryParameters['max_depth'] = requestParameters['maxDepth'];
140
+ }
141
+ if (requestParameters['sortOrder'] != null) {
142
+ queryParameters['sort_order'] = requestParameters['sortOrder'];
143
+ }
144
+ if (requestParameters['limit'] != null) {
145
+ queryParameters['limit'] = requestParameters['limit'];
146
+ }
147
+ if (requestParameters['offset'] != null) {
148
+ queryParameters['offset'] = requestParameters['offset'];
149
+ }
150
+ const headerParameters = {};
151
+ let urlPath = `/v1/folders/{folder_id}/contents`;
152
+ urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
153
+ const response = yield this.request({
154
+ path: urlPath,
155
+ method: 'GET',
156
+ headers: headerParameters,
157
+ query: queryParameters,
158
+ }, initOverrides);
159
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseFolderDocumentResponseFromJSON)(jsonValue));
160
+ });
161
+ }
162
+ /**
163
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
164
+ * List Folder Contents Handler
165
+ */
166
+ listFolderContents(requestParameters, initOverrides) {
167
+ return __awaiter(this, void 0, void 0, function* () {
168
+ const response = yield this.listFolderContentsRaw(requestParameters, initOverrides);
169
+ return yield response.value();
170
+ });
171
+ }
128
172
  /**
129
173
  * 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.
130
174
  * List Folders Handler
@@ -17,7 +17,6 @@ export interface GetPathPartRequest {
17
17
  }
18
18
  export interface ListPathPartsRequest {
19
19
  parentId?: string;
20
- includeDocuments?: boolean;
21
20
  maxDepth?: number;
22
21
  sortOrder?: PathOrder;
23
22
  limit?: number;
@@ -47,10 +46,9 @@ export interface PathPartsApiInterface {
47
46
  */
48
47
  getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
49
48
  /**
50
- * 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.
49
+ * List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
51
50
  * @summary List Path Parts Handler
52
51
  * @param {string} [parentId] Parent PathPart ID (defaults to root)
53
- * @param {boolean} [includeDocuments] Include documents in results (default: False, folders only)
54
52
  * @param {number} [maxDepth] Maximum depth to traverse (1 &#x3D; direct children, default: 1)
55
53
  * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
56
54
  * @param {number} [limit] Number of items per page
@@ -62,7 +60,7 @@ export interface PathPartsApiInterface {
62
60
  */
63
61
  listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>>;
64
62
  /**
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.
63
+ * List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
66
64
  * List Path Parts Handler
67
65
  */
68
66
  listPathParts(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse>;
@@ -82,12 +80,12 @@ export declare class PathPartsApi extends runtime.BaseAPI implements PathPartsAp
82
80
  */
83
81
  getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
84
82
  /**
85
- * 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.
83
+ * List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
86
84
  * List Path Parts Handler
87
85
  */
88
86
  listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>>;
89
87
  /**
90
- * 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.
88
+ * List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
91
89
  * List Path Parts Handler
92
90
  */
93
91
  listPathParts(requestParameters?: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse>;
@@ -62,7 +62,7 @@ class PathPartsApi extends runtime.BaseAPI {
62
62
  });
63
63
  }
64
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.
65
+ * List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
66
66
  * List Path Parts Handler
67
67
  */
68
68
  listPathPartsRaw(requestParameters, initOverrides) {
@@ -71,9 +71,6 @@ class PathPartsApi extends runtime.BaseAPI {
71
71
  if (requestParameters['parentId'] != null) {
72
72
  queryParameters['parent_id'] = requestParameters['parentId'];
73
73
  }
74
- if (requestParameters['includeDocuments'] != null) {
75
- queryParameters['include_documents'] = requestParameters['includeDocuments'];
76
- }
77
74
  if (requestParameters['maxDepth'] != null) {
78
75
  queryParameters['max_depth'] = requestParameters['maxDepth'];
79
76
  }
@@ -98,7 +95,7 @@ class PathPartsApi extends runtime.BaseAPI {
98
95
  });
99
96
  }
100
97
  /**
101
- * 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.
98
+ * List path parts (folders) under a parent with traversal. This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts. - If parent_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT. For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
102
99
  * List Path Parts Handler
103
100
  */
104
101
  listPathParts() {
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { DocumentVersionResponse, PaginatedResponseDocumentVersionResponse } from '../models/index';
13
+ import type { DocumentVersionResponse, PaginatedResponseDocumentContentPathPart, PaginatedResponseDocumentVersionResponse } from '../models/index';
14
14
  export interface CreateDocumentVersionRequest {
15
15
  documentId: string;
16
16
  ksUat?: string;
@@ -23,6 +23,13 @@ export interface GetDocumentVersionRequest {
23
23
  versionId: string;
24
24
  ksUat?: string;
25
25
  }
26
+ export interface GetDocumentVersionContentsRequest {
27
+ versionId: string;
28
+ sectionId?: string;
29
+ limit?: number;
30
+ offset?: number;
31
+ ksUat?: string;
32
+ }
26
33
  export interface ListDocumentVersionsRequest {
27
34
  documentId: string;
28
35
  limit?: number;
@@ -81,6 +88,24 @@ export interface DocumentVersionsApiInterface {
81
88
  * Get Document Version Handler
82
89
  */
83
90
  getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
91
+ /**
92
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
93
+ * @summary Get Document Version Contents Handler
94
+ * @param {string} versionId DocumentVersion ID
95
+ * @param {string} [sectionId] Optional section ID to scope traversal to a subtree
96
+ * @param {number} [limit] Number of items per page
97
+ * @param {number} [offset] Number of items to skip
98
+ * @param {string} [ksUat]
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ * @memberof DocumentVersionsApiInterface
102
+ */
103
+ getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>>;
104
+ /**
105
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
106
+ * Get Document Version Contents Handler
107
+ */
108
+ getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart>;
84
109
  /**
85
110
  * List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
86
111
  * @summary List Document Versions Handler
@@ -133,6 +158,16 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
133
158
  * Get Document Version Handler
134
159
  */
135
160
  getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
161
+ /**
162
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
163
+ * Get Document Version Contents Handler
164
+ */
165
+ getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentContentPathPart>>;
166
+ /**
167
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
168
+ * Get Document Version Contents Handler
169
+ */
170
+ getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentContentPathPart>;
136
171
  /**
137
172
  * List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
138
173
  * List Document Versions Handler
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { DocumentVersionResponseFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
24
+ import { DocumentVersionResponseFromJSON, PaginatedResponseDocumentContentPathPartFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -121,6 +121,47 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
121
121
  return yield response.value();
122
122
  });
123
123
  }
124
+ /**
125
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
126
+ * Get Document Version Contents Handler
127
+ */
128
+ getDocumentVersionContentsRaw(requestParameters, initOverrides) {
129
+ return __awaiter(this, void 0, void 0, function* () {
130
+ if (requestParameters['versionId'] == null) {
131
+ throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getDocumentVersionContents().');
132
+ }
133
+ const queryParameters = {};
134
+ if (requestParameters['sectionId'] != null) {
135
+ queryParameters['section_id'] = requestParameters['sectionId'];
136
+ }
137
+ if (requestParameters['limit'] != null) {
138
+ queryParameters['limit'] = requestParameters['limit'];
139
+ }
140
+ if (requestParameters['offset'] != null) {
141
+ queryParameters['offset'] = requestParameters['offset'];
142
+ }
143
+ const headerParameters = {};
144
+ let urlPath = `/v1/document_versions/{version_id}/contents`;
145
+ urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
146
+ const response = yield this.request({
147
+ path: urlPath,
148
+ method: 'GET',
149
+ headers: headerParameters,
150
+ query: queryParameters,
151
+ }, initOverrides);
152
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseDocumentContentPathPartFromJSON(jsonValue));
153
+ });
154
+ }
155
+ /**
156
+ * List all sections and chunks for a document version in depth-first logical order. Returns a flat paginated list that can be used to reconstruct the section/chunk hierarchy with content. Sections include page_number; chunks include content, chunk_type, and chunk_metadata.
157
+ * Get Document Version Contents Handler
158
+ */
159
+ getDocumentVersionContents(requestParameters, initOverrides) {
160
+ return __awaiter(this, void 0, void 0, function* () {
161
+ const response = yield this.getDocumentVersionContentsRaw(requestParameters, initOverrides);
162
+ return yield response.value();
163
+ });
164
+ }
124
165
  /**
125
166
  * List all versions for a document. Returns versions ordered by version number ascending (v0, v1, v2...).
126
167
  * List Document Versions Handler
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { CreateFolderRequest, FolderResponse, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
13
+ import type { CreateFolderRequest, FolderResponse, PaginatedResponseFolderDocumentResponse, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
14
14
  export interface CreateFolderOperationRequest {
15
15
  createFolderRequest: CreateFolderRequest;
16
16
  ksUat?: string;
@@ -23,6 +23,14 @@ export interface GetFolderRequest {
23
23
  folderId: string;
24
24
  ksUat?: string;
25
25
  }
26
+ export interface ListFolderContentsRequest {
27
+ folderId: string;
28
+ maxDepth?: number;
29
+ sortOrder?: PathOrder;
30
+ limit?: number;
31
+ offset?: number;
32
+ ksUat?: string;
33
+ }
26
34
  export interface ListFoldersRequest {
27
35
  parentId?: string;
28
36
  sortOrder?: PathOrder;
@@ -87,6 +95,25 @@ export interface FoldersApiInterface {
87
95
  * Get Folder Handler
88
96
  */
89
97
  getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
98
+ /**
99
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
100
+ * @summary List Folder Contents Handler
101
+ * @param {string} folderId
102
+ * @param {number} [maxDepth] Maximum depth to traverse (1&#x3D;direct children, default: 1)
103
+ * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
104
+ * @param {number} [limit] Number of items per page
105
+ * @param {number} [offset] Number of items to skip
106
+ * @param {string} [ksUat]
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ * @memberof FoldersApiInterface
110
+ */
111
+ listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
112
+ /**
113
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
114
+ * List Folder Contents Handler
115
+ */
116
+ listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
90
117
  /**
91
118
  * 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.
92
119
  * @summary List Folders Handler
@@ -156,6 +183,16 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
156
183
  * Get Folder Handler
157
184
  */
158
185
  getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
186
+ /**
187
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
188
+ * List Folder Contents Handler
189
+ */
190
+ listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
191
+ /**
192
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
193
+ * List Folder Contents Handler
194
+ */
195
+ listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
159
196
  /**
160
197
  * 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.
161
198
  * List Folders Handler
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { CreateFolderRequestToJSON, FolderResponseFromJSON, PaginatedResponseFolderResponseFromJSON, UpdateFolderRequestToJSON, } from '../models/index';
24
+ import { CreateFolderRequestToJSON, FolderResponseFromJSON, PaginatedResponseFolderDocumentResponseFromJSON, PaginatedResponseFolderResponseFromJSON, UpdateFolderRequestToJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -122,6 +122,50 @@ export class FoldersApi extends runtime.BaseAPI {
122
122
  return yield response.value();
123
123
  });
124
124
  }
125
+ /**
126
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
127
+ * List Folder Contents Handler
128
+ */
129
+ listFolderContentsRaw(requestParameters, initOverrides) {
130
+ return __awaiter(this, void 0, void 0, function* () {
131
+ if (requestParameters['folderId'] == null) {
132
+ throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling listFolderContents().');
133
+ }
134
+ const queryParameters = {};
135
+ if (requestParameters['maxDepth'] != null) {
136
+ queryParameters['max_depth'] = requestParameters['maxDepth'];
137
+ }
138
+ if (requestParameters['sortOrder'] != null) {
139
+ queryParameters['sort_order'] = requestParameters['sortOrder'];
140
+ }
141
+ if (requestParameters['limit'] != null) {
142
+ queryParameters['limit'] = requestParameters['limit'];
143
+ }
144
+ if (requestParameters['offset'] != null) {
145
+ queryParameters['offset'] = requestParameters['offset'];
146
+ }
147
+ const headerParameters = {};
148
+ let urlPath = `/v1/folders/{folder_id}/contents`;
149
+ urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
150
+ const response = yield this.request({
151
+ path: urlPath,
152
+ method: 'GET',
153
+ headers: headerParameters,
154
+ query: queryParameters,
155
+ }, initOverrides);
156
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseFolderDocumentResponseFromJSON(jsonValue));
157
+ });
158
+ }
159
+ /**
160
+ * List all contents (folders and documents) under a folder. Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
161
+ * List Folder Contents Handler
162
+ */
163
+ listFolderContents(requestParameters, initOverrides) {
164
+ return __awaiter(this, void 0, void 0, function* () {
165
+ const response = yield this.listFolderContentsRaw(requestParameters, initOverrides);
166
+ return yield response.value();
167
+ });
168
+ }
125
169
  /**
126
170
  * 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.
127
171
  * List Folders Handler