@knowledge-stack/ksapi 1.23.4 → 1.24.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 (298) hide show
  1. package/.openapi-generator/FILES +125 -6
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +274 -28
  4. package/dist/apis/AuthApi.d.ts +117 -0
  5. package/dist/apis/AuthApi.js +137 -47
  6. package/dist/apis/ChunkLineagesApi.d.ts +38 -0
  7. package/dist/apis/ChunkLineagesApi.js +42 -15
  8. package/dist/apis/ChunksApi.d.ts +78 -4
  9. package/dist/apis/ChunksApi.js +85 -31
  10. package/dist/apis/DefaultApi.d.ts +20 -0
  11. package/dist/apis/DefaultApi.js +28 -10
  12. package/dist/apis/DocumentVersionsApi.d.ts +99 -9
  13. package/dist/apis/DocumentVersionsApi.js +100 -37
  14. package/dist/apis/DocumentsApi.d.ts +80 -0
  15. package/dist/apis/DocumentsApi.js +84 -30
  16. package/dist/apis/FoldersApi.d.ts +92 -9
  17. package/dist/apis/FoldersApi.js +86 -32
  18. package/dist/apis/InvitesApi.d.ts +51 -0
  19. package/dist/apis/InvitesApi.js +56 -20
  20. package/dist/apis/PathPartsApi.d.ts +54 -0
  21. package/dist/apis/PathPartsApi.js +56 -20
  22. package/dist/apis/SectionsApi.d.ts +49 -0
  23. package/dist/apis/SectionsApi.js +56 -20
  24. package/dist/apis/TagsApi.d.ts +62 -0
  25. package/dist/apis/TagsApi.js +70 -25
  26. package/dist/apis/TenantsApi.d.ts +172 -5
  27. package/dist/apis/TenantsApi.js +179 -31
  28. package/dist/apis/ThreadMessagesApi.d.ts +41 -0
  29. package/dist/apis/ThreadMessagesApi.js +42 -15
  30. package/dist/apis/ThreadsApi.d.ts +77 -0
  31. package/dist/apis/ThreadsApi.js +84 -30
  32. package/dist/apis/UserPermissionsApi.d.ts +54 -0
  33. package/dist/apis/UserPermissionsApi.js +56 -20
  34. package/dist/apis/UsersApi.d.ts +23 -0
  35. package/dist/apis/UsersApi.js +28 -10
  36. package/dist/apis/WorkflowsApi.d.ts +38 -0
  37. package/dist/apis/WorkflowsApi.js +42 -15
  38. package/dist/esm/apis/AuthApi.d.ts +117 -0
  39. package/dist/esm/apis/AuthApi.js +137 -47
  40. package/dist/esm/apis/ChunkLineagesApi.d.ts +38 -0
  41. package/dist/esm/apis/ChunkLineagesApi.js +42 -15
  42. package/dist/esm/apis/ChunksApi.d.ts +78 -4
  43. package/dist/esm/apis/ChunksApi.js +85 -31
  44. package/dist/esm/apis/DefaultApi.d.ts +20 -0
  45. package/dist/esm/apis/DefaultApi.js +28 -10
  46. package/dist/esm/apis/DocumentVersionsApi.d.ts +99 -9
  47. package/dist/esm/apis/DocumentVersionsApi.js +101 -38
  48. package/dist/esm/apis/DocumentsApi.d.ts +80 -0
  49. package/dist/esm/apis/DocumentsApi.js +84 -30
  50. package/dist/esm/apis/FoldersApi.d.ts +92 -9
  51. package/dist/esm/apis/FoldersApi.js +87 -33
  52. package/dist/esm/apis/InvitesApi.d.ts +51 -0
  53. package/dist/esm/apis/InvitesApi.js +56 -20
  54. package/dist/esm/apis/PathPartsApi.d.ts +54 -0
  55. package/dist/esm/apis/PathPartsApi.js +56 -20
  56. package/dist/esm/apis/SectionsApi.d.ts +49 -0
  57. package/dist/esm/apis/SectionsApi.js +56 -20
  58. package/dist/esm/apis/TagsApi.d.ts +62 -0
  59. package/dist/esm/apis/TagsApi.js +70 -25
  60. package/dist/esm/apis/TenantsApi.d.ts +172 -5
  61. package/dist/esm/apis/TenantsApi.js +180 -32
  62. package/dist/esm/apis/ThreadMessagesApi.d.ts +41 -0
  63. package/dist/esm/apis/ThreadMessagesApi.js +42 -15
  64. package/dist/esm/apis/ThreadsApi.d.ts +77 -0
  65. package/dist/esm/apis/ThreadsApi.js +84 -30
  66. package/dist/esm/apis/UserPermissionsApi.d.ts +54 -0
  67. package/dist/esm/apis/UserPermissionsApi.js +56 -20
  68. package/dist/esm/apis/UsersApi.d.ts +23 -0
  69. package/dist/esm/apis/UsersApi.js +28 -10
  70. package/dist/esm/apis/WorkflowsApi.d.ts +38 -0
  71. package/dist/esm/apis/WorkflowsApi.js +42 -15
  72. package/dist/esm/models/{DocumentContentPathPart.d.ts → ChunkContentItem.d.ts} +37 -40
  73. package/dist/esm/models/{DocumentContentPathPart.js → ChunkContentItem.js} +17 -16
  74. package/dist/esm/models/ChunkResponse.d.ts +6 -0
  75. package/dist/esm/models/ChunkResponse.js +2 -0
  76. package/dist/esm/models/DocumentResponse.d.ts +13 -0
  77. package/dist/esm/models/DocumentResponse.js +8 -0
  78. package/dist/esm/models/FolderResponse.d.ts +13 -0
  79. package/dist/esm/models/FolderResponse.js +8 -0
  80. package/dist/esm/models/FolderResponseOrDocumentResponse.d.ts +27 -0
  81. package/dist/esm/models/FolderResponseOrDocumentResponse.js +47 -0
  82. package/dist/esm/models/InviteResponse.d.ts +7 -0
  83. package/dist/esm/models/InviteResponse.js +5 -0
  84. package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.d.ts +66 -0
  85. package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.js +70 -0
  86. package/dist/esm/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.d.ts +66 -0
  87. package/dist/esm/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.js +70 -0
  88. package/dist/esm/models/PaginatedResponseTenantUserResponse.d.ts +66 -0
  89. package/dist/esm/models/{PaginatedResponseTenantUserInTenantResponse.js → PaginatedResponseTenantUserResponse.js} +12 -12
  90. package/dist/esm/models/ScoredChunkResponse.d.ts +6 -0
  91. package/dist/esm/models/ScoredChunkResponse.js +2 -0
  92. package/dist/esm/models/SectionContentItem.d.ts +114 -0
  93. package/dist/esm/models/SectionContentItem.js +86 -0
  94. package/dist/esm/models/SectionContentItemOrChunkContentItem.d.ts +27 -0
  95. package/dist/esm/models/SectionContentItemOrChunkContentItem.js +47 -0
  96. package/dist/esm/models/TenantUserEditRequest.d.ts +48 -0
  97. package/dist/esm/models/TenantUserEditRequest.js +45 -0
  98. package/dist/esm/models/{TenantUserInTenantResponse.d.ts → TenantUserResponse.d.ts} +19 -13
  99. package/dist/esm/models/{TenantUserInTenantResponse.js → TenantUserResponse.js} +13 -9
  100. package/dist/esm/models/index.d.ts +9 -6
  101. package/dist/esm/models/index.js +9 -6
  102. package/dist/models/{DocumentContentPathPart.d.ts → ChunkContentItem.d.ts} +37 -40
  103. package/dist/models/{DocumentContentPathPart.js → ChunkContentItem.js} +23 -22
  104. package/dist/models/ChunkResponse.d.ts +6 -0
  105. package/dist/models/ChunkResponse.js +2 -0
  106. package/dist/models/DocumentResponse.d.ts +13 -0
  107. package/dist/models/DocumentResponse.js +9 -1
  108. package/dist/models/FolderResponse.d.ts +13 -0
  109. package/dist/models/FolderResponse.js +9 -1
  110. package/dist/models/FolderResponseOrDocumentResponse.d.ts +27 -0
  111. package/dist/models/FolderResponseOrDocumentResponse.js +53 -0
  112. package/dist/models/InviteResponse.d.ts +7 -0
  113. package/dist/models/InviteResponse.js +5 -0
  114. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.d.ts +66 -0
  115. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.js +78 -0
  116. package/dist/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.d.ts +66 -0
  117. package/dist/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.js +78 -0
  118. package/dist/models/PaginatedResponseTenantUserResponse.d.ts +66 -0
  119. package/dist/models/PaginatedResponseTenantUserResponse.js +78 -0
  120. package/dist/models/ScoredChunkResponse.d.ts +6 -0
  121. package/dist/models/ScoredChunkResponse.js +2 -0
  122. package/dist/models/SectionContentItem.d.ts +114 -0
  123. package/dist/models/SectionContentItem.js +94 -0
  124. package/dist/models/SectionContentItemOrChunkContentItem.d.ts +27 -0
  125. package/dist/models/SectionContentItemOrChunkContentItem.js +53 -0
  126. package/dist/models/TenantUserEditRequest.d.ts +48 -0
  127. package/dist/models/TenantUserEditRequest.js +53 -0
  128. package/dist/models/{TenantUserInTenantResponse.d.ts → TenantUserResponse.d.ts} +19 -13
  129. package/dist/models/{TenantUserInTenantResponse.js → TenantUserResponse.js} +19 -15
  130. package/dist/models/index.d.ts +9 -6
  131. package/dist/models/index.js +9 -6
  132. package/docs/AuthApi.md +707 -0
  133. package/docs/BulkTagRequest.md +35 -0
  134. package/docs/ChunkContentItem.md +59 -0
  135. package/docs/ChunkLineageResponse.md +41 -0
  136. package/docs/ChunkLineagesApi.md +230 -0
  137. package/docs/ChunkMetadataInput.md +37 -0
  138. package/docs/ChunkMetadataOutput.md +37 -0
  139. package/docs/ChunkResponse.md +63 -0
  140. package/docs/ChunkSearchRequest.md +47 -0
  141. package/docs/ChunkType.md +33 -0
  142. package/docs/ChunksApi.md +446 -0
  143. package/docs/ClearVersionContentsResponse.md +35 -0
  144. package/docs/CreateChunkLineageRequest.md +37 -0
  145. package/docs/CreateChunkRequest.md +43 -0
  146. package/docs/CreateDocumentRequest.md +41 -0
  147. package/docs/CreateFolderRequest.md +37 -0
  148. package/docs/CreatePasswordUserRequest.md +36 -0
  149. package/docs/CreatePermissionRequest.md +40 -0
  150. package/docs/CreateSectionRequest.md +41 -0
  151. package/docs/CreateTagRequest.md +39 -0
  152. package/docs/CreateTenantRequest.md +37 -0
  153. package/docs/CreateThreadMessageRequest.md +37 -0
  154. package/docs/CreateThreadRequest.md +37 -0
  155. package/docs/DefaultApi.md +128 -0
  156. package/docs/DocumentOrigin.md +33 -0
  157. package/docs/DocumentResponse.md +63 -0
  158. package/docs/DocumentType.md +33 -0
  159. package/docs/DocumentVersionMetadata.md +47 -0
  160. package/docs/DocumentVersionMetadataUpdate.md +47 -0
  161. package/docs/DocumentVersionResponse.md +57 -0
  162. package/docs/DocumentVersionsApi.md +530 -0
  163. package/docs/DocumentsApi.md +464 -0
  164. package/docs/EmailSentResponse.md +34 -0
  165. package/docs/EmailVerificationRequest.md +34 -0
  166. package/docs/EmbeddingModel.md +33 -0
  167. package/docs/FolderResponse.md +55 -0
  168. package/docs/FolderResponseOrDocumentResponse.md +62 -0
  169. package/docs/FoldersApi.md +473 -0
  170. package/docs/HTTPValidationError.md +34 -0
  171. package/docs/HealthCheckResponse.md +36 -0
  172. package/docs/IdpType.md +33 -0
  173. package/docs/IngestDocumentResponse.md +39 -0
  174. package/docs/InviteResponse.md +53 -0
  175. package/docs/InviteStatus.md +32 -0
  176. package/docs/InviteUserRequest.md +38 -0
  177. package/docs/InvitesApi.md +305 -0
  178. package/docs/LineageEdgeResponse.md +37 -0
  179. package/docs/LineageGraphResponse.md +37 -0
  180. package/docs/LineageNodeResponse.md +47 -0
  181. package/docs/LocationInner.md +32 -0
  182. package/docs/MessageRole.md +33 -0
  183. package/docs/OAuth2Config.md +41 -0
  184. package/docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md +40 -0
  185. package/docs/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md +40 -0
  186. package/docs/PaginatedResponseDocumentResponse.md +40 -0
  187. package/docs/PaginatedResponseDocumentVersionResponse.md +40 -0
  188. package/docs/PaginatedResponseFolderResponse.md +40 -0
  189. package/docs/PaginatedResponseInviteResponse.md +40 -0
  190. package/docs/PaginatedResponsePathPartResponse.md +40 -0
  191. package/docs/PaginatedResponsePermissionResponse.md +40 -0
  192. package/docs/PaginatedResponseTagResponse.md +40 -0
  193. package/docs/PaginatedResponseTenantResponse.md +40 -0
  194. package/docs/PaginatedResponseTenantUserResponse.md +40 -0
  195. package/docs/PaginatedResponseThreadMessageResponse.md +40 -0
  196. package/docs/PaginatedResponseThreadResponse.md +40 -0
  197. package/docs/PaginatedResponseWorkflowSummaryResponse.md +40 -0
  198. package/docs/PartType.md +33 -0
  199. package/docs/PasswordResetRequest.md +36 -0
  200. package/docs/PasswordResetWithTokenRequest.md +36 -0
  201. package/docs/PathOrder.md +33 -0
  202. package/docs/PathPartResponse.md +53 -0
  203. package/docs/PathPartTagsResponse.md +35 -0
  204. package/docs/PathPartsApi.md +314 -0
  205. package/docs/PermissionCapability.md +33 -0
  206. package/docs/PermissionResponse.md +48 -0
  207. package/docs/PipelineState.md +45 -0
  208. package/docs/PipelineStatus.md +33 -0
  209. package/docs/Polygon.md +41 -0
  210. package/docs/PolygonReference.md +37 -0
  211. package/docs/RootResponse.md +36 -0
  212. package/docs/ScoredChunkResponse.md +65 -0
  213. package/docs/SectionContentItem.md +55 -0
  214. package/docs/SectionContentItemOrChunkContentItem.md +60 -0
  215. package/docs/SectionResponse.md +57 -0
  216. package/docs/SectionsApi.md +299 -0
  217. package/docs/SignInRequest.md +38 -0
  218. package/docs/TagResponse.md +47 -0
  219. package/docs/TagsApi.md +374 -0
  220. package/docs/TenantResponse.md +39 -0
  221. package/docs/TenantUserEditRequest.md +35 -0
  222. package/docs/TenantUserResponse.md +43 -0
  223. package/docs/TenantUserRole.md +33 -0
  224. package/docs/TenantsApi.md +605 -0
  225. package/docs/ThreadMessageResponse.md +53 -0
  226. package/docs/ThreadMessagesApi.md +239 -0
  227. package/docs/ThreadResponse.md +49 -0
  228. package/docs/ThreadsApi.md +455 -0
  229. package/docs/UpdateChunkContentRequest.md +37 -0
  230. package/docs/UpdateChunkMetadataRequest.md +35 -0
  231. package/docs/UpdateDocumentRequest.md +39 -0
  232. package/docs/UpdateFolderRequest.md +37 -0
  233. package/docs/UpdatePermissionRequest.md +36 -0
  234. package/docs/UpdateSectionRequest.md +41 -0
  235. package/docs/UpdateTagRequest.md +39 -0
  236. package/docs/UpdateTenantRequest.md +37 -0
  237. package/docs/UpdateThreadRequest.md +37 -0
  238. package/docs/UpdateUserRequest.md +34 -0
  239. package/docs/UserPermissionsApi.md +314 -0
  240. package/docs/UserResponse.md +44 -0
  241. package/docs/UsersApi.md +149 -0
  242. package/docs/ValidationError.md +42 -0
  243. package/docs/WorkflowAction.md +33 -0
  244. package/docs/WorkflowActionResponse.md +39 -0
  245. package/docs/WorkflowDetailResponse.md +63 -0
  246. package/docs/WorkflowSummaryResponse.md +49 -0
  247. package/docs/WorkflowsApi.md +230 -0
  248. package/package.json +1 -1
  249. package/src/apis/AuthApi.ts +214 -47
  250. package/src/apis/ChunkLineagesApi.ts +68 -15
  251. package/src/apis/ChunksApi.ts +137 -33
  252. package/src/apis/DefaultApi.ts +40 -10
  253. package/src/apis/DocumentVersionsApi.ts +170 -45
  254. package/src/apis/DocumentsApi.ts +140 -30
  255. package/src/apis/FoldersApi.ts +153 -40
  256. package/src/apis/InvitesApi.ts +91 -20
  257. package/src/apis/PathPartsApi.ts +94 -20
  258. package/src/apis/SectionsApi.ts +89 -20
  259. package/src/apis/TagsApi.ts +112 -25
  260. package/src/apis/TenantsApi.ts +339 -37
  261. package/src/apis/ThreadMessagesApi.ts +71 -15
  262. package/src/apis/ThreadsApi.ts +137 -30
  263. package/src/apis/UserPermissionsApi.ts +94 -20
  264. package/src/apis/UsersApi.ts +43 -10
  265. package/src/apis/WorkflowsApi.ts +68 -15
  266. package/src/models/{DocumentContentPathPart.ts → ChunkContentItem.ts} +42 -53
  267. package/src/models/ChunkResponse.ts +8 -0
  268. package/src/models/DocumentResponse.ts +16 -0
  269. package/src/models/FolderResponse.ts +18 -0
  270. package/src/models/FolderResponseOrDocumentResponse.ts +72 -0
  271. package/src/models/InviteResponse.ts +19 -0
  272. package/src/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.ts +130 -0
  273. package/src/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.ts +130 -0
  274. package/src/models/{PaginatedResponseFolderDocumentResponse.ts → PaginatedResponseTenantUserResponse.ts} +25 -25
  275. package/src/models/ScoredChunkResponse.ts +8 -0
  276. package/src/models/SectionContentItem.ts +181 -0
  277. package/src/models/SectionContentItemOrChunkContentItem.ts +72 -0
  278. package/src/models/TenantUserEditRequest.ts +93 -0
  279. package/src/models/{TenantUserInTenantResponse.ts → TenantUserResponse.ts} +24 -15
  280. package/src/models/index.ts +9 -6
  281. package/dist/esm/models/FolderDocumentResponse.d.ts +0 -157
  282. package/dist/esm/models/FolderDocumentResponse.js +0 -99
  283. package/dist/esm/models/PaginatedResponseDocumentContentPathPart.d.ts +0 -66
  284. package/dist/esm/models/PaginatedResponseDocumentContentPathPart.js +0 -70
  285. package/dist/esm/models/PaginatedResponseFolderDocumentResponse.d.ts +0 -66
  286. package/dist/esm/models/PaginatedResponseFolderDocumentResponse.js +0 -70
  287. package/dist/esm/models/PaginatedResponseTenantUserInTenantResponse.d.ts +0 -66
  288. package/dist/models/FolderDocumentResponse.d.ts +0 -157
  289. package/dist/models/FolderDocumentResponse.js +0 -107
  290. package/dist/models/PaginatedResponseDocumentContentPathPart.d.ts +0 -66
  291. package/dist/models/PaginatedResponseDocumentContentPathPart.js +0 -78
  292. package/dist/models/PaginatedResponseFolderDocumentResponse.d.ts +0 -66
  293. package/dist/models/PaginatedResponseFolderDocumentResponse.js +0 -78
  294. package/dist/models/PaginatedResponseTenantUserInTenantResponse.d.ts +0 -66
  295. package/dist/models/PaginatedResponseTenantUserInTenantResponse.js +0 -78
  296. package/src/models/FolderDocumentResponse.ts +0 -267
  297. package/src/models/PaginatedResponseDocumentContentPathPart.ts +0 -130
  298. package/src/models/PaginatedResponseTenantUserInTenantResponse.ts +0 -130
@@ -27,10 +27,9 @@ import { CreateDocumentRequestToJSON, DocumentResponseFromJSON, IngestDocumentRe
27
27
  */
28
28
  export class DocumentsApi extends runtime.BaseAPI {
29
29
  /**
30
- * Create a new document with initial v0 version. The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
31
- * Create Document Handler
30
+ * Creates request options for createDocument without sending the request
32
31
  */
33
- createDocumentRaw(requestParameters, initOverrides) {
32
+ createDocumentRequestOpts(requestParameters) {
34
33
  return __awaiter(this, void 0, void 0, function* () {
35
34
  if (requestParameters['createDocumentRequest'] == null) {
36
35
  throw new runtime.RequiredError('createDocumentRequest', 'Required parameter "createDocumentRequest" was null or undefined when calling createDocument().');
@@ -39,13 +38,23 @@ export class DocumentsApi extends runtime.BaseAPI {
39
38
  const headerParameters = {};
40
39
  headerParameters['Content-Type'] = 'application/json';
41
40
  let urlPath = `/v1/documents`;
42
- const response = yield this.request({
41
+ return {
43
42
  path: urlPath,
44
43
  method: 'POST',
45
44
  headers: headerParameters,
46
45
  query: queryParameters,
47
46
  body: CreateDocumentRequestToJSON(requestParameters['createDocumentRequest']),
48
- }, initOverrides);
47
+ };
48
+ });
49
+ }
50
+ /**
51
+ * Create a new document with initial v0 version. The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
52
+ * Create Document Handler
53
+ */
54
+ createDocumentRaw(requestParameters, initOverrides) {
55
+ return __awaiter(this, void 0, void 0, function* () {
56
+ const requestOptions = yield this.createDocumentRequestOpts(requestParameters);
57
+ const response = yield this.request(requestOptions, initOverrides);
49
58
  return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
50
59
  });
51
60
  }
@@ -60,10 +69,9 @@ export class DocumentsApi extends runtime.BaseAPI {
60
69
  });
61
70
  }
62
71
  /**
63
- * Delete a document and all its contents. WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
64
- * Delete Document Handler
72
+ * Creates request options for deleteDocument without sending the request
65
73
  */
66
- deleteDocumentRaw(requestParameters, initOverrides) {
74
+ deleteDocumentRequestOpts(requestParameters) {
67
75
  return __awaiter(this, void 0, void 0, function* () {
68
76
  if (requestParameters['documentId'] == null) {
69
77
  throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling deleteDocument().');
@@ -72,12 +80,22 @@ export class DocumentsApi extends runtime.BaseAPI {
72
80
  const headerParameters = {};
73
81
  let urlPath = `/v1/documents/{document_id}`;
74
82
  urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
75
- const response = yield this.request({
83
+ return {
76
84
  path: urlPath,
77
85
  method: 'DELETE',
78
86
  headers: headerParameters,
79
87
  query: queryParameters,
80
- }, initOverrides);
88
+ };
89
+ });
90
+ }
91
+ /**
92
+ * Delete a document and all its contents. WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
93
+ * Delete Document Handler
94
+ */
95
+ deleteDocumentRaw(requestParameters, initOverrides) {
96
+ return __awaiter(this, void 0, void 0, function* () {
97
+ const requestOptions = yield this.deleteDocumentRequestOpts(requestParameters);
98
+ const response = yield this.request(requestOptions, initOverrides);
81
99
  return new runtime.VoidApiResponse(response);
82
100
  });
83
101
  }
@@ -91,10 +109,9 @@ export class DocumentsApi extends runtime.BaseAPI {
91
109
  });
92
110
  }
93
111
  /**
94
- * Get a document by its document ID.
95
- * Get Document Handler
112
+ * Creates request options for getDocument without sending the request
96
113
  */
97
- getDocumentRaw(requestParameters, initOverrides) {
114
+ getDocumentRequestOpts(requestParameters) {
98
115
  return __awaiter(this, void 0, void 0, function* () {
99
116
  if (requestParameters['documentId'] == null) {
100
117
  throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling getDocument().');
@@ -106,12 +123,22 @@ export class DocumentsApi extends runtime.BaseAPI {
106
123
  const headerParameters = {};
107
124
  let urlPath = `/v1/documents/{document_id}`;
108
125
  urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
109
- const response = yield this.request({
126
+ return {
110
127
  path: urlPath,
111
128
  method: 'GET',
112
129
  headers: headerParameters,
113
130
  query: queryParameters,
114
- }, initOverrides);
131
+ };
132
+ });
133
+ }
134
+ /**
135
+ * Get a document by its document ID.
136
+ * Get Document Handler
137
+ */
138
+ getDocumentRaw(requestParameters, initOverrides) {
139
+ return __awaiter(this, void 0, void 0, function* () {
140
+ const requestOptions = yield this.getDocumentRequestOpts(requestParameters);
141
+ const response = yield this.request(requestOptions, initOverrides);
115
142
  return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
116
143
  });
117
144
  }
@@ -126,10 +153,9 @@ export class DocumentsApi extends runtime.BaseAPI {
126
153
  });
127
154
  }
128
155
  /**
129
- * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
130
- * Ingest Document Handler
156
+ * Creates request options for ingestDocument without sending the request
131
157
  */
132
- ingestDocumentRaw(requestParameters, initOverrides) {
158
+ ingestDocumentRequestOpts(requestParameters) {
133
159
  return __awaiter(this, void 0, void 0, function* () {
134
160
  if (requestParameters['file'] == null) {
135
161
  throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling ingestDocument().');
@@ -164,13 +190,23 @@ export class DocumentsApi extends runtime.BaseAPI {
164
190
  formParams.append('name', requestParameters['name']);
165
191
  }
166
192
  let urlPath = `/v1/documents/ingest`;
167
- const response = yield this.request({
193
+ return {
168
194
  path: urlPath,
169
195
  method: 'POST',
170
196
  headers: headerParameters,
171
197
  query: queryParameters,
172
198
  body: formParams,
173
- }, initOverrides);
199
+ };
200
+ });
201
+ }
202
+ /**
203
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
204
+ * Ingest Document Handler
205
+ */
206
+ ingestDocumentRaw(requestParameters, initOverrides) {
207
+ return __awaiter(this, void 0, void 0, function* () {
208
+ const requestOptions = yield this.ingestDocumentRequestOpts(requestParameters);
209
+ const response = yield this.request(requestOptions, initOverrides);
174
210
  return new runtime.JSONApiResponse(response, (jsonValue) => IngestDocumentResponseFromJSON(jsonValue));
175
211
  });
176
212
  }
@@ -185,10 +221,9 @@ export class DocumentsApi extends runtime.BaseAPI {
185
221
  });
186
222
  }
187
223
  /**
188
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
189
- * List Documents Handler
224
+ * Creates request options for listDocuments without sending the request
190
225
  */
191
- listDocumentsRaw(requestParameters, initOverrides) {
226
+ listDocumentsRequestOpts(requestParameters) {
192
227
  return __awaiter(this, void 0, void 0, function* () {
193
228
  const queryParameters = {};
194
229
  if (requestParameters['parentPathPartId'] != null) {
@@ -208,12 +243,22 @@ export class DocumentsApi extends runtime.BaseAPI {
208
243
  }
209
244
  const headerParameters = {};
210
245
  let urlPath = `/v1/documents`;
211
- const response = yield this.request({
246
+ return {
212
247
  path: urlPath,
213
248
  method: 'GET',
214
249
  headers: headerParameters,
215
250
  query: queryParameters,
216
- }, initOverrides);
251
+ };
252
+ });
253
+ }
254
+ /**
255
+ * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
256
+ * List Documents Handler
257
+ */
258
+ listDocumentsRaw(requestParameters, initOverrides) {
259
+ return __awaiter(this, void 0, void 0, function* () {
260
+ const requestOptions = yield this.listDocumentsRequestOpts(requestParameters);
261
+ const response = yield this.request(requestOptions, initOverrides);
217
262
  return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseDocumentResponseFromJSON(jsonValue));
218
263
  });
219
264
  }
@@ -228,10 +273,9 @@ export class DocumentsApi extends runtime.BaseAPI {
228
273
  });
229
274
  }
230
275
  /**
231
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
232
- * Update Document Handler
276
+ * Creates request options for updateDocument without sending the request
233
277
  */
234
- updateDocumentRaw(requestParameters, initOverrides) {
278
+ updateDocumentRequestOpts(requestParameters) {
235
279
  return __awaiter(this, void 0, void 0, function* () {
236
280
  if (requestParameters['documentId'] == null) {
237
281
  throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling updateDocument().');
@@ -244,13 +288,23 @@ export class DocumentsApi extends runtime.BaseAPI {
244
288
  headerParameters['Content-Type'] = 'application/json';
245
289
  let urlPath = `/v1/documents/{document_id}`;
246
290
  urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
247
- const response = yield this.request({
291
+ return {
248
292
  path: urlPath,
249
293
  method: 'PATCH',
250
294
  headers: headerParameters,
251
295
  query: queryParameters,
252
296
  body: UpdateDocumentRequestToJSON(requestParameters['updateDocumentRequest']),
253
- }, initOverrides);
297
+ };
298
+ });
299
+ }
300
+ /**
301
+ * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
302
+ * Update Document Handler
303
+ */
304
+ updateDocumentRaw(requestParameters, initOverrides) {
305
+ return __awaiter(this, void 0, void 0, function* () {
306
+ const requestOptions = yield this.updateDocumentRequestOpts(requestParameters);
307
+ const response = yield this.request(requestOptions, initOverrides);
254
308
  return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
255
309
  });
256
310
  }
@@ -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, PaginatedResponseFolderDocumentResponse, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
13
+ import type { CreateFolderRequest, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
14
14
  export interface CreateFolderOperationRequest {
15
15
  createFolderRequest: CreateFolderRequest;
16
16
  ksUat?: string | null;
@@ -53,6 +53,14 @@ export interface UpdateFolderOperationRequest {
53
53
  * @interface FoldersApiInterface
54
54
  */
55
55
  export interface FoldersApiInterface {
56
+ /**
57
+ * Creates request options for createFolder without sending the request
58
+ * @param {CreateFolderRequest} createFolderRequest
59
+ * @param {string} [ksUat]
60
+ * @throws {RequiredError}
61
+ * @memberof FoldersApiInterface
62
+ */
63
+ createFolderRequestOpts(requestParameters: CreateFolderOperationRequest): Promise<runtime.RequestOpts>;
56
64
  /**
57
65
  * 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.
58
66
  * @summary Create Folder Handler
@@ -68,6 +76,14 @@ export interface FoldersApiInterface {
68
76
  * Create Folder Handler
69
77
  */
70
78
  createFolder(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
79
+ /**
80
+ * Creates request options for deleteFolder without sending the request
81
+ * @param {string} folderId
82
+ * @param {string} [ksUat]
83
+ * @throws {RequiredError}
84
+ * @memberof FoldersApiInterface
85
+ */
86
+ deleteFolderRequestOpts(requestParameters: DeleteFolderRequest): Promise<runtime.RequestOpts>;
71
87
  /**
72
88
  * 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.
73
89
  * @summary Delete Folder Handler
@@ -83,6 +99,15 @@ export interface FoldersApiInterface {
83
99
  * Delete Folder Handler
84
100
  */
85
101
  deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
102
+ /**
103
+ * Creates request options for getFolder without sending the request
104
+ * @param {string} folderId
105
+ * @param {boolean} [withTags] Include tags in the response (default: false)
106
+ * @param {string} [ksUat]
107
+ * @throws {RequiredError}
108
+ * @memberof FoldersApiInterface
109
+ */
110
+ getFolderRequestOpts(requestParameters: GetFolderRequest): Promise<runtime.RequestOpts>;
86
111
  /**
87
112
  * Get a folder by its folder ID.
88
113
  * @summary Get Folder Handler
@@ -100,7 +125,20 @@ export interface FoldersApiInterface {
100
125
  */
101
126
  getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
102
127
  /**
103
- * 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 When with_tags=true, each item includes a tags field with the full tag objects. 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.
128
+ * Creates request options for listFolderContents without sending the request
129
+ * @param {string} folderId
130
+ * @param {number} [maxDepth] Maximum depth to traverse (1&#x3D;direct children, default: 1)
131
+ * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
132
+ * @param {boolean} [withTags] Include tag IDs for each item (default: false)
133
+ * @param {number} [limit] Number of items per page
134
+ * @param {number} [offset] Number of items to skip
135
+ * @param {string} [ksUat]
136
+ * @throws {RequiredError}
137
+ * @memberof FoldersApiInterface
138
+ */
139
+ listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
140
+ /**
141
+ * List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. 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.
104
142
  * @summary List Folder Contents Handler
105
143
  * @param {string} folderId
106
144
  * @param {number} [maxDepth] Maximum depth to traverse (1&#x3D;direct children, default: 1)
@@ -113,12 +151,24 @@ export interface FoldersApiInterface {
113
151
  * @throws {RequiredError}
114
152
  * @memberof FoldersApiInterface
115
153
  */
116
- listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
154
+ listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>>;
117
155
  /**
118
- * 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 When with_tags=true, each item includes a tags field with the full tag objects. 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.
156
+ * List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. 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.
119
157
  * List Folder Contents Handler
120
158
  */
121
- listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
159
+ listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>;
160
+ /**
161
+ * Creates request options for listFolders without sending the request
162
+ * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
163
+ * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
164
+ * @param {boolean} [withTags] Include tags in the response (default: false)
165
+ * @param {number} [limit] Number of items per page
166
+ * @param {number} [offset] Number of items to skip
167
+ * @param {string} [ksUat]
168
+ * @throws {RequiredError}
169
+ * @memberof FoldersApiInterface
170
+ */
171
+ listFoldersRequestOpts(requestParameters: ListFoldersRequest): Promise<runtime.RequestOpts>;
122
172
  /**
123
173
  * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders. At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
124
174
  * @summary List Folders Handler
@@ -138,6 +188,15 @@ export interface FoldersApiInterface {
138
188
  * List Folders Handler
139
189
  */
140
190
  listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
191
+ /**
192
+ * Creates request options for updateFolder without sending the request
193
+ * @param {string} folderId
194
+ * @param {UpdateFolderRequest} updateFolderRequest
195
+ * @param {string} [ksUat]
196
+ * @throws {RequiredError}
197
+ * @memberof FoldersApiInterface
198
+ */
199
+ updateFolderRequestOpts(requestParameters: UpdateFolderOperationRequest): Promise<runtime.RequestOpts>;
141
200
  /**
142
201
  * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_path_part_id` field. Both can be done in a single request.
143
202
  * @summary Update Folder Handler
@@ -159,6 +218,10 @@ export interface FoldersApiInterface {
159
218
  *
160
219
  */
161
220
  export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
221
+ /**
222
+ * Creates request options for createFolder without sending the request
223
+ */
224
+ createFolderRequestOpts(requestParameters: CreateFolderOperationRequest): Promise<runtime.RequestOpts>;
162
225
  /**
163
226
  * 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.
164
227
  * Create Folder Handler
@@ -169,6 +232,10 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
169
232
  * Create Folder Handler
170
233
  */
171
234
  createFolder(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
235
+ /**
236
+ * Creates request options for deleteFolder without sending the request
237
+ */
238
+ deleteFolderRequestOpts(requestParameters: DeleteFolderRequest): Promise<runtime.RequestOpts>;
172
239
  /**
173
240
  * 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.
174
241
  * Delete Folder Handler
@@ -179,6 +246,10 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
179
246
  * Delete Folder Handler
180
247
  */
181
248
  deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
249
+ /**
250
+ * Creates request options for getFolder without sending the request
251
+ */
252
+ getFolderRequestOpts(requestParameters: GetFolderRequest): Promise<runtime.RequestOpts>;
182
253
  /**
183
254
  * Get a folder by its folder ID.
184
255
  * Get Folder Handler
@@ -190,15 +261,23 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
190
261
  */
191
262
  getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
192
263
  /**
193
- * 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 When with_tags=true, each item includes a tags field with the full tag objects. 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.
264
+ * Creates request options for listFolderContents without sending the request
265
+ */
266
+ listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
267
+ /**
268
+ * List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. 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.
194
269
  * List Folder Contents Handler
195
270
  */
196
- listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
271
+ listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>>;
197
272
  /**
198
- * 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 When with_tags=true, each item includes a tags field with the full tag objects. 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.
273
+ * List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. 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.
199
274
  * List Folder Contents Handler
200
275
  */
201
- listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
276
+ listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>;
277
+ /**
278
+ * Creates request options for listFolders without sending the request
279
+ */
280
+ listFoldersRequestOpts(requestParameters: ListFoldersRequest): Promise<runtime.RequestOpts>;
202
281
  /**
203
282
  * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders. At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
204
283
  * List Folders Handler
@@ -209,6 +288,10 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
209
288
  * List Folders Handler
210
289
  */
211
290
  listFolders(requestParameters?: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
291
+ /**
292
+ * Creates request options for updateFolder without sending the request
293
+ */
294
+ updateFolderRequestOpts(requestParameters: UpdateFolderOperationRequest): Promise<runtime.RequestOpts>;
212
295
  /**
213
296
  * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_path_part_id` field. Both can be done in a single request.
214
297
  * Update Folder Handler