@knowledge-stack/ksapi 1.101.2 → 1.103.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 (425) hide show
  1. package/.openapi-generator/FILES +60 -4
  2. package/README.md +41 -4
  3. package/dist/apis/ApiConnectionsApi.d.ts +225 -0
  4. package/dist/apis/ApiConnectionsApi.js +322 -0
  5. package/dist/apis/AuditEventsApi.d.ts +57 -1
  6. package/dist/apis/AuditEventsApi.js +65 -0
  7. package/dist/apis/AuthApi.d.ts +5 -5
  8. package/dist/apis/AuthApi.js +3 -2
  9. package/dist/apis/DocumentVersionsApi.d.ts +26 -5
  10. package/dist/apis/DocumentVersionsApi.js +23 -2
  11. package/dist/apis/DocumentsApi.d.ts +22 -1
  12. package/dist/apis/DocumentsApi.js +21 -0
  13. package/dist/apis/FeedbackApi.d.ts +19 -1
  14. package/dist/apis/FeedbackApi.js +18 -0
  15. package/dist/apis/FoldersApi.d.ts +31 -13
  16. package/dist/apis/FoldersApi.js +22 -4
  17. package/dist/apis/InvitesApi.d.ts +29 -5
  18. package/dist/apis/InvitesApi.js +26 -2
  19. package/dist/apis/PathPartsApi.d.ts +57 -1
  20. package/dist/apis/PathPartsApi.js +68 -0
  21. package/dist/apis/TagsApi.d.ts +22 -1
  22. package/dist/apis/TagsApi.js +21 -0
  23. package/dist/apis/TenantGroupsApi.d.ts +43 -1
  24. package/dist/apis/TenantGroupsApi.js +42 -0
  25. package/dist/apis/TenantsApi.d.ts +16 -1
  26. package/dist/apis/TenantsApi.js +15 -0
  27. package/dist/apis/ThreadMessagesApi.d.ts +7 -1
  28. package/dist/apis/ThreadMessagesApi.js +6 -0
  29. package/dist/apis/ThreadsApi.d.ts +22 -1
  30. package/dist/apis/ThreadsApi.js +21 -0
  31. package/dist/apis/TrashApi.d.ts +28 -1
  32. package/dist/apis/TrashApi.js +27 -0
  33. package/dist/apis/UserPermissionsApi.d.ts +10 -1
  34. package/dist/apis/UserPermissionsApi.js +9 -0
  35. package/dist/apis/WorkflowDefinitionsApi.d.ts +81 -1
  36. package/dist/apis/WorkflowDefinitionsApi.js +93 -0
  37. package/dist/apis/WorkflowRunsApi.d.ts +119 -1
  38. package/dist/apis/WorkflowRunsApi.js +136 -0
  39. package/dist/apis/index.d.ts +1 -0
  40. package/dist/apis/index.js +1 -0
  41. package/dist/esm/apis/ApiConnectionsApi.d.ts +225 -0
  42. package/dist/esm/apis/ApiConnectionsApi.js +285 -0
  43. package/dist/esm/apis/AuditEventsApi.d.ts +57 -1
  44. package/dist/esm/apis/AuditEventsApi.js +65 -0
  45. package/dist/esm/apis/AuthApi.d.ts +5 -5
  46. package/dist/esm/apis/AuthApi.js +4 -3
  47. package/dist/esm/apis/DocumentVersionsApi.d.ts +26 -5
  48. package/dist/esm/apis/DocumentVersionsApi.js +23 -2
  49. package/dist/esm/apis/DocumentsApi.d.ts +22 -1
  50. package/dist/esm/apis/DocumentsApi.js +21 -0
  51. package/dist/esm/apis/FeedbackApi.d.ts +19 -1
  52. package/dist/esm/apis/FeedbackApi.js +18 -0
  53. package/dist/esm/apis/FoldersApi.d.ts +31 -13
  54. package/dist/esm/apis/FoldersApi.js +23 -5
  55. package/dist/esm/apis/InvitesApi.d.ts +29 -5
  56. package/dist/esm/apis/InvitesApi.js +26 -2
  57. package/dist/esm/apis/PathPartsApi.d.ts +57 -1
  58. package/dist/esm/apis/PathPartsApi.js +69 -1
  59. package/dist/esm/apis/TagsApi.d.ts +22 -1
  60. package/dist/esm/apis/TagsApi.js +21 -0
  61. package/dist/esm/apis/TenantGroupsApi.d.ts +43 -1
  62. package/dist/esm/apis/TenantGroupsApi.js +42 -0
  63. package/dist/esm/apis/TenantsApi.d.ts +16 -1
  64. package/dist/esm/apis/TenantsApi.js +15 -0
  65. package/dist/esm/apis/ThreadMessagesApi.d.ts +7 -1
  66. package/dist/esm/apis/ThreadMessagesApi.js +6 -0
  67. package/dist/esm/apis/ThreadsApi.d.ts +22 -1
  68. package/dist/esm/apis/ThreadsApi.js +21 -0
  69. package/dist/esm/apis/TrashApi.d.ts +28 -1
  70. package/dist/esm/apis/TrashApi.js +27 -0
  71. package/dist/esm/apis/UserPermissionsApi.d.ts +10 -1
  72. package/dist/esm/apis/UserPermissionsApi.js +9 -0
  73. package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +81 -1
  74. package/dist/esm/apis/WorkflowDefinitionsApi.js +94 -1
  75. package/dist/esm/apis/WorkflowRunsApi.d.ts +119 -1
  76. package/dist/esm/apis/WorkflowRunsApi.js +137 -1
  77. package/dist/esm/apis/index.d.ts +1 -0
  78. package/dist/esm/apis/index.js +1 -0
  79. package/dist/esm/models/AcceptDisclaimerRequest.d.ts +47 -0
  80. package/dist/esm/models/AcceptDisclaimerRequest.js +44 -0
  81. package/dist/esm/models/ApiAuthConfig.d.ts +56 -0
  82. package/dist/esm/models/ApiAuthConfig.js +55 -0
  83. package/dist/esm/models/ApiConnectionRequestRequest.d.ts +75 -0
  84. package/dist/esm/models/ApiConnectionRequestRequest.js +59 -0
  85. package/dist/esm/models/ApiConnectionRequestResponse.d.ts +73 -0
  86. package/dist/esm/models/ApiConnectionRequestResponse.js +60 -0
  87. package/dist/esm/models/ApiConnectionResponse.d.ts +163 -0
  88. package/dist/esm/models/ApiConnectionResponse.js +118 -0
  89. package/dist/esm/models/ApiKeyResponse.d.ts +12 -0
  90. package/dist/esm/models/ApiKeyResponse.js +8 -0
  91. package/dist/esm/models/CreateApiConnectionRequest.d.ts +85 -0
  92. package/dist/esm/models/CreateApiConnectionRequest.js +76 -0
  93. package/dist/esm/models/CreateApiKeyRequest.d.ts +6 -0
  94. package/dist/esm/models/CreateApiKeyRequest.js +2 -0
  95. package/dist/esm/models/CreateApiKeyResponse.d.ts +6 -0
  96. package/dist/esm/models/CreateApiKeyResponse.js +4 -0
  97. package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
  98. package/dist/esm/models/CreateWorkflowDefinitionRequest.js +2 -0
  99. package/dist/esm/models/DataSourceQueryRequest.d.ts +9 -0
  100. package/dist/esm/models/DataSourceQueryRequest.js +6 -0
  101. package/dist/esm/models/DataSourceQueryResponse.d.ts +10 -0
  102. package/dist/esm/models/DataSourceQueryResponse.js +2 -0
  103. package/dist/esm/models/DataSourceResponse.d.ts +7 -0
  104. package/dist/esm/models/DataSourceResponse.js +3 -0
  105. package/dist/esm/models/DocumentResponse.d.ts +2 -2
  106. package/dist/esm/models/DocumentResponse.js +1 -3
  107. package/dist/esm/models/DocumentVersionOrder.d.ts +25 -0
  108. package/dist/esm/models/DocumentVersionOrder.js +43 -0
  109. package/dist/esm/models/ErrorResponse.d.ts +59 -0
  110. package/dist/esm/models/ErrorResponse.js +50 -0
  111. package/dist/esm/models/FeedbackOrder.d.ts +24 -0
  112. package/dist/esm/models/FeedbackOrder.js +42 -0
  113. package/dist/esm/models/FolderResponse.d.ts +7 -0
  114. package/dist/esm/models/FolderResponse.js +3 -0
  115. package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
  116. package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +11 -6
  117. package/dist/esm/models/GroupMemberOrder.d.ts +25 -0
  118. package/dist/esm/models/GroupMemberOrder.js +43 -0
  119. package/dist/esm/models/GroupPermissionOrder.d.ts +25 -0
  120. package/dist/esm/models/GroupPermissionOrder.js +43 -0
  121. package/dist/esm/models/InstantiateWorkflowTemplateRequest.d.ts +55 -0
  122. package/dist/esm/models/InstantiateWorkflowTemplateRequest.js +50 -0
  123. package/dist/esm/models/InviteOrder.d.ts +25 -0
  124. package/dist/esm/models/InviteOrder.js +43 -0
  125. package/dist/esm/models/InviteResponse.d.ts +6 -0
  126. package/dist/esm/models/InviteResponse.js +2 -0
  127. package/dist/esm/models/NetworkClass.d.ts +28 -0
  128. package/dist/esm/models/NetworkClass.js +46 -0
  129. package/dist/{models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.d.ts → esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts} +16 -16
  130. package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +12 -12
  131. package/dist/esm/models/PartType.d.ts +1 -0
  132. package/dist/esm/models/PartType.js +2 -1
  133. package/dist/esm/models/ReferenceType.d.ts +1 -0
  134. package/dist/esm/models/ReferenceType.js +1 -0
  135. package/dist/esm/models/SearchablePartType.d.ts +1 -0
  136. package/dist/esm/models/SearchablePartType.js +2 -1
  137. package/dist/esm/models/SortDirection.d.ts +25 -0
  138. package/dist/esm/models/SortDirection.js +43 -0
  139. package/dist/esm/models/TagOrder.d.ts +25 -0
  140. package/dist/esm/models/TagOrder.js +43 -0
  141. package/dist/esm/models/TenantGroupOrder.d.ts +25 -0
  142. package/dist/esm/models/TenantGroupOrder.js +43 -0
  143. package/dist/esm/models/TenantUserOrder.d.ts +26 -0
  144. package/dist/esm/models/TenantUserOrder.js +44 -0
  145. package/dist/esm/models/ThreadOrder.d.ts +25 -0
  146. package/dist/esm/models/ThreadOrder.js +43 -0
  147. package/dist/esm/models/ThreadResponse.d.ts +7 -0
  148. package/dist/esm/models/ThreadResponse.js +3 -0
  149. package/dist/esm/models/TransferOwnerRequest.d.ts +47 -0
  150. package/dist/esm/models/TransferOwnerRequest.js +44 -0
  151. package/dist/esm/models/TransferOwnerResponse.d.ts +53 -0
  152. package/dist/esm/models/TransferOwnerResponse.js +48 -0
  153. package/dist/esm/models/TrashItemResponse.d.ts +7 -0
  154. package/dist/esm/models/TrashItemResponse.js +3 -0
  155. package/dist/esm/models/UpdateApiConnectionRequest.d.ts +73 -0
  156. package/dist/esm/models/UpdateApiConnectionRequest.js +59 -0
  157. package/dist/esm/models/UserPermissionOrder.d.ts +25 -0
  158. package/dist/esm/models/UserPermissionOrder.js +43 -0
  159. package/dist/esm/models/WorkflowAdoptionStats.d.ts +63 -0
  160. package/dist/esm/models/WorkflowAdoptionStats.js +52 -0
  161. package/dist/esm/models/WorkflowDefinitionOrder.d.ts +25 -0
  162. package/dist/esm/models/WorkflowDefinitionOrder.js +43 -0
  163. package/dist/esm/models/WorkflowDefinitionResponse.d.ts +25 -0
  164. package/dist/esm/models/WorkflowDefinitionResponse.js +13 -0
  165. package/dist/esm/models/WorkflowRunOrder.d.ts +26 -0
  166. package/dist/esm/models/WorkflowRunOrder.js +44 -0
  167. package/dist/esm/models/WorkflowRunResponse.d.ts +6 -0
  168. package/dist/esm/models/WorkflowRunResponse.js +2 -0
  169. package/dist/esm/models/WorkflowRunSummaryResponse.d.ts +111 -0
  170. package/dist/esm/models/WorkflowRunSummaryResponse.js +81 -0
  171. package/dist/esm/models/index.d.ts +29 -2
  172. package/dist/esm/models/index.js +29 -2
  173. package/dist/models/AcceptDisclaimerRequest.d.ts +47 -0
  174. package/dist/models/AcceptDisclaimerRequest.js +52 -0
  175. package/dist/models/ApiAuthConfig.d.ts +56 -0
  176. package/dist/models/ApiAuthConfig.js +63 -0
  177. package/dist/models/ApiConnectionRequestRequest.d.ts +75 -0
  178. package/dist/models/ApiConnectionRequestRequest.js +67 -0
  179. package/dist/models/ApiConnectionRequestResponse.d.ts +73 -0
  180. package/dist/models/ApiConnectionRequestResponse.js +68 -0
  181. package/dist/models/ApiConnectionResponse.d.ts +163 -0
  182. package/dist/models/ApiConnectionResponse.js +126 -0
  183. package/dist/models/ApiKeyResponse.d.ts +12 -0
  184. package/dist/models/ApiKeyResponse.js +8 -0
  185. package/dist/models/CreateApiConnectionRequest.d.ts +85 -0
  186. package/dist/models/CreateApiConnectionRequest.js +84 -0
  187. package/dist/models/CreateApiKeyRequest.d.ts +6 -0
  188. package/dist/models/CreateApiKeyRequest.js +2 -0
  189. package/dist/models/CreateApiKeyResponse.d.ts +6 -0
  190. package/dist/models/CreateApiKeyResponse.js +4 -0
  191. package/dist/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
  192. package/dist/models/CreateWorkflowDefinitionRequest.js +2 -0
  193. package/dist/models/DataSourceQueryRequest.d.ts +9 -0
  194. package/dist/models/DataSourceQueryRequest.js +6 -0
  195. package/dist/models/DataSourceQueryResponse.d.ts +10 -0
  196. package/dist/models/DataSourceQueryResponse.js +2 -0
  197. package/dist/models/DataSourceResponse.d.ts +7 -0
  198. package/dist/models/DataSourceResponse.js +3 -0
  199. package/dist/models/DocumentResponse.d.ts +2 -2
  200. package/dist/models/DocumentResponse.js +1 -3
  201. package/dist/models/DocumentVersionOrder.d.ts +25 -0
  202. package/dist/models/DocumentVersionOrder.js +51 -0
  203. package/dist/models/ErrorResponse.d.ts +59 -0
  204. package/dist/models/ErrorResponse.js +58 -0
  205. package/dist/models/FeedbackOrder.d.ts +24 -0
  206. package/dist/models/FeedbackOrder.js +50 -0
  207. package/dist/models/FolderResponse.d.ts +7 -0
  208. package/dist/models/FolderResponse.js +3 -0
  209. package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
  210. package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +15 -10
  211. package/dist/models/GroupMemberOrder.d.ts +25 -0
  212. package/dist/models/GroupMemberOrder.js +51 -0
  213. package/dist/models/GroupPermissionOrder.d.ts +25 -0
  214. package/dist/models/GroupPermissionOrder.js +51 -0
  215. package/dist/models/InstantiateWorkflowTemplateRequest.d.ts +55 -0
  216. package/dist/models/InstantiateWorkflowTemplateRequest.js +58 -0
  217. package/dist/models/InviteOrder.d.ts +25 -0
  218. package/dist/models/InviteOrder.js +51 -0
  219. package/dist/models/InviteResponse.d.ts +6 -0
  220. package/dist/models/InviteResponse.js +2 -0
  221. package/dist/models/NetworkClass.d.ts +28 -0
  222. package/dist/models/NetworkClass.js +54 -0
  223. package/dist/{esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.d.ts → models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts} +16 -16
  224. package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +18 -18
  225. package/dist/models/PartType.d.ts +1 -0
  226. package/dist/models/PartType.js +2 -1
  227. package/dist/models/ReferenceType.d.ts +1 -0
  228. package/dist/models/ReferenceType.js +1 -0
  229. package/dist/models/SearchablePartType.d.ts +1 -0
  230. package/dist/models/SearchablePartType.js +2 -1
  231. package/dist/models/SortDirection.d.ts +25 -0
  232. package/dist/models/SortDirection.js +51 -0
  233. package/dist/models/TagOrder.d.ts +25 -0
  234. package/dist/models/TagOrder.js +51 -0
  235. package/dist/models/TenantGroupOrder.d.ts +25 -0
  236. package/dist/models/TenantGroupOrder.js +51 -0
  237. package/dist/models/TenantUserOrder.d.ts +26 -0
  238. package/dist/models/TenantUserOrder.js +52 -0
  239. package/dist/models/ThreadOrder.d.ts +25 -0
  240. package/dist/models/ThreadOrder.js +51 -0
  241. package/dist/models/ThreadResponse.d.ts +7 -0
  242. package/dist/models/ThreadResponse.js +3 -0
  243. package/dist/models/TransferOwnerRequest.d.ts +47 -0
  244. package/dist/models/TransferOwnerRequest.js +52 -0
  245. package/dist/models/TransferOwnerResponse.d.ts +53 -0
  246. package/dist/models/TransferOwnerResponse.js +56 -0
  247. package/dist/models/TrashItemResponse.d.ts +7 -0
  248. package/dist/models/TrashItemResponse.js +3 -0
  249. package/dist/models/UpdateApiConnectionRequest.d.ts +73 -0
  250. package/dist/models/UpdateApiConnectionRequest.js +67 -0
  251. package/dist/models/UserPermissionOrder.d.ts +25 -0
  252. package/dist/models/UserPermissionOrder.js +51 -0
  253. package/dist/models/WorkflowAdoptionStats.d.ts +63 -0
  254. package/dist/models/WorkflowAdoptionStats.js +60 -0
  255. package/dist/models/WorkflowDefinitionOrder.d.ts +25 -0
  256. package/dist/models/WorkflowDefinitionOrder.js +51 -0
  257. package/dist/models/WorkflowDefinitionResponse.d.ts +25 -0
  258. package/dist/models/WorkflowDefinitionResponse.js +13 -0
  259. package/dist/models/WorkflowRunOrder.d.ts +26 -0
  260. package/dist/models/WorkflowRunOrder.js +52 -0
  261. package/dist/models/WorkflowRunResponse.d.ts +6 -0
  262. package/dist/models/WorkflowRunResponse.js +2 -0
  263. package/dist/models/WorkflowRunSummaryResponse.d.ts +111 -0
  264. package/dist/models/WorkflowRunSummaryResponse.js +89 -0
  265. package/dist/models/index.d.ts +29 -2
  266. package/dist/models/index.js +29 -2
  267. package/docs/AcceptDisclaimerRequest.md +35 -0
  268. package/docs/AgentApi.md +2 -0
  269. package/docs/ApiAuthConfig.md +37 -0
  270. package/docs/ApiConnectionRequestRequest.md +43 -0
  271. package/docs/ApiConnectionRequestResponse.md +43 -0
  272. package/docs/ApiConnectionResponse.md +69 -0
  273. package/docs/ApiConnectionsApi.md +397 -0
  274. package/docs/ApiKeyResponse.md +4 -0
  275. package/docs/ApiKeysApi.md +4 -0
  276. package/docs/AuditEventsApi.md +96 -1
  277. package/docs/AuthApi.md +20 -2
  278. package/docs/ChunkLineagesApi.md +3 -0
  279. package/docs/ChunksApi.md +10 -1
  280. package/docs/CreateApiConnectionRequest.md +47 -0
  281. package/docs/CreateApiKeyRequest.md +2 -0
  282. package/docs/CreateApiKeyResponse.md +2 -0
  283. package/docs/CreateWorkflowDefinitionRequest.md +2 -0
  284. package/docs/DataSourceQueryRequest.md +3 -1
  285. package/docs/DataSourceQueryResponse.md +3 -1
  286. package/docs/DataSourceResponse.md +2 -0
  287. package/docs/DataSourcesApi.md +7 -0
  288. package/docs/DefaultApi.md +2 -0
  289. package/docs/DocumentCheckoutApi.md +3 -0
  290. package/docs/DocumentVersionOrder.md +33 -0
  291. package/docs/DocumentVersionsApi.md +33 -2
  292. package/docs/DocumentsApi.md +30 -1
  293. package/docs/ErrorResponse.md +39 -0
  294. package/docs/FeaturesApi.md +1 -0
  295. package/docs/FeedbackApi.md +22 -1
  296. package/docs/FeedbackOrder.md +33 -0
  297. package/docs/FolderResponse.md +2 -0
  298. package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md} +24 -6
  299. package/docs/FoldersApi.md +33 -7
  300. package/docs/GroupMemberOrder.md +33 -0
  301. package/docs/GroupPermissionOrder.md +33 -0
  302. package/docs/InstantiateWorkflowTemplateRequest.md +37 -0
  303. package/docs/InviteOrder.md +33 -0
  304. package/docs/InviteResponse.md +2 -0
  305. package/docs/InvitesApi.md +31 -2
  306. package/docs/MemoryApi.md +5 -0
  307. package/docs/NetworkClass.md +33 -0
  308. package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md} +5 -5
  309. package/docs/PathPartApprovalsApi.md +2 -0
  310. package/docs/PathPartsApi.md +105 -1
  311. package/docs/PublicApi.md +1 -0
  312. package/docs/SectionsApi.md +6 -0
  313. package/docs/SortDirection.md +33 -0
  314. package/docs/SubscriptionsApi.md +2 -0
  315. package/docs/TagOrder.md +33 -0
  316. package/docs/TagsApi.md +27 -1
  317. package/docs/TenantGroupOrder.md +33 -0
  318. package/docs/TenantGroupsApi.md +58 -3
  319. package/docs/TenantUserOrder.md +33 -0
  320. package/docs/TenantsApi.md +28 -1
  321. package/docs/ThreadMessagesApi.md +10 -1
  322. package/docs/ThreadOrder.md +33 -0
  323. package/docs/ThreadResponse.md +2 -0
  324. package/docs/ThreadsApi.md +29 -1
  325. package/docs/TransferOwnerRequest.md +35 -0
  326. package/docs/TransferOwnerResponse.md +36 -0
  327. package/docs/TrashApi.md +31 -1
  328. package/docs/TrashItemResponse.md +2 -0
  329. package/docs/UpdateApiConnectionRequest.md +43 -0
  330. package/docs/UserPermissionOrder.md +33 -0
  331. package/docs/UserPermissionsApi.md +14 -1
  332. package/docs/UsersApi.md +5 -0
  333. package/docs/WorkflowAdoptionStats.md +39 -0
  334. package/docs/WorkflowDefinitionOrder.md +33 -0
  335. package/docs/WorkflowDefinitionResponse.md +8 -0
  336. package/docs/WorkflowDefinitionsApi.md +128 -2
  337. package/docs/WorkflowMemoryApi.md +5 -0
  338. package/docs/WorkflowRunOrder.md +33 -0
  339. package/docs/WorkflowRunResponse.md +2 -0
  340. package/docs/WorkflowRunSummaryResponse.md +53 -0
  341. package/docs/WorkflowRunsApi.md +203 -0
  342. package/docs/WorkflowsApi.md +5 -0
  343. package/package.json +1 -1
  344. package/src/apis/AgentApi.ts +3 -0
  345. package/src/apis/ApiConnectionsApi.ts +516 -0
  346. package/src/apis/ApiKeysApi.ts +3 -0
  347. package/src/apis/AuditEventsApi.ts +127 -0
  348. package/src/apis/AuthApi.ts +10 -6
  349. package/src/apis/ChunkLineagesApi.ts +3 -0
  350. package/src/apis/ChunksApi.ts +3 -0
  351. package/src/apis/DataSourcesApi.ts +3 -0
  352. package/src/apis/DefaultApi.ts +3 -0
  353. package/src/apis/DocumentCheckoutApi.ts +3 -0
  354. package/src/apis/DocumentVersionsApi.ts +62 -4
  355. package/src/apis/DocumentsApi.ts +58 -0
  356. package/src/apis/FeaturesApi.ts +3 -0
  357. package/src/apis/FeedbackApi.ts +51 -0
  358. package/src/apis/FoldersApi.ts +65 -17
  359. package/src/apis/InvitesApi.ts +72 -4
  360. package/src/apis/MemoryApi.ts +3 -0
  361. package/src/apis/PathPartApprovalsApi.ts +3 -0
  362. package/src/apis/PathPartsApi.ts +143 -0
  363. package/src/apis/PublicApi.ts +3 -0
  364. package/src/apis/SectionsApi.ts +3 -0
  365. package/src/apis/SubscriptionsApi.ts +3 -0
  366. package/src/apis/TagsApi.ts +58 -0
  367. package/src/apis/TenantGroupsApi.ts +116 -0
  368. package/src/apis/TenantsApi.ts +47 -0
  369. package/src/apis/ThreadMessagesApi.ts +23 -0
  370. package/src/apis/ThreadsApi.ts +58 -0
  371. package/src/apis/TrashApi.ts +75 -0
  372. package/src/apis/UserPermissionsApi.ts +33 -0
  373. package/src/apis/UsersApi.ts +3 -0
  374. package/src/apis/WorkflowDefinitionsApi.ts +206 -0
  375. package/src/apis/WorkflowMemoryApi.ts +3 -0
  376. package/src/apis/WorkflowRunsApi.ts +274 -0
  377. package/src/apis/WorkflowsApi.ts +3 -0
  378. package/src/apis/index.ts +1 -0
  379. package/src/models/AcceptDisclaimerRequest.ts +83 -0
  380. package/src/models/ApiAuthConfig.ts +101 -0
  381. package/src/models/ApiConnectionRequestRequest.ts +121 -0
  382. package/src/models/ApiConnectionRequestResponse.ts +119 -0
  383. package/src/models/ApiConnectionResponse.ts +276 -0
  384. package/src/models/ApiKeyResponse.ts +18 -0
  385. package/src/models/CreateApiConnectionRequest.ts +161 -0
  386. package/src/models/CreateApiKeyRequest.ts +8 -0
  387. package/src/models/CreateApiKeyResponse.ts +9 -0
  388. package/src/models/CreateWorkflowDefinitionRequest.ts +8 -0
  389. package/src/models/DataSourceQueryRequest.ts +15 -0
  390. package/src/models/DataSourceQueryResponse.ts +12 -0
  391. package/src/models/DataSourceResponse.ts +15 -0
  392. package/src/models/DocumentResponse.ts +3 -4
  393. package/src/models/DocumentVersionOrder.ts +53 -0
  394. package/src/models/ErrorResponse.ts +100 -0
  395. package/src/models/FeedbackOrder.ts +52 -0
  396. package/src/models/FolderResponse.ts +15 -0
  397. package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.ts} +19 -8
  398. package/src/models/GroupMemberOrder.ts +53 -0
  399. package/src/models/GroupPermissionOrder.ts +53 -0
  400. package/src/models/InstantiateWorkflowTemplateRequest.ts +96 -0
  401. package/src/models/InviteOrder.ts +53 -0
  402. package/src/models/InviteResponse.ts +8 -0
  403. package/src/models/NetworkClass.ts +56 -0
  404. package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts} +25 -25
  405. package/src/models/PartType.ts +2 -1
  406. package/src/models/ReferenceType.ts +1 -0
  407. package/src/models/SearchablePartType.ts +2 -1
  408. package/src/models/SortDirection.ts +53 -0
  409. package/src/models/TagOrder.ts +53 -0
  410. package/src/models/TenantGroupOrder.ts +53 -0
  411. package/src/models/TenantUserOrder.ts +54 -0
  412. package/src/models/ThreadOrder.ts +53 -0
  413. package/src/models/ThreadResponse.ts +16 -0
  414. package/src/models/TransferOwnerRequest.ts +83 -0
  415. package/src/models/TransferOwnerResponse.ts +92 -0
  416. package/src/models/TrashItemResponse.ts +15 -0
  417. package/src/models/UpdateApiConnectionRequest.ts +137 -0
  418. package/src/models/UserPermissionOrder.ts +53 -0
  419. package/src/models/WorkflowAdoptionStats.ts +105 -0
  420. package/src/models/WorkflowDefinitionOrder.ts +53 -0
  421. package/src/models/WorkflowDefinitionResponse.ts +41 -0
  422. package/src/models/WorkflowRunOrder.ts +54 -0
  423. package/src/models/WorkflowRunResponse.ts +8 -0
  424. package/src/models/WorkflowRunSummaryResponse.ts +179 -0
  425. package/src/models/index.ts +29 -2
@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8000*
8
8
  | [**createWorkflowRun**](WorkflowDefinitionsApi.md#createworkflowrun) | **POST** /v1/workflow-definitions/{definition_id}/runs | Create Workflow Run Handler |
9
9
  | [**deleteWorkflowDefinition**](WorkflowDefinitionsApi.md#deleteworkflowdefinition) | **DELETE** /v1/workflow-definitions/{definition_id} | Delete Workflow Definition Handler |
10
10
  | [**getWorkflowDefinition**](WorkflowDefinitionsApi.md#getworkflowdefinition) | **GET** /v1/workflow-definitions/{definition_id} | Get Workflow Definition Handler |
11
+ | [**instantiateWorkflowTemplate**](WorkflowDefinitionsApi.md#instantiateworkflowtemplateoperation) | **POST** /v1/workflow-definitions/{template_id}/instantiate | Instantiate Workflow Template Handler |
11
12
  | [**listWorkflowDefinitions**](WorkflowDefinitionsApi.md#listworkflowdefinitions) | **GET** /v1/workflow-definitions | List Workflow Definitions Handler |
12
13
  | [**listWorkflowRuns**](WorkflowDefinitionsApi.md#listworkflowruns) | **GET** /v1/workflow-definitions/{definition_id}/runs | List Workflow Runs Handler |
13
14
  | [**updateWorkflowDefinition**](WorkflowDefinitionsApi.md#updateworkflowdefinitionoperation) | **PUT** /v1/workflow-definitions/{definition_id} | Update Workflow Definition Handler |
@@ -82,6 +83,7 @@ example().catch(console.error);
82
83
  |-------------|-------------|------------------|
83
84
  | **201** | Successful Response | - |
84
85
  | **422** | Validation Error | - |
86
+ | **0** | Error response. | - |
85
87
 
86
88
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
87
89
 
@@ -165,6 +167,7 @@ example().catch(console.error);
165
167
  |-------------|-------------|------------------|
166
168
  | **201** | Successful Response | - |
167
169
  | **422** | Validation Error | - |
170
+ | **0** | Error response. | - |
168
171
 
169
172
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
170
173
 
@@ -237,6 +240,7 @@ example().catch(console.error);
237
240
  |-------------|-------------|------------------|
238
241
  | **204** | Successful Response | - |
239
242
  | **422** | Validation Error | - |
243
+ | **0** | Error response. | - |
240
244
 
241
245
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
242
246
 
@@ -309,13 +313,90 @@ example().catch(console.error);
309
313
  |-------------|-------------|------------------|
310
314
  | **200** | Successful Response | - |
311
315
  | **422** | Validation Error | - |
316
+ | **0** | Error response. | - |
317
+
318
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
319
+
320
+
321
+ ## instantiateWorkflowTemplate
322
+
323
+ > WorkflowDefinitionResponse instantiateWorkflowTemplate(templateId, instantiateWorkflowTemplateRequest)
324
+
325
+ Instantiate Workflow Template Handler
326
+
327
+ ### Example
328
+
329
+ ```ts
330
+ import {
331
+ Configuration,
332
+ WorkflowDefinitionsApi,
333
+ } from '@knowledge-stack/ksapi';
334
+ import type { InstantiateWorkflowTemplateOperationRequest } from '@knowledge-stack/ksapi';
335
+
336
+ async function example() {
337
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
338
+ const config = new Configuration({
339
+ // To configure API key authorization: cookieAuth
340
+ apiKey: "YOUR API KEY",
341
+ // Configure HTTP bearer authorization: bearerAuth
342
+ accessToken: "YOUR BEARER TOKEN",
343
+ });
344
+ const api = new WorkflowDefinitionsApi(config);
345
+
346
+ const body = {
347
+ // string
348
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
349
+ // InstantiateWorkflowTemplateRequest
350
+ instantiateWorkflowTemplateRequest: ...,
351
+ } satisfies InstantiateWorkflowTemplateOperationRequest;
352
+
353
+ try {
354
+ const data = await api.instantiateWorkflowTemplate(body);
355
+ console.log(data);
356
+ } catch (error) {
357
+ console.error(error);
358
+ }
359
+ }
360
+
361
+ // Run the test
362
+ example().catch(console.error);
363
+ ```
364
+
365
+ ### Parameters
366
+
367
+
368
+ | Name | Type | Description | Notes |
369
+ |------------- | ------------- | ------------- | -------------|
370
+ | **templateId** | `string` | | [Defaults to `undefined`] |
371
+ | **instantiateWorkflowTemplateRequest** | [InstantiateWorkflowTemplateRequest](InstantiateWorkflowTemplateRequest.md) | | |
372
+
373
+ ### Return type
374
+
375
+ [**WorkflowDefinitionResponse**](WorkflowDefinitionResponse.md)
376
+
377
+ ### Authorization
378
+
379
+ [cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
380
+
381
+ ### HTTP request headers
382
+
383
+ - **Content-Type**: `application/json`
384
+ - **Accept**: `application/json`
385
+
386
+
387
+ ### HTTP response details
388
+ | Status code | Description | Response headers |
389
+ |-------------|-------------|------------------|
390
+ | **201** | Successful Response | - |
391
+ | **422** | Validation Error | - |
392
+ | **0** | Error response. | - |
312
393
 
313
394
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
314
395
 
315
396
 
316
397
  ## listWorkflowDefinitions
317
398
 
318
- > PaginatedResponseWorkflowDefinitionResponse listWorkflowDefinitions(limit, offset)
399
+ > PaginatedResponseWorkflowDefinitionResponse listWorkflowDefinitions(mine, sortBy, sortDir, isTemplate, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
319
400
 
320
401
  List Workflow Definitions Handler
321
402
 
@@ -339,10 +420,26 @@ async function example() {
339
420
  const api = new WorkflowDefinitionsApi(config);
340
421
 
341
422
  const body = {
423
+ // boolean | Only definitions the caller created (owner). (optional)
424
+ mine: true,
425
+ // WorkflowDefinitionOrder | Field to sort definitions by (default: CREATED_AT) (optional)
426
+ sortBy: ...,
427
+ // SortDirection | Sort direction; overrides the field\'s natural default (optional)
428
+ sortDir: ...,
429
+ // boolean (optional)
430
+ isTemplate: true,
342
431
  // number | Number of items per page (optional)
343
432
  limit: 56,
344
433
  // number | Number of items to skip (optional)
345
434
  offset: 56,
435
+ // Date | Only items created at or after this timestamp (inclusive) (optional)
436
+ createdAfter: 2013-10-20T19:20:30+01:00,
437
+ // Date | Only items created strictly before this timestamp (optional)
438
+ createdBefore: 2013-10-20T19:20:30+01:00,
439
+ // Date | Only items updated at or after this timestamp (inclusive) (optional)
440
+ updatedAfter: 2013-10-20T19:20:30+01:00,
441
+ // Date | Only items updated strictly before this timestamp (optional)
442
+ updatedBefore: 2013-10-20T19:20:30+01:00,
346
443
  } satisfies ListWorkflowDefinitionsRequest;
347
444
 
348
445
  try {
@@ -362,8 +459,16 @@ example().catch(console.error);
362
459
 
363
460
  | Name | Type | Description | Notes |
364
461
  |------------- | ------------- | ------------- | -------------|
462
+ | **mine** | `boolean` | Only definitions the caller created (owner). | [Optional] [Defaults to `false`] |
463
+ | **sortBy** | `WorkflowDefinitionOrder` | Field to sort definitions by (default: CREATED_AT) | [Optional] [Defaults to `undefined`] [Enum: CREATED_AT, UPDATED_AT] |
464
+ | **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
465
+ | **isTemplate** | `boolean` | | [Optional] [Defaults to `false`] |
365
466
  | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
366
467
  | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
468
+ | **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
469
+ | **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
470
+ | **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
471
+ | **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
367
472
 
368
473
  ### Return type
369
474
 
@@ -384,13 +489,14 @@ example().catch(console.error);
384
489
  |-------------|-------------|------------------|
385
490
  | **200** | Successful Response | - |
386
491
  | **422** | Validation Error | - |
492
+ | **0** | Error response. | - |
387
493
 
388
494
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
389
495
 
390
496
 
391
497
  ## listWorkflowRuns
392
498
 
393
- > PaginatedResponseWorkflowRunResponse listWorkflowRuns(definitionId, limit, offset)
499
+ > PaginatedResponseWorkflowRunResponse listWorkflowRuns(definitionId, sortBy, sortDir, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
394
500
 
395
501
  List Workflow Runs Handler
396
502
 
@@ -416,10 +522,22 @@ async function example() {
416
522
  const body = {
417
523
  // string
418
524
  definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
525
+ // WorkflowRunOrder | Field to sort runs by (default: STARTED_AT) (optional)
526
+ sortBy: ...,
527
+ // SortDirection | Sort direction; overrides the field\'s natural default (optional)
528
+ sortDir: ...,
419
529
  // number | Number of items per page (optional)
420
530
  limit: 56,
421
531
  // number | Number of items to skip (optional)
422
532
  offset: 56,
533
+ // Date | Only items created at or after this timestamp (inclusive) (optional)
534
+ createdAfter: 2013-10-20T19:20:30+01:00,
535
+ // Date | Only items created strictly before this timestamp (optional)
536
+ createdBefore: 2013-10-20T19:20:30+01:00,
537
+ // Date | Only items updated at or after this timestamp (inclusive) (optional)
538
+ updatedAfter: 2013-10-20T19:20:30+01:00,
539
+ // Date | Only items updated strictly before this timestamp (optional)
540
+ updatedBefore: 2013-10-20T19:20:30+01:00,
423
541
  } satisfies ListWorkflowRunsRequest;
424
542
 
425
543
  try {
@@ -440,8 +558,14 @@ example().catch(console.error);
440
558
  | Name | Type | Description | Notes |
441
559
  |------------- | ------------- | ------------- | -------------|
442
560
  | **definitionId** | `string` | | [Defaults to `undefined`] |
561
+ | **sortBy** | `WorkflowRunOrder` | Field to sort runs by (default: STARTED_AT) | [Optional] [Defaults to `undefined`] [Enum: STARTED_AT, CREATED_AT, COMPLETED_AT] |
562
+ | **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
443
563
  | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
444
564
  | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
565
+ | **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
566
+ | **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
567
+ | **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
568
+ | **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
445
569
 
446
570
  ### Return type
447
571
 
@@ -462,6 +586,7 @@ example().catch(console.error);
462
586
  |-------------|-------------|------------------|
463
587
  | **200** | Successful Response | - |
464
588
  | **422** | Validation Error | - |
589
+ | **0** | Error response. | - |
465
590
 
466
591
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
467
592
 
@@ -539,6 +664,7 @@ example().catch(console.error);
539
664
  |-------------|-------------|------------------|
540
665
  | **200** | Successful Response | - |
541
666
  | **422** | Validation Error | - |
667
+ | **0** | Error response. | - |
542
668
 
543
669
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
544
670
 
@@ -83,6 +83,7 @@ example().catch(console.error);
83
83
  |-------------|-------------|------------------|
84
84
  | **201** | Successful Response | - |
85
85
  | **422** | Validation Error | - |
86
+ | **0** | Error response. | - |
86
87
 
87
88
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
88
89
 
@@ -161,6 +162,7 @@ example().catch(console.error);
161
162
  |-------------|-------------|------------------|
162
163
  | **200** | Successful Response | - |
163
164
  | **422** | Validation Error | - |
165
+ | **0** | Error response. | - |
164
166
 
165
167
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
166
168
 
@@ -236,6 +238,7 @@ example().catch(console.error);
236
238
  |-------------|-------------|------------------|
237
239
  | **204** | Successful Response | - |
238
240
  | **422** | Validation Error | - |
241
+ | **0** | Error response. | - |
239
242
 
240
243
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
241
244
 
@@ -311,6 +314,7 @@ example().catch(console.error);
311
314
  |-------------|-------------|------------------|
312
315
  | **200** | Successful Response | - |
313
316
  | **422** | Validation Error | - |
317
+ | **0** | Error response. | - |
314
318
 
315
319
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
316
320
 
@@ -389,6 +393,7 @@ example().catch(console.error);
389
393
  |-------------|-------------|------------------|
390
394
  | **200** | Successful Response | - |
391
395
  | **422** | Validation Error | - |
396
+ | **0** | Error response. | - |
392
397
 
393
398
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
394
399
 
@@ -0,0 +1,33 @@
1
+
2
+ # WorkflowRunOrder
3
+
4
+ Sortable fields for run listings (all default newest-first).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { WorkflowRunOrder } from '@knowledge-stack/ksapi'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ } satisfies WorkflowRunOrder
19
+
20
+ console.log(example)
21
+
22
+ // Convert the instance to a JSON string
23
+ const exampleJSON: string = JSON.stringify(example)
24
+ console.log(exampleJSON)
25
+
26
+ // Parse the JSON string back to an object
27
+ const exampleParsed = JSON.parse(exampleJSON) as WorkflowRunOrder
28
+ console.log(exampleParsed)
29
+ ```
30
+
31
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
32
+
33
+
@@ -28,6 +28,7 @@ Name | Type
28
28
  `inputPathPartIds` | Array<string>
29
29
  `outputsPathPartIds` | Array<string>
30
30
  `runThreadId` | string
31
+ `owner` | [UserInfo](UserInfo.md)
31
32
  `createdAt` | Date
32
33
  `updatedAt` | Date
33
34
  `permissions` | [ItemPermissions](ItemPermissions.md)
@@ -60,6 +61,7 @@ const example = {
60
61
  "inputPathPartIds": null,
61
62
  "outputsPathPartIds": null,
62
63
  "runThreadId": null,
64
+ "owner": null,
63
65
  "createdAt": null,
64
66
  "updatedAt": null,
65
67
  "permissions": null,
@@ -0,0 +1,53 @@
1
+
2
+ # WorkflowRunSummaryResponse
3
+
4
+ Aggregate workflow-runs health over a window, permission-scoped. Read-gated like the run list: the numbers cover only runs under workflows the caller can read (OWNER/ADMIN ⇒ tenant-wide). All windowed metrics filter runs by ``created_at`` in ``[window_start, window_end]``; the approval backlog and ``active_definitions`` are point-in-time (not windowed). ``failure_rate`` and the duration percentiles are ``None`` when their denominator set is empty.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `windowStart` | Date
11
+ `windowEnd` | Date
12
+ `total` | number
13
+ `countsByState` | { [key: string]: number; }
14
+ `failureRate` | number
15
+ `durationP50Seconds` | number
16
+ `durationP95Seconds` | number
17
+ `pendingApprovalCount` | number
18
+ `oldestPendingAgeSeconds` | number
19
+ `adoption` | [WorkflowAdoptionStats](WorkflowAdoptionStats.md)
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import type { WorkflowRunSummaryResponse } from '@knowledge-stack/ksapi'
25
+
26
+ // TODO: Update the object below with actual values
27
+ const example = {
28
+ "windowStart": null,
29
+ "windowEnd": null,
30
+ "total": null,
31
+ "countsByState": null,
32
+ "failureRate": null,
33
+ "durationP50Seconds": null,
34
+ "durationP95Seconds": null,
35
+ "pendingApprovalCount": null,
36
+ "oldestPendingAgeSeconds": null,
37
+ "adoption": null,
38
+ } satisfies WorkflowRunSummaryResponse
39
+
40
+ console.log(example)
41
+
42
+ // Convert the instance to a JSON string
43
+ const exampleJSON: string = JSON.stringify(example)
44
+ console.log(exampleJSON)
45
+
46
+ // Parse the JSON string back to an object
47
+ const exampleParsed = JSON.parse(exampleJSON) as WorkflowRunSummaryResponse
48
+ console.log(exampleParsed)
49
+ ```
50
+
51
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
52
+
53
+
@@ -7,6 +7,8 @@ All URIs are relative to *http://localhost:8000*
7
7
  | [**cloneWorkflowRun**](WorkflowRunsApi.md#cloneworkflowrunoperation) | **POST** /v1/workflow-runs/{run_id}/clone | Clone Workflow Run Handler |
8
8
  | [**deleteWorkflowRun**](WorkflowRunsApi.md#deleteworkflowrun) | **DELETE** /v1/workflow-runs/{run_id} | Delete Workflow Run Handler |
9
9
  | [**getWorkflowRun**](WorkflowRunsApi.md#getworkflowrun) | **GET** /v1/workflow-runs/{run_id} | Get Workflow Run Handler |
10
+ | [**getWorkflowRunsSummary**](WorkflowRunsApi.md#getworkflowrunssummary) | **GET** /v1/workflow-runs/summary | Get Workflow Runs Summary Handler |
11
+ | [**listWorkflowRunsForTenant**](WorkflowRunsApi.md#listworkflowrunsfortenant) | **GET** /v1/workflow-runs | List Workflow Runs For Tenant Handler |
10
12
  | [**retryWorkflowRun**](WorkflowRunsApi.md#retryworkflowrun) | **POST** /v1/workflow-runs/{run_id}/retry | Retry Workflow Run Handler |
11
13
  | [**setWorkflowRunApproval**](WorkflowRunsApi.md#setworkflowrunapprovaloperation) | **POST** /v1/workflow-runs/{run_id}/approval | Set Workflow Run Approval Handler |
12
14
  | [**startWorkflowRun**](WorkflowRunsApi.md#startworkflowrun) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler |
@@ -89,6 +91,7 @@ example().catch(console.error);
89
91
  |-------------|-------------|------------------|
90
92
  | **201** | Successful Response | - |
91
93
  | **422** | Validation Error | - |
94
+ | **0** | Error response. | - |
92
95
 
93
96
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
94
97
 
@@ -161,6 +164,7 @@ example().catch(console.error);
161
164
  |-------------|-------------|------------------|
162
165
  | **204** | Successful Response | - |
163
166
  | **422** | Validation Error | - |
167
+ | **0** | Error response. | - |
164
168
 
165
169
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
166
170
 
@@ -233,6 +237,199 @@ example().catch(console.error);
233
237
  |-------------|-------------|------------------|
234
238
  | **200** | Successful Response | - |
235
239
  | **422** | Validation Error | - |
240
+ | **0** | Error response. | - |
241
+
242
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
243
+
244
+
245
+ ## getWorkflowRunsSummary
246
+
247
+ > WorkflowRunSummaryResponse getWorkflowRunsSummary(since, until, definitionId)
248
+
249
+ Get Workflow Runs Summary Handler
250
+
251
+ Aggregate workflow-runs health, read-gated and permission-scoped. Numbers cover only runs under workflows the caller can read (OWNER/ADMIN ⇒ tenant-wide). Windowed metrics default to the last 7 days; the approval backlog and active-definition count are point-in-time.
252
+
253
+ ### Example
254
+
255
+ ```ts
256
+ import {
257
+ Configuration,
258
+ WorkflowRunsApi,
259
+ } from '@knowledge-stack/ksapi';
260
+ import type { GetWorkflowRunsSummaryRequest } from '@knowledge-stack/ksapi';
261
+
262
+ async function example() {
263
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
264
+ const config = new Configuration({
265
+ // To configure API key authorization: cookieAuth
266
+ apiKey: "YOUR API KEY",
267
+ // Configure HTTP bearer authorization: bearerAuth
268
+ accessToken: "YOUR BEARER TOKEN",
269
+ });
270
+ const api = new WorkflowRunsApi(config);
271
+
272
+ const body = {
273
+ // Date | Window start (inclusive). Defaults to 7 days ago. (optional)
274
+ since: 2013-10-20T19:20:30+01:00,
275
+ // Date | Window end (inclusive). Defaults to open-ended. (optional)
276
+ until: 2013-10-20T19:20:30+01:00,
277
+ // string | Scope all numbers to one workflow (requires read). (optional)
278
+ definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
279
+ } satisfies GetWorkflowRunsSummaryRequest;
280
+
281
+ try {
282
+ const data = await api.getWorkflowRunsSummary(body);
283
+ console.log(data);
284
+ } catch (error) {
285
+ console.error(error);
286
+ }
287
+ }
288
+
289
+ // Run the test
290
+ example().catch(console.error);
291
+ ```
292
+
293
+ ### Parameters
294
+
295
+
296
+ | Name | Type | Description | Notes |
297
+ |------------- | ------------- | ------------- | -------------|
298
+ | **since** | `Date` | Window start (inclusive). Defaults to 7 days ago. | [Optional] [Defaults to `undefined`] |
299
+ | **until** | `Date` | Window end (inclusive). Defaults to open-ended. | [Optional] [Defaults to `undefined`] |
300
+ | **definitionId** | `string` | Scope all numbers to one workflow (requires read). | [Optional] [Defaults to `undefined`] |
301
+
302
+ ### Return type
303
+
304
+ [**WorkflowRunSummaryResponse**](WorkflowRunSummaryResponse.md)
305
+
306
+ ### Authorization
307
+
308
+ [cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
309
+
310
+ ### HTTP request headers
311
+
312
+ - **Content-Type**: Not defined
313
+ - **Accept**: `application/json`
314
+
315
+
316
+ ### HTTP response details
317
+ | Status code | Description | Response headers |
318
+ |-------------|-------------|------------------|
319
+ | **200** | Successful Response | - |
320
+ | **422** | Validation Error | - |
321
+ | **0** | Error response. | - |
322
+
323
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
324
+
325
+
326
+ ## listWorkflowRunsForTenant
327
+
328
+ > PaginatedResponseWorkflowRunResponse listWorkflowRunsForTenant(state, mine, pendingApprovalForMe, definitionId, ownerId, sortBy, sortDir, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
329
+
330
+ List Workflow Runs For Tenant Handler
331
+
332
+ List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``pending_approval_for_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
333
+
334
+ ### Example
335
+
336
+ ```ts
337
+ import {
338
+ Configuration,
339
+ WorkflowRunsApi,
340
+ } from '@knowledge-stack/ksapi';
341
+ import type { ListWorkflowRunsForTenantRequest } from '@knowledge-stack/ksapi';
342
+
343
+ async function example() {
344
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
345
+ const config = new Configuration({
346
+ // To configure API key authorization: cookieAuth
347
+ apiKey: "YOUR API KEY",
348
+ // Configure HTTP bearer authorization: bearerAuth
349
+ accessToken: "YOUR BEARER TOKEN",
350
+ });
351
+ const api = new WorkflowRunsApi(config);
352
+
353
+ const body = {
354
+ // Array<WorkflowExecutionState> | Keep only runs in these execution states (repeatable). (optional)
355
+ state: ...,
356
+ // boolean | Only runs the caller created (owner). Overrides owner_id. (optional)
357
+ mine: true,
358
+ // boolean | Only runs pending approval that the caller may approve. (optional)
359
+ pendingApprovalForMe: true,
360
+ // string | Only runs under this workflow definition. (optional)
361
+ definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
362
+ // string | Only runs created by this user. (optional)
363
+ ownerId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
364
+ // WorkflowRunOrder | Field to sort runs by (default: STARTED_AT) (optional)
365
+ sortBy: ...,
366
+ // SortDirection | Sort direction; overrides the field\'s natural default (optional)
367
+ sortDir: ...,
368
+ // number | Number of items per page (optional)
369
+ limit: 56,
370
+ // number | Number of items to skip (optional)
371
+ offset: 56,
372
+ // Date | Only items created at or after this timestamp (inclusive) (optional)
373
+ createdAfter: 2013-10-20T19:20:30+01:00,
374
+ // Date | Only items created strictly before this timestamp (optional)
375
+ createdBefore: 2013-10-20T19:20:30+01:00,
376
+ // Date | Only items updated at or after this timestamp (inclusive) (optional)
377
+ updatedAfter: 2013-10-20T19:20:30+01:00,
378
+ // Date | Only items updated strictly before this timestamp (optional)
379
+ updatedBefore: 2013-10-20T19:20:30+01:00,
380
+ } satisfies ListWorkflowRunsForTenantRequest;
381
+
382
+ try {
383
+ const data = await api.listWorkflowRunsForTenant(body);
384
+ console.log(data);
385
+ } catch (error) {
386
+ console.error(error);
387
+ }
388
+ }
389
+
390
+ // Run the test
391
+ example().catch(console.error);
392
+ ```
393
+
394
+ ### Parameters
395
+
396
+
397
+ | Name | Type | Description | Notes |
398
+ |------------- | ------------- | ------------- | -------------|
399
+ | **state** | `Array<WorkflowExecutionState>` | Keep only runs in these execution states (repeatable). | [Optional] |
400
+ | **mine** | `boolean` | Only runs the caller created (owner). Overrides owner_id. | [Optional] [Defaults to `false`] |
401
+ | **pendingApprovalForMe** | `boolean` | Only runs pending approval that the caller may approve. | [Optional] [Defaults to `false`] |
402
+ | **definitionId** | `string` | Only runs under this workflow definition. | [Optional] [Defaults to `undefined`] |
403
+ | **ownerId** | `string` | Only runs created by this user. | [Optional] [Defaults to `undefined`] |
404
+ | **sortBy** | `WorkflowRunOrder` | Field to sort runs by (default: STARTED_AT) | [Optional] [Defaults to `undefined`] [Enum: STARTED_AT, CREATED_AT, COMPLETED_AT] |
405
+ | **sortDir** | `SortDirection` | Sort direction; overrides the field\&#39;s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
406
+ | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
407
+ | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
408
+ | **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
409
+ | **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
410
+ | **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
411
+ | **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
412
+
413
+ ### Return type
414
+
415
+ [**PaginatedResponseWorkflowRunResponse**](PaginatedResponseWorkflowRunResponse.md)
416
+
417
+ ### Authorization
418
+
419
+ [cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
420
+
421
+ ### HTTP request headers
422
+
423
+ - **Content-Type**: Not defined
424
+ - **Accept**: `application/json`
425
+
426
+
427
+ ### HTTP response details
428
+ | Status code | Description | Response headers |
429
+ |-------------|-------------|------------------|
430
+ | **200** | Successful Response | - |
431
+ | **422** | Validation Error | - |
432
+ | **0** | Error response. | - |
236
433
 
237
434
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
238
435
 
@@ -307,6 +504,7 @@ example().catch(console.error);
307
504
  |-------------|-------------|------------------|
308
505
  | **202** | Successful Response | - |
309
506
  | **422** | Validation Error | - |
507
+ | **0** | Error response. | - |
310
508
 
311
509
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
312
510
 
@@ -384,6 +582,7 @@ example().catch(console.error);
384
582
  |-------------|-------------|------------------|
385
583
  | **200** | Successful Response | - |
386
584
  | **422** | Validation Error | - |
585
+ | **0** | Error response. | - |
387
586
 
388
587
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
389
588
 
@@ -458,6 +657,7 @@ example().catch(console.error);
458
657
  |-------------|-------------|------------------|
459
658
  | **202** | Successful Response | - |
460
659
  | **422** | Validation Error | - |
660
+ | **0** | Error response. | - |
461
661
 
462
662
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
463
663
 
@@ -532,6 +732,7 @@ example().catch(console.error);
532
732
  |-------------|-------------|------------------|
533
733
  | **200** | Successful Response | - |
534
734
  | **422** | Validation Error | - |
735
+ | **0** | Error response. | - |
535
736
 
536
737
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
537
738
 
@@ -609,6 +810,7 @@ example().catch(console.error);
609
810
  |-------------|-------------|------------------|
610
811
  | **200** | Successful Response | - |
611
812
  | **422** | Validation Error | - |
813
+ | **0** | Error response. | - |
612
814
 
613
815
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
614
816
 
@@ -686,6 +888,7 @@ example().catch(console.error);
686
888
  |-------------|-------------|------------------|
687
889
  | **200** | Successful Response | - |
688
890
  | **422** | Validation Error | - |
891
+ | **0** | Error response. | - |
689
892
 
690
893
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
691
894