@knowledge-stack/ksapi 1.88.0 → 1.89.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 (365) hide show
  1. package/.openapi-generator/FILES +38 -20
  2. package/README.md +30 -19
  3. package/dist/apis/DocumentCheckoutApi.d.ts +16 -13
  4. package/dist/apis/DocumentCheckoutApi.js +17 -14
  5. package/dist/apis/DocumentVersionsApi.d.ts +1 -4
  6. package/dist/apis/DocumentVersionsApi.js +0 -2
  7. package/dist/apis/DocumentsApi.d.ts +1 -4
  8. package/dist/apis/DocumentsApi.js +0 -2
  9. package/dist/apis/FoldersApi.d.ts +10 -13
  10. package/dist/apis/FoldersApi.js +2 -4
  11. package/dist/apis/PathPartApprovalsApi.d.ts +117 -0
  12. package/dist/apis/PathPartApprovalsApi.js +159 -0
  13. package/dist/apis/PathPartsApi.d.ts +4 -4
  14. package/dist/apis/PathPartsApi.js +2 -2
  15. package/dist/apis/WorkflowDefinitionsApi.d.ts +48 -42
  16. package/dist/apis/WorkflowDefinitionsApi.js +65 -43
  17. package/dist/apis/WorkflowMemoryApi.d.ts +12 -9
  18. package/dist/apis/WorkflowMemoryApi.js +7 -3
  19. package/dist/apis/WorkflowRunsApi.d.ts +115 -65
  20. package/dist/apis/WorkflowRunsApi.js +100 -53
  21. package/dist/apis/index.d.ts +1 -0
  22. package/dist/apis/index.js +1 -0
  23. package/dist/esm/apis/DocumentCheckoutApi.d.ts +16 -13
  24. package/dist/esm/apis/DocumentCheckoutApi.js +17 -14
  25. package/dist/esm/apis/DocumentVersionsApi.d.ts +1 -4
  26. package/dist/esm/apis/DocumentVersionsApi.js +0 -2
  27. package/dist/esm/apis/DocumentsApi.d.ts +1 -4
  28. package/dist/esm/apis/DocumentsApi.js +0 -2
  29. package/dist/esm/apis/FoldersApi.d.ts +10 -13
  30. package/dist/esm/apis/FoldersApi.js +3 -5
  31. package/dist/esm/apis/PathPartApprovalsApi.d.ts +117 -0
  32. package/dist/esm/apis/PathPartApprovalsApi.js +122 -0
  33. package/dist/esm/apis/PathPartsApi.d.ts +4 -4
  34. package/dist/esm/apis/PathPartsApi.js +2 -2
  35. package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +48 -42
  36. package/dist/esm/apis/WorkflowDefinitionsApi.js +66 -44
  37. package/dist/esm/apis/WorkflowMemoryApi.d.ts +12 -9
  38. package/dist/esm/apis/WorkflowMemoryApi.js +8 -4
  39. package/dist/esm/apis/WorkflowRunsApi.d.ts +115 -65
  40. package/dist/esm/apis/WorkflowRunsApi.js +101 -54
  41. package/dist/esm/apis/index.d.ts +1 -0
  42. package/dist/esm/apis/index.js +1 -0
  43. package/dist/esm/models/ChunkContentItem.d.ts +7 -0
  44. package/dist/esm/models/ChunkContentItem.js +5 -0
  45. package/dist/esm/models/CitedChunk.d.ts +86 -0
  46. package/dist/esm/models/CitedChunk.js +55 -0
  47. package/dist/esm/models/CloneWorkflowRunRequest.d.ts +54 -0
  48. package/dist/esm/models/CloneWorkflowRunRequest.js +44 -0
  49. package/dist/esm/models/CreateThreadMessageRequest.d.ts +1 -1
  50. package/dist/esm/models/CreateThreadRequest.d.ts +13 -1
  51. package/dist/esm/models/CreateThreadRequest.js +8 -0
  52. package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +6 -41
  53. package/dist/esm/models/CreateWorkflowDefinitionRequest.js +5 -35
  54. package/dist/esm/models/DocumentCheckoutResponse.d.ts +6 -5
  55. package/dist/esm/models/DocumentCheckoutResponse.js +7 -6
  56. package/dist/esm/models/DocumentResponse.d.ts +11 -3
  57. package/dist/esm/models/DocumentResponse.js +9 -3
  58. package/dist/esm/models/DocumentVersionMetadata.d.ts +7 -0
  59. package/dist/esm/models/DocumentVersionMetadata.js +3 -0
  60. package/dist/esm/models/DocumentVersionMetadataUpdate.d.ts +7 -0
  61. package/dist/esm/models/DocumentVersionMetadataUpdate.js +3 -0
  62. package/dist/esm/models/DocumentVersionResponse.d.ts +4 -3
  63. package/dist/esm/models/DocumentVersionResponse.js +4 -3
  64. package/dist/esm/models/DocxParagraphAnchorInput.d.ts +79 -0
  65. package/dist/esm/models/DocxParagraphAnchorInput.js +71 -0
  66. package/dist/esm/models/DocxParagraphAnchorOutput.d.ts +88 -0
  67. package/dist/esm/models/DocxParagraphAnchorOutput.js +74 -0
  68. package/dist/esm/models/FolderResponse.d.ts +7 -0
  69. package/dist/esm/models/FolderResponse.js +5 -0
  70. package/dist/esm/models/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.d.ts +33 -0
  71. package/dist/esm/models/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.js +57 -0
  72. package/dist/esm/models/InputSnapshot.d.ts +81 -0
  73. package/dist/esm/models/{ABCDPathSnapshot.js → InputSnapshot.js} +18 -12
  74. package/dist/esm/models/InstructionSnapshot.d.ts +16 -10
  75. package/dist/esm/models/InstructionSnapshot.js +11 -6
  76. package/dist/esm/models/MemoryChunkResponse.d.ts +1 -1
  77. package/dist/esm/models/MemoryKind.d.ts +1 -4
  78. package/dist/esm/models/MemoryKind.js +1 -4
  79. package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.d.ts +66 -0
  80. package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.js} +12 -12
  81. package/dist/esm/models/PaginatedResponseMemoryChunkResponse.d.ts +66 -0
  82. package/dist/esm/models/PaginatedResponseMemoryChunkResponse.js +70 -0
  83. package/dist/esm/models/PathPartApprovalDecision.d.ts +6 -5
  84. package/dist/esm/models/PathPartApprovalDecision.js +7 -6
  85. package/dist/esm/models/PathPartApprovalResponse.d.ts +2 -23
  86. package/dist/esm/models/PathPartApprovalResponse.js +3 -15
  87. package/dist/esm/models/PathPartApprovalState.d.ts +32 -0
  88. package/dist/esm/models/PathPartApprovalState.js +50 -0
  89. package/dist/esm/models/SectionContentItem.d.ts +7 -0
  90. package/dist/esm/models/SectionContentItem.js +5 -0
  91. package/dist/esm/models/SetApprovalStateRequest.d.ts +69 -0
  92. package/dist/esm/models/SetApprovalStateRequest.js +57 -0
  93. package/dist/esm/models/SetWorkflowRunApprovalRequest.d.ts +64 -0
  94. package/dist/esm/models/SetWorkflowRunApprovalRequest.js +56 -0
  95. package/dist/esm/models/ThreadMessageResponse.d.ts +7 -1
  96. package/dist/esm/models/ThreadMessageResponse.js +2 -0
  97. package/dist/esm/models/ThreadResponse.d.ts +1 -1
  98. package/dist/esm/models/UpdateThreadRequest.d.ts +1 -1
  99. package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +4 -41
  100. package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +7 -38
  101. package/dist/esm/models/UpdateWorkflowRunRequest.d.ts +58 -0
  102. package/dist/esm/models/UpdateWorkflowRunRequest.js +53 -0
  103. package/dist/esm/models/UserInfo.d.ts +59 -0
  104. package/dist/esm/models/UserInfo.js +52 -0
  105. package/dist/esm/models/UserMessageRequest.d.ts +1 -1
  106. package/dist/esm/models/UserMessageResponse.d.ts +1 -1
  107. package/dist/esm/models/WorkflowDefinitionResponse.d.ts +42 -24
  108. package/dist/esm/models/WorkflowDefinitionResponse.js +31 -24
  109. package/dist/esm/models/WorkflowExecutionState.d.ts +42 -0
  110. package/dist/esm/models/WorkflowExecutionState.js +60 -0
  111. package/dist/esm/models/WorkflowRunResponse.d.ts +91 -18
  112. package/dist/esm/models/WorkflowRunResponse.js +59 -18
  113. package/dist/esm/models/WorkflowRunSnapshot.d.ts +14 -37
  114. package/dist/esm/models/WorkflowRunSnapshot.js +7 -28
  115. package/dist/esm/models/XlsxCellAnchorInput.d.ts +79 -0
  116. package/dist/esm/models/XlsxCellAnchorInput.js +67 -0
  117. package/dist/esm/models/XlsxCellAnchorInputOrDocxParagraphAnchorInput.d.ts +27 -0
  118. package/dist/esm/models/XlsxCellAnchorInputOrDocxParagraphAnchorInput.js +47 -0
  119. package/dist/esm/models/XlsxCellAnchorOutput.d.ts +90 -0
  120. package/dist/esm/models/XlsxCellAnchorOutput.js +70 -0
  121. package/dist/esm/models/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.d.ts +27 -0
  122. package/dist/esm/models/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.js +47 -0
  123. package/dist/esm/models/index.d.ts +18 -10
  124. package/dist/esm/models/index.js +18 -10
  125. package/dist/models/ChunkContentItem.d.ts +7 -0
  126. package/dist/models/ChunkContentItem.js +5 -0
  127. package/dist/models/CitedChunk.d.ts +86 -0
  128. package/dist/models/CitedChunk.js +63 -0
  129. package/dist/models/CloneWorkflowRunRequest.d.ts +54 -0
  130. package/dist/models/CloneWorkflowRunRequest.js +52 -0
  131. package/dist/models/CreateThreadMessageRequest.d.ts +1 -1
  132. package/dist/models/CreateThreadRequest.d.ts +13 -1
  133. package/dist/models/CreateThreadRequest.js +8 -0
  134. package/dist/models/CreateWorkflowDefinitionRequest.d.ts +6 -41
  135. package/dist/models/CreateWorkflowDefinitionRequest.js +5 -35
  136. package/dist/models/DocumentCheckoutResponse.d.ts +6 -5
  137. package/dist/models/DocumentCheckoutResponse.js +7 -6
  138. package/dist/models/DocumentResponse.d.ts +11 -3
  139. package/dist/models/DocumentResponse.js +9 -3
  140. package/dist/models/DocumentVersionMetadata.d.ts +7 -0
  141. package/dist/models/DocumentVersionMetadata.js +3 -0
  142. package/dist/models/DocumentVersionMetadataUpdate.d.ts +7 -0
  143. package/dist/models/DocumentVersionMetadataUpdate.js +3 -0
  144. package/dist/models/DocumentVersionResponse.d.ts +4 -3
  145. package/dist/models/DocumentVersionResponse.js +4 -3
  146. package/dist/models/DocxParagraphAnchorInput.d.ts +79 -0
  147. package/dist/models/DocxParagraphAnchorInput.js +79 -0
  148. package/dist/models/DocxParagraphAnchorOutput.d.ts +88 -0
  149. package/dist/models/DocxParagraphAnchorOutput.js +82 -0
  150. package/dist/models/FolderResponse.d.ts +7 -0
  151. package/dist/models/FolderResponse.js +5 -0
  152. package/dist/models/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.d.ts +33 -0
  153. package/dist/models/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.js +63 -0
  154. package/dist/models/InputSnapshot.d.ts +81 -0
  155. package/dist/models/{ABCDPathSnapshot.js → InputSnapshot.js} +24 -18
  156. package/dist/models/InstructionSnapshot.d.ts +16 -10
  157. package/dist/models/InstructionSnapshot.js +12 -7
  158. package/dist/models/MemoryChunkResponse.d.ts +1 -1
  159. package/dist/models/MemoryKind.d.ts +1 -4
  160. package/dist/models/MemoryKind.js +1 -4
  161. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.d.ts +66 -0
  162. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.js +78 -0
  163. package/dist/models/PaginatedResponseMemoryChunkResponse.d.ts +66 -0
  164. package/dist/models/PaginatedResponseMemoryChunkResponse.js +78 -0
  165. package/dist/models/PathPartApprovalDecision.d.ts +6 -5
  166. package/dist/models/PathPartApprovalDecision.js +7 -6
  167. package/dist/models/PathPartApprovalResponse.d.ts +2 -23
  168. package/dist/models/PathPartApprovalResponse.js +3 -15
  169. package/dist/models/PathPartApprovalState.d.ts +32 -0
  170. package/dist/models/PathPartApprovalState.js +58 -0
  171. package/dist/models/SectionContentItem.d.ts +7 -0
  172. package/dist/models/SectionContentItem.js +5 -0
  173. package/dist/models/SetApprovalStateRequest.d.ts +69 -0
  174. package/dist/models/SetApprovalStateRequest.js +65 -0
  175. package/dist/models/SetWorkflowRunApprovalRequest.d.ts +64 -0
  176. package/dist/models/SetWorkflowRunApprovalRequest.js +64 -0
  177. package/dist/models/ThreadMessageResponse.d.ts +7 -1
  178. package/dist/models/ThreadMessageResponse.js +2 -0
  179. package/dist/models/ThreadResponse.d.ts +1 -1
  180. package/dist/models/UpdateThreadRequest.d.ts +1 -1
  181. package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +4 -41
  182. package/dist/models/UpdateWorkflowDefinitionRequest.js +7 -38
  183. package/dist/models/UpdateWorkflowRunRequest.d.ts +58 -0
  184. package/dist/models/UpdateWorkflowRunRequest.js +61 -0
  185. package/dist/models/UserInfo.d.ts +59 -0
  186. package/dist/models/UserInfo.js +60 -0
  187. package/dist/models/UserMessageRequest.d.ts +1 -1
  188. package/dist/models/UserMessageResponse.d.ts +1 -1
  189. package/dist/models/WorkflowDefinitionResponse.d.ts +42 -24
  190. package/dist/models/WorkflowDefinitionResponse.js +32 -25
  191. package/dist/models/WorkflowExecutionState.d.ts +42 -0
  192. package/dist/models/WorkflowExecutionState.js +68 -0
  193. package/dist/models/WorkflowRunResponse.d.ts +91 -18
  194. package/dist/models/WorkflowRunResponse.js +60 -19
  195. package/dist/models/WorkflowRunSnapshot.d.ts +14 -37
  196. package/dist/models/WorkflowRunSnapshot.js +7 -28
  197. package/dist/models/XlsxCellAnchorInput.d.ts +79 -0
  198. package/dist/models/XlsxCellAnchorInput.js +75 -0
  199. package/dist/models/XlsxCellAnchorInputOrDocxParagraphAnchorInput.d.ts +27 -0
  200. package/dist/models/XlsxCellAnchorInputOrDocxParagraphAnchorInput.js +53 -0
  201. package/dist/models/XlsxCellAnchorOutput.d.ts +90 -0
  202. package/dist/models/XlsxCellAnchorOutput.js +78 -0
  203. package/dist/models/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.d.ts +27 -0
  204. package/dist/models/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.js +53 -0
  205. package/dist/models/index.d.ts +18 -10
  206. package/dist/models/index.js +18 -10
  207. package/docs/ChunkContentItem.md +2 -0
  208. package/docs/CitedChunk.md +45 -0
  209. package/docs/CloneWorkflowRunRequest.md +35 -0
  210. package/docs/CreateThreadMessageRequest.md +0 -1
  211. package/docs/CreateThreadRequest.md +4 -1
  212. package/docs/CreateWorkflowDefinitionRequest.md +3 -13
  213. package/docs/DocumentCheckoutApi.md +19 -16
  214. package/docs/DocumentCheckoutResponse.md +4 -4
  215. package/docs/DocumentResponse.md +4 -2
  216. package/docs/DocumentVersionMetadata.md +2 -0
  217. package/docs/DocumentVersionMetadataUpdate.md +2 -0
  218. package/docs/DocumentVersionResponse.md +2 -2
  219. package/docs/DocumentVersionsApi.md +0 -2
  220. package/docs/DocumentsApi.md +0 -2
  221. package/docs/{ABCDPathSnapshot.md → DocxParagraphAnchorInput.md} +15 -11
  222. package/docs/DocxParagraphAnchorOutput.md +45 -0
  223. package/docs/FolderResponse.md +2 -0
  224. package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.md +108 -0
  225. package/docs/FoldersApi.md +4 -6
  226. package/docs/InputSnapshot.md +39 -0
  227. package/docs/InstructionSnapshot.md +4 -4
  228. package/docs/MemoryChunkResponse.md +0 -1
  229. package/docs/MemoryKind.md +1 -1
  230. package/docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.md +40 -0
  231. package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md → PaginatedResponseMemoryChunkResponse.md} +5 -5
  232. package/docs/PathPartApprovalDecision.md +1 -1
  233. package/docs/PathPartApprovalResponse.md +3 -9
  234. package/docs/{InvokeWorkflowRequest.md → PathPartApprovalState.md} +5 -9
  235. package/docs/PathPartApprovalsApi.md +161 -0
  236. package/docs/PathPartsApi.md +1 -1
  237. package/docs/SectionContentItem.md +2 -0
  238. package/docs/SectionContentItemOrChunkContentItem.md +2 -0
  239. package/docs/SetApprovalStateRequest.md +37 -0
  240. package/docs/SetWorkflowRunApprovalRequest.md +37 -0
  241. package/docs/ThreadMessageResponse.md +2 -1
  242. package/docs/ThreadResponse.md +0 -1
  243. package/docs/UpdateThreadRequest.md +0 -1
  244. package/docs/UpdateWorkflowDefinitionRequest.md +3 -13
  245. package/docs/UpdateWorkflowRunRequest.md +37 -0
  246. package/docs/{RejectFileRequest.md → UserInfo.md} +11 -7
  247. package/docs/UserMessageRequest.md +0 -1
  248. package/docs/UserMessageResponse.md +0 -1
  249. package/docs/WorkflowDefinitionResponse.md +15 -13
  250. package/docs/WorkflowDefinitionsApi.md +38 -32
  251. package/docs/WorkflowExecutionState.md +33 -0
  252. package/docs/WorkflowMemoryApi.md +8 -4
  253. package/docs/WorkflowRunResponse.md +29 -9
  254. package/docs/WorkflowRunSnapshot.md +5 -15
  255. package/docs/WorkflowRunsApi.md +122 -42
  256. package/docs/{ListMemoryChunksResponse.md → XlsxCellAnchorInput.md} +15 -6
  257. package/docs/XlsxCellAnchorInputOrDocxParagraphAnchorInput.md +46 -0
  258. package/docs/XlsxCellAnchorOutput.md +45 -0
  259. package/docs/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.md +48 -0
  260. package/package.json +1 -1
  261. package/src/apis/DocumentCheckoutApi.ts +35 -28
  262. package/src/apis/DocumentVersionsApi.ts +1 -4
  263. package/src/apis/DocumentsApi.ts +1 -4
  264. package/src/apis/FoldersApi.ts +14 -17
  265. package/src/apis/PathPartApprovalsApi.ts +228 -0
  266. package/src/apis/PathPartsApi.ts +4 -4
  267. package/src/apis/WorkflowDefinitionsApi.ts +102 -78
  268. package/src/apis/WorkflowMemoryApi.ts +23 -12
  269. package/src/apis/WorkflowRunsApi.ts +198 -104
  270. package/src/apis/index.ts +1 -0
  271. package/src/models/ChunkContentItem.ts +16 -0
  272. package/src/models/CitedChunk.ts +141 -0
  273. package/src/models/CloneWorkflowRunRequest.ts +90 -0
  274. package/src/models/CreateThreadMessageRequest.ts +1 -1
  275. package/src/models/CreateThreadRequest.ts +21 -1
  276. package/src/models/CreateWorkflowDefinitionRequest.ts +11 -87
  277. package/src/models/DocumentCheckoutResponse.ts +19 -11
  278. package/src/models/DocumentResponse.ts +29 -6
  279. package/src/models/DocumentVersionMetadata.ts +15 -0
  280. package/src/models/DocumentVersionMetadataUpdate.ts +15 -0
  281. package/src/models/DocumentVersionResponse.ts +13 -6
  282. package/src/models/DocxParagraphAnchorInput.ts +142 -0
  283. package/src/models/DocxParagraphAnchorOutput.ts +153 -0
  284. package/src/models/FolderResponse.ts +16 -0
  285. package/src/models/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.ts +94 -0
  286. package/src/models/InputSnapshot.ts +126 -0
  287. package/src/models/InstructionSnapshot.ts +22 -22
  288. package/src/models/MemoryChunkResponse.ts +1 -1
  289. package/src/models/MemoryKind.ts +1 -4
  290. package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.ts} +25 -25
  291. package/src/models/PaginatedResponseMemoryChunkResponse.ts +130 -0
  292. package/src/models/PathPartApprovalDecision.ts +7 -6
  293. package/src/models/PathPartApprovalResponse.ts +5 -35
  294. package/src/models/PathPartApprovalState.ts +60 -0
  295. package/src/models/SectionContentItem.ts +17 -0
  296. package/src/models/SetApprovalStateRequest.ts +113 -0
  297. package/src/models/SetWorkflowRunApprovalRequest.ts +108 -0
  298. package/src/models/ThreadMessageResponse.ts +9 -1
  299. package/src/models/ThreadResponse.ts +1 -1
  300. package/src/models/UpdateThreadRequest.ts +1 -1
  301. package/src/models/UpdateWorkflowDefinitionRequest.ts +11 -90
  302. package/src/models/UpdateWorkflowRunRequest.ts +103 -0
  303. package/src/models/UserInfo.ts +101 -0
  304. package/src/models/UserMessageRequest.ts +1 -1
  305. package/src/models/UserMessageResponse.ts +1 -1
  306. package/src/models/WorkflowDefinitionResponse.ts +68 -53
  307. package/src/models/WorkflowExecutionState.ts +70 -0
  308. package/src/models/WorkflowRunResponse.ts +151 -44
  309. package/src/models/WorkflowRunSnapshot.ts +25 -71
  310. package/src/models/XlsxCellAnchorInput.ts +138 -0
  311. package/src/models/XlsxCellAnchorInputOrDocxParagraphAnchorInput.ts +72 -0
  312. package/src/models/XlsxCellAnchorOutput.ts +151 -0
  313. package/src/models/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.ts +72 -0
  314. package/src/models/index.ts +18 -10
  315. package/dist/esm/models/ABCDPathSnapshot.d.ts +0 -60
  316. package/dist/esm/models/FolderResponseOrDocumentResponse.d.ts +0 -27
  317. package/dist/esm/models/FolderResponseOrDocumentResponse.js +0 -47
  318. package/dist/esm/models/InvokeWorkflowRequest.d.ts +0 -53
  319. package/dist/esm/models/InvokeWorkflowRequest.js +0 -52
  320. package/dist/esm/models/ListMemoryChunksResponse.d.ts +0 -48
  321. package/dist/esm/models/ListMemoryChunksResponse.js +0 -45
  322. package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.d.ts +0 -66
  323. package/dist/esm/models/RejectFileRequest.d.ts +0 -47
  324. package/dist/esm/models/RejectFileRequest.js +0 -49
  325. package/dist/esm/models/SelfHostedRunnerConfig.d.ts +0 -53
  326. package/dist/esm/models/SelfHostedRunnerConfig.js +0 -53
  327. package/dist/esm/models/SelfHostedRunnerConfigResponse.d.ts +0 -47
  328. package/dist/esm/models/SelfHostedRunnerConfigResponse.js +0 -49
  329. package/dist/esm/models/WorkflowRunStatus.d.ts +0 -45
  330. package/dist/esm/models/WorkflowRunStatus.js +0 -63
  331. package/dist/esm/models/WorkflowRunnerType.d.ts +0 -25
  332. package/dist/esm/models/WorkflowRunnerType.js +0 -43
  333. package/dist/models/ABCDPathSnapshot.d.ts +0 -60
  334. package/dist/models/FolderResponseOrDocumentResponse.d.ts +0 -27
  335. package/dist/models/FolderResponseOrDocumentResponse.js +0 -53
  336. package/dist/models/InvokeWorkflowRequest.d.ts +0 -53
  337. package/dist/models/InvokeWorkflowRequest.js +0 -60
  338. package/dist/models/ListMemoryChunksResponse.d.ts +0 -48
  339. package/dist/models/ListMemoryChunksResponse.js +0 -53
  340. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.d.ts +0 -66
  341. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.js +0 -78
  342. package/dist/models/RejectFileRequest.d.ts +0 -47
  343. package/dist/models/RejectFileRequest.js +0 -57
  344. package/dist/models/SelfHostedRunnerConfig.d.ts +0 -53
  345. package/dist/models/SelfHostedRunnerConfig.js +0 -61
  346. package/dist/models/SelfHostedRunnerConfigResponse.d.ts +0 -47
  347. package/dist/models/SelfHostedRunnerConfigResponse.js +0 -57
  348. package/dist/models/WorkflowRunStatus.d.ts +0 -45
  349. package/dist/models/WorkflowRunStatus.js +0 -71
  350. package/dist/models/WorkflowRunnerType.d.ts +0 -25
  351. package/dist/models/WorkflowRunnerType.js +0 -51
  352. package/docs/FolderResponseOrDocumentResponse.md +0 -70
  353. package/docs/SelfHostedRunnerConfig.md +0 -37
  354. package/docs/SelfHostedRunnerConfigResponse.md +0 -35
  355. package/docs/WorkflowRunStatus.md +0 -33
  356. package/docs/WorkflowRunnerType.md +0 -33
  357. package/src/models/ABCDPathSnapshot.ts +0 -111
  358. package/src/models/FolderResponseOrDocumentResponse.ts +0 -72
  359. package/src/models/InvokeWorkflowRequest.ts +0 -97
  360. package/src/models/ListMemoryChunksResponse.ts +0 -91
  361. package/src/models/RejectFileRequest.ts +0 -87
  362. package/src/models/SelfHostedRunnerConfig.ts +0 -96
  363. package/src/models/SelfHostedRunnerConfigResponse.ts +0 -87
  364. package/src/models/WorkflowRunStatus.ts +0 -73
  365. package/src/models/WorkflowRunnerType.ts +0 -53
@@ -4,19 +4,19 @@ All URIs are relative to *http://localhost:8000*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
- | [**acquireDocumentCheckout**](DocumentCheckoutApi.md#acquiredocumentcheckout) | **POST** /v1/documents/{path_part_id}/checkout | Acquire Document Checkout Handler |
8
- | [**getDocumentCheckout**](DocumentCheckoutApi.md#getdocumentcheckout) | **GET** /v1/documents/{path_part_id}/checkout | Get Document Checkout Handler |
9
- | [**releaseDocumentCheckout**](DocumentCheckoutApi.md#releasedocumentcheckout) | **DELETE** /v1/documents/{path_part_id}/checkout | Release Document Checkout Handler |
7
+ | [**acquireDocumentCheckout**](DocumentCheckoutApi.md#acquiredocumentcheckout) | **POST** /v1/documents/{document_id}/checkout | Acquire Document Checkout Handler |
8
+ | [**getDocumentCheckout**](DocumentCheckoutApi.md#getdocumentcheckout) | **GET** /v1/documents/{document_id}/checkout | Get Document Checkout Handler |
9
+ | [**releaseDocumentCheckout**](DocumentCheckoutApi.md#releasedocumentcheckout) | **DELETE** /v1/documents/{document_id}/checkout | Release Document Checkout Handler |
10
10
 
11
11
 
12
12
 
13
13
  ## acquireDocumentCheckout
14
14
 
15
- > DocumentCheckoutResponse acquireDocumentCheckout(pathPartId, authorization, ksUat)
15
+ > DocumentCheckoutResponse acquireDocumentCheckout(documentId, force, authorization, ksUat)
16
16
 
17
17
  Acquire Document Checkout Handler
18
18
 
19
- Acquire a write lock on the document. If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
19
+ Acquire a write lock on the document. If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. ``?force=true`` lets OWNER/ADMIN steal the lock from the current holder; a sealed (approved) document is refused regardless of ``force``. Locks have no TTL — they persist until released by the holder.
20
20
 
21
21
  ### Example
22
22
 
@@ -32,8 +32,10 @@ async function example() {
32
32
  const api = new DocumentCheckoutApi();
33
33
 
34
34
  const body = {
35
- // string | Document\'s PathPart ID
36
- pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
35
+ // string | Document ID
36
+ documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
37
+ // boolean | OWNER/ADMIN only — atomically take the checkout regardless of the current holder. Sealed docs are still refused. (optional)
38
+ force: true,
37
39
  // string (optional)
38
40
  authorization: authorization_example,
39
41
  // string (optional)
@@ -57,7 +59,8 @@ example().catch(console.error);
57
59
 
58
60
  | Name | Type | Description | Notes |
59
61
  |------------- | ------------- | ------------- | -------------|
60
- | **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
62
+ | **documentId** | `string` | Document ID | [Defaults to `undefined`] |
63
+ | **force** | `boolean` | OWNER/ADMIN only — atomically take the checkout regardless of the current holder. Sealed docs are still refused. | [Optional] [Defaults to `false`] |
61
64
  | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
62
65
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
63
66
 
@@ -86,7 +89,7 @@ No authorization required
86
89
 
87
90
  ## getDocumentCheckout
88
91
 
89
- > DocumentCheckoutResponse getDocumentCheckout(pathPartId, authorization, ksUat)
92
+ > DocumentCheckoutResponse getDocumentCheckout(documentId, authorization, ksUat)
90
93
 
91
94
  Get Document Checkout Handler
92
95
 
@@ -106,8 +109,8 @@ async function example() {
106
109
  const api = new DocumentCheckoutApi();
107
110
 
108
111
  const body = {
109
- // string | Document\'s PathPart ID
110
- pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
112
+ // string | Document ID
113
+ documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
111
114
  // string (optional)
112
115
  authorization: authorization_example,
113
116
  // string (optional)
@@ -131,7 +134,7 @@ example().catch(console.error);
131
134
 
132
135
  | Name | Type | Description | Notes |
133
136
  |------------- | ------------- | ------------- | -------------|
134
- | **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
137
+ | **documentId** | `string` | Document ID | [Defaults to `undefined`] |
135
138
  | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
136
139
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
137
140
 
@@ -160,7 +163,7 @@ No authorization required
160
163
 
161
164
  ## releaseDocumentCheckout
162
165
 
163
- > releaseDocumentCheckout(pathPartId, authorization, ksUat)
166
+ > releaseDocumentCheckout(documentId, authorization, ksUat)
164
167
 
165
168
  Release Document Checkout Handler
166
169
 
@@ -180,8 +183,8 @@ async function example() {
180
183
  const api = new DocumentCheckoutApi();
181
184
 
182
185
  const body = {
183
- // string | Document\'s PathPart ID
184
- pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
186
+ // string | Document ID
187
+ documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
185
188
  // string (optional)
186
189
  authorization: authorization_example,
187
190
  // string (optional)
@@ -205,7 +208,7 @@ example().catch(console.error);
205
208
 
206
209
  | Name | Type | Description | Notes |
207
210
  |------------- | ------------- | ------------- | -------------|
208
- | **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
211
+ | **documentId** | `string` | Document ID | [Defaults to `undefined`] |
209
212
  | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
210
213
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
211
214
 
@@ -8,8 +8,8 @@ Active checkout state on a document.
8
8
  Name | Type
9
9
  ------------ | -------------
10
10
  `tenantId` | string
11
- `pathPartId` | string
12
- `userId` | string
11
+ `documentId` | string
12
+ `holder` | [UserInfo](UserInfo.md)
13
13
  `acquiredAt` | Date
14
14
 
15
15
  ## Example
@@ -20,8 +20,8 @@ import type { DocumentCheckoutResponse } from '@knowledge-stack/ksapi'
20
20
  // TODO: Update the object below with actual values
21
21
  const example = {
22
22
  "tenantId": null,
23
- "pathPartId": null,
24
- "userId": null,
23
+ "documentId": null,
24
+ "holder": null,
25
25
  "acquiredAt": null,
26
26
  } satisfies DocumentCheckoutResponse
27
27
 
@@ -18,9 +18,10 @@ Name | Type
18
18
  `activeVersion` | [DocumentVersionResponse](DocumentVersionResponse.md)
19
19
  `materializedPath` | string
20
20
  `systemManaged` | boolean
21
+ `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
21
22
  `excludeFromQdrant` | boolean
22
23
  `tenantId` | string
23
- `ownerTenantUserId` | string
24
+ `owner` | [UserInfo](UserInfo.md)
24
25
  `createdAt` | Date
25
26
  `updatedAt` | Date
26
27
  `tags` | [Array<TagResponse>](TagResponse.md)
@@ -45,9 +46,10 @@ const example = {
45
46
  "activeVersion": null,
46
47
  "materializedPath": null,
47
48
  "systemManaged": null,
49
+ "approvalState": null,
48
50
  "excludeFromQdrant": null,
49
51
  "tenantId": null,
50
- "ownerTenantUserId": null,
52
+ "owner": null,
51
53
  "createdAt": null,
52
54
  "updatedAt": null,
53
55
  "tags": null,
@@ -19,6 +19,7 @@ Name | Type
19
19
  `xlsxParseResultS3` | string
20
20
  `xlsxNamedRanges` | Array<{ [key: string]: any; }>
21
21
  `xlsxKpiCatalog` | Array<{ [key: string]: any; }>
22
+ `citationAnchors` | [Array<XlsxCellAnchorOutputOrDocxParagraphAnchorOutput>](XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.md)
22
23
  `informationStatistics` | [InformationStatistics](InformationStatistics.md)
23
24
  `quotaCharged` | boolean
24
25
  `quotaPageCount` | number
@@ -44,6 +45,7 @@ const example = {
44
45
  "xlsxParseResultS3": null,
45
46
  "xlsxNamedRanges": null,
46
47
  "xlsxKpiCatalog": null,
48
+ "citationAnchors": null,
47
49
  "informationStatistics": null,
48
50
  "quotaCharged": null,
49
51
  "quotaPageCount": null,
@@ -22,6 +22,7 @@ Name | Type
22
22
  `xlsxParseResultS3` | string
23
23
  `xlsxNamedRanges` | Array<{ [key: string]: any; }>
24
24
  `xlsxKpiCatalog` | Array<{ [key: string]: any; }>
25
+ `citationAnchors` | [Array<XlsxCellAnchorInputOrDocxParagraphAnchorInput>](XlsxCellAnchorInputOrDocxParagraphAnchorInput.md)
25
26
  `informationStatistics` | [InformationStatistics](InformationStatistics.md)
26
27
  `quotaCharged` | boolean
27
28
  `quotaPageCount` | number
@@ -50,6 +51,7 @@ const example = {
50
51
  "xlsxParseResultS3": null,
51
52
  "xlsxNamedRanges": null,
52
53
  "xlsxKpiCatalog": null,
54
+ "citationAnchors": null,
53
55
  "informationStatistics": null,
54
56
  "quotaCharged": null,
55
57
  "quotaPageCount": null,
@@ -15,7 +15,7 @@ Name | Type
15
15
  `materializedPath` | string
16
16
  `systemManaged` | boolean
17
17
  `tenantId` | string
18
- `uploaderTenantUserId` | string
18
+ `uploader` | [UserInfo](UserInfo.md)
19
19
  `createdAt` | Date
20
20
  `updatedAt` | Date
21
21
  `assetS3Url` | string
@@ -38,7 +38,7 @@ const example = {
38
38
  "materializedPath": null,
39
39
  "systemManaged": null,
40
40
  "tenantId": null,
41
- "uploaderTenantUserId": null,
41
+ "uploader": null,
42
42
  "createdAt": null,
43
43
  "updatedAt": null,
44
44
  "assetS3Url": null,
@@ -320,8 +320,6 @@ No authorization required
320
320
 
321
321
  Get Document Version Handler
322
322
 
323
- Get a document version by its ID.
324
-
325
323
  ### Example
326
324
 
327
325
  ```ts
@@ -168,8 +168,6 @@ No authorization required
168
168
 
169
169
  Get Document Handler
170
170
 
171
- Get a document by its document ID.
172
-
173
171
  ### Example
174
172
 
175
173
  ```ts
@@ -1,27 +1,31 @@
1
1
 
2
- # ABCDPathSnapshot
2
+ # DocxParagraphAnchorInput
3
3
 
4
- Snapshot of a single ABCD path reference at trigger time.
4
+ One citation anchored to a paragraph in a .docx deliverable.
5
5
 
6
6
  ## Properties
7
7
 
8
8
  Name | Type
9
9
  ------------ | -------------
10
- `pathPartId` | string
11
- `materializedPath` | string
12
- `partType` | [PartType](PartType.md)
10
+ `type` | string
11
+ `paragraphIndex` | number
12
+ `commentId` | number
13
+ `citations` | [Array<CitedChunk>](CitedChunk.md)
14
+ `anchorText` | string
13
15
 
14
16
  ## Example
15
17
 
16
18
  ```typescript
17
- import type { ABCDPathSnapshot } from '@knowledge-stack/ksapi'
19
+ import type { DocxParagraphAnchorInput } from '@knowledge-stack/ksapi'
18
20
 
19
21
  // TODO: Update the object below with actual values
20
22
  const example = {
21
- "pathPartId": null,
22
- "materializedPath": null,
23
- "partType": null,
24
- } satisfies ABCDPathSnapshot
23
+ "type": null,
24
+ "paragraphIndex": null,
25
+ "commentId": null,
26
+ "citations": null,
27
+ "anchorText": null,
28
+ } satisfies DocxParagraphAnchorInput
25
29
 
26
30
  console.log(example)
27
31
 
@@ -30,7 +34,7 @@ const exampleJSON: string = JSON.stringify(example)
30
34
  console.log(exampleJSON)
31
35
 
32
36
  // Parse the JSON string back to an object
33
- const exampleParsed = JSON.parse(exampleJSON) as ABCDPathSnapshot
37
+ const exampleParsed = JSON.parse(exampleJSON) as DocxParagraphAnchorInput
34
38
  console.log(exampleParsed)
35
39
  ```
36
40
 
@@ -0,0 +1,45 @@
1
+
2
+ # DocxParagraphAnchorOutput
3
+
4
+ One citation anchored to a paragraph in a .docx deliverable.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `type` | string
11
+ `paragraphIndex` | number
12
+ `commentId` | number
13
+ `citations` | [Array<CitedChunk>](CitedChunk.md)
14
+ `anchorText` | string
15
+ `chunkIds` | Array<string>
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import type { DocxParagraphAnchorOutput } from '@knowledge-stack/ksapi'
21
+
22
+ // TODO: Update the object below with actual values
23
+ const example = {
24
+ "type": null,
25
+ "paragraphIndex": null,
26
+ "commentId": null,
27
+ "citations": null,
28
+ "anchorText": null,
29
+ "chunkIds": null,
30
+ } satisfies DocxParagraphAnchorOutput
31
+
32
+ console.log(example)
33
+
34
+ // Convert the instance to a JSON string
35
+ const exampleJSON: string = JSON.stringify(example)
36
+ console.log(exampleJSON)
37
+
38
+ // Parse the JSON string back to an object
39
+ const exampleParsed = JSON.parse(exampleJSON) as DocxParagraphAnchorOutput
40
+ console.log(exampleParsed)
41
+ ```
42
+
43
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
44
+
45
+
@@ -14,6 +14,7 @@ Name | Type
14
14
  `parentPathPartId` | string
15
15
  `materializedPath` | string
16
16
  `systemManaged` | boolean
17
+ `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
17
18
  `excludeFromQdrant` | boolean
18
19
  `tenantId` | string
19
20
  `createdAt` | Date
@@ -35,6 +36,7 @@ const example = {
35
36
  "parentPathPartId": null,
36
37
  "materializedPath": null,
37
38
  "systemManaged": null,
39
+ "approvalState": null,
38
40
  "excludeFromQdrant": null,
39
41
  "tenantId": null,
40
42
  "createdAt": null,
@@ -0,0 +1,108 @@
1
+
2
+ # FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `partType` | string
10
+ `id` | string
11
+ `pathPartId` | string
12
+ `name` | string
13
+ `parentPathPartId` | string
14
+ `materializedPath` | string
15
+ `systemManaged` | boolean
16
+ `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
17
+ `excludeFromQdrant` | boolean
18
+ `tenantId` | string
19
+ `createdAt` | Date
20
+ `updatedAt` | Date
21
+ `tags` | [Array<TagResponse>](TagResponse.md)
22
+ `canWrite` | boolean
23
+ `documentType` | [DocumentType](DocumentType.md)
24
+ `documentOrigin` | [DocumentOrigin](DocumentOrigin.md)
25
+ `activeVersionId` | string
26
+ `activeVersion` | [DocumentVersionResponse](DocumentVersionResponse.md)
27
+ `owner` | [UserInfo](UserInfo.md)
28
+ `checkout` | [DocumentCheckoutResponse](DocumentCheckoutResponse.md)
29
+ `description` | string
30
+ `maxRunDurationSeconds` | number
31
+ `instructionPathPartId` | string
32
+ `isActive` | boolean
33
+ `approvalRequired` | boolean
34
+ `workflowDefinitionId` | string
35
+ `triggeredBy` | [UserInfo](UserInfo.md)
36
+ `executionState` | [WorkflowExecutionState](WorkflowExecutionState.md)
37
+ `startedAt` | Date
38
+ `completedAt` | Date
39
+ `runSnapshot` | [WorkflowRunSnapshot](WorkflowRunSnapshot.md)
40
+ `error` | string
41
+ `inputsPathPartId` | string
42
+ `outputsPathPartId` | string
43
+ `discussionsPathPartId` | string
44
+ `inputPathPartIds` | Array<string>
45
+ `outputsPathPartIds` | Array<string>
46
+ `runThreadId` | string
47
+
48
+ ## Example
49
+
50
+ ```typescript
51
+ import type { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse } from '@knowledge-stack/ksapi'
52
+
53
+ // TODO: Update the object below with actual values
54
+ const example = {
55
+ "partType": null,
56
+ "id": null,
57
+ "pathPartId": null,
58
+ "name": null,
59
+ "parentPathPartId": null,
60
+ "materializedPath": null,
61
+ "systemManaged": null,
62
+ "approvalState": null,
63
+ "excludeFromQdrant": null,
64
+ "tenantId": null,
65
+ "createdAt": null,
66
+ "updatedAt": null,
67
+ "tags": null,
68
+ "canWrite": null,
69
+ "documentType": null,
70
+ "documentOrigin": null,
71
+ "activeVersionId": null,
72
+ "activeVersion": null,
73
+ "owner": null,
74
+ "checkout": null,
75
+ "description": null,
76
+ "maxRunDurationSeconds": null,
77
+ "instructionPathPartId": null,
78
+ "isActive": null,
79
+ "approvalRequired": null,
80
+ "workflowDefinitionId": null,
81
+ "triggeredBy": null,
82
+ "executionState": null,
83
+ "startedAt": null,
84
+ "completedAt": null,
85
+ "runSnapshot": null,
86
+ "error": null,
87
+ "inputsPathPartId": null,
88
+ "outputsPathPartId": null,
89
+ "discussionsPathPartId": null,
90
+ "inputPathPartIds": null,
91
+ "outputsPathPartIds": null,
92
+ "runThreadId": null,
93
+ } satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse
94
+
95
+ console.log(example)
96
+
97
+ // Convert the instance to a JSON string
98
+ const exampleJSON: string = JSON.stringify(example)
99
+ console.log(exampleJSON)
100
+
101
+ // Parse the JSON string back to an object
102
+ const exampleParsed = JSON.parse(exampleJSON) as FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse
103
+ console.log(exampleParsed)
104
+ ```
105
+
106
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
107
+
108
+
@@ -246,8 +246,6 @@ No authorization required
246
246
 
247
247
  Get Folder Handler
248
248
 
249
- Get a folder by its folder ID.
250
-
251
249
  ### Example
252
250
 
253
251
  ```ts
@@ -319,7 +317,7 @@ No authorization required
319
317
 
320
318
  ## listFolderContents
321
319
 
322
- > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset, authorization, ksUat)
320
+ > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset, authorization, ksUat)
323
321
 
324
322
  List Folder Contents Handler
325
323
 
@@ -385,7 +383,7 @@ example().catch(console.error);
385
383
 
386
384
  ### Return type
387
385
 
388
- [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md)
386
+ [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.md)
389
387
 
390
388
  ### Authorization
391
389
 
@@ -494,7 +492,7 @@ No authorization required
494
492
 
495
493
  ## searchItems
496
494
 
497
- > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator searchItems(nameLike, sortOrder, partType, withTags, parentPathPartId, limit, offset, authorization, ksUat)
495
+ > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator searchItems(nameLike, sortOrder, partType, withTags, parentPathPartId, limit, offset, authorization, ksUat)
498
496
 
499
497
  Search Items Handler
500
498
 
@@ -563,7 +561,7 @@ example().catch(console.error);
563
561
 
564
562
  ### Return type
565
563
 
566
- [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md)
564
+ [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.md)
567
565
 
568
566
  ### Authorization
569
567
 
@@ -0,0 +1,39 @@
1
+
2
+ # InputSnapshot
3
+
4
+ One entry of a run\'s input scope, self-describing its pin semantics. ``part_type`` is the kind discriminator: * ``DOCUMENT_VERSION`` — a pinned document version. The DOCUMENT in the request scope was resolved to its active version at trigger time; ``path_part_id`` is that DOCUMENT_VERSION path_part and the entry does not float. * ``FOLDER`` — a live folder reference. ``path_part_id`` is the FOLDER path_part itself; its contents are NOT captured here and are enumerated live by the runner (see ``materialized_path`` for subtree scoping). The underlying PDO id (DocumentVersion or Folder) is resolved live at run time from ``path_part.metadata_obj_id``, not stored here.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `pathPartId` | string
11
+ `materializedPath` | string
12
+ `partType` | string
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { InputSnapshot } from '@knowledge-stack/ksapi'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "pathPartId": null,
22
+ "materializedPath": null,
23
+ "partType": null,
24
+ } satisfies InputSnapshot
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as InputSnapshot
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -1,7 +1,7 @@
1
1
 
2
2
  # InstructionSnapshot
3
3
 
4
- Snapshot of one instruction document, pinned at trigger time. The instruction file is the workflow\'s **contract**: the agent reads this exact ``document_version_id`` for the duration of the run, even if the document is edited mid-flight or after the run completes. Reproducibility and audit replay depend on this pinning.
4
+ Snapshot of one instruction document, pinned at trigger time. ``path_part_id`` is the pinned ``DOCUMENT_VERSION`` identity that audit replay keys off. The agent reads the body straight from ``source_s3_uri`` and resolves the version\'s PDO id live no PDO id is stored here.
5
5
 
6
6
  ## Properties
7
7
 
@@ -9,8 +9,8 @@ Name | Type
9
9
  ------------ | -------------
10
10
  `pathPartId` | string
11
11
  `materializedPath` | string
12
- `partType` | [PartType](PartType.md)
13
- `documentVersionId` | string
12
+ `partType` | string
13
+ `sourceS3Uri` | string
14
14
 
15
15
  ## Example
16
16
 
@@ -22,7 +22,7 @@ const example = {
22
22
  "pathPartId": null,
23
23
  "materializedPath": null,
24
24
  "partType": null,
25
- "documentVersionId": null,
25
+ "sourceS3Uri": null,
26
26
  } satisfies InstructionSnapshot
27
27
 
28
28
  console.log(example)
@@ -1,7 +1,6 @@
1
1
 
2
2
  # MemoryChunkResponse
3
3
 
4
- Parsed view of one fenced chunk in MEMORY.md.
5
4
 
6
5
  ## Properties
7
6
 
@@ -1,7 +1,7 @@
1
1
 
2
2
  # MemoryKind
3
3
 
4
- Category of a memory chunk inside a MEMORY.md document. Stored inside the chunk\'s HTML-comment fence as ``kind=<value>``. Not a Postgres enum — memory is file-backed, not table-backed.
4
+ Memory chunk kind inside a MEMORY.md document.
5
5
 
6
6
  ## Properties
7
7
 
@@ -0,0 +1,40 @@
1
+
2
+ # PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `items` | [Array&lt;FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse&gt;](FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.md)
10
+ `total` | number
11
+ `limit` | number
12
+ `offset` | number
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator } from '@knowledge-stack/ksapi'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "items": null,
22
+ "total": null,
23
+ "limit": null,
24
+ "offset": null,
25
+ } satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+
@@ -1,12 +1,12 @@
1
1
 
2
- # PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator
2
+ # PaginatedResponseMemoryChunkResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `items` | [Array&lt;FolderResponseOrDocumentResponse&gt;](FolderResponseOrDocumentResponse.md)
9
+ `items` | [Array&lt;MemoryChunkResponse&gt;](MemoryChunkResponse.md)
10
10
  `total` | number
11
11
  `limit` | number
12
12
  `offset` | number
@@ -14,7 +14,7 @@ Name | Type
14
14
  ## Example
15
15
 
16
16
  ```typescript
17
- import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator } from '@knowledge-stack/ksapi'
17
+ import type { PaginatedResponseMemoryChunkResponse } from '@knowledge-stack/ksapi'
18
18
 
19
19
  // TODO: Update the object below with actual values
20
20
  const example = {
@@ -22,7 +22,7 @@ const example = {
22
22
  "total": null,
23
23
  "limit": null,
24
24
  "offset": null,
25
- } satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator
25
+ } satisfies PaginatedResponseMemoryChunkResponse
26
26
 
27
27
  console.log(example)
28
28
 
@@ -31,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
31
31
  console.log(exampleJSON)
32
32
 
33
33
  // Parse the JSON string back to an object
34
- const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator
34
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseMemoryChunkResponse
35
35
  console.log(exampleParsed)
36
36
  ```
37
37