@knowledge-stack/ksapi 1.15.0 → 1.17.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 (123) hide show
  1. package/.openapi-generator/FILES +11 -0
  2. package/README.md +2 -2
  3. package/dist/apis/DocumentVersionsApi.d.ts +32 -1
  4. package/dist/apis/DocumentVersionsApi.js +37 -0
  5. package/dist/apis/DocumentsApi.d.ts +44 -11
  6. package/dist/apis/DocumentsApi.js +65 -6
  7. package/dist/apis/FoldersApi.d.ts +10 -10
  8. package/dist/apis/FoldersApi.js +6 -6
  9. package/dist/apis/TenantsApi.d.ts +4 -4
  10. package/dist/apis/TenantsApi.js +2 -2
  11. package/dist/apis/WorkflowsApi.d.ts +117 -0
  12. package/dist/apis/WorkflowsApi.js +137 -0
  13. package/dist/apis/index.d.ts +1 -0
  14. package/dist/apis/index.js +1 -0
  15. package/dist/esm/apis/DocumentVersionsApi.d.ts +32 -1
  16. package/dist/esm/apis/DocumentVersionsApi.js +38 -1
  17. package/dist/esm/apis/DocumentsApi.d.ts +44 -11
  18. package/dist/esm/apis/DocumentsApi.js +66 -7
  19. package/dist/esm/apis/FoldersApi.d.ts +10 -10
  20. package/dist/esm/apis/FoldersApi.js +6 -6
  21. package/dist/esm/apis/TenantsApi.d.ts +4 -4
  22. package/dist/esm/apis/TenantsApi.js +2 -2
  23. package/dist/esm/apis/WorkflowsApi.d.ts +117 -0
  24. package/dist/esm/apis/WorkflowsApi.js +133 -0
  25. package/dist/esm/apis/index.d.ts +1 -0
  26. package/dist/esm/apis/index.js +1 -0
  27. package/dist/esm/models/CreateDocumentRequest.d.ts +2 -2
  28. package/dist/esm/models/CreateDocumentRequest.js +3 -3
  29. package/dist/esm/models/CreateFolderRequest.d.ts +2 -2
  30. package/dist/esm/models/CreateFolderRequest.js +3 -3
  31. package/dist/esm/models/DocumentResponse.d.ts +2 -2
  32. package/dist/esm/models/DocumentResponse.js +3 -3
  33. package/dist/esm/models/DocumentVersionMetadata.d.ts +89 -0
  34. package/dist/esm/models/DocumentVersionMetadata.js +55 -0
  35. package/dist/esm/models/DocumentVersionMetadataUpdate.d.ts +87 -0
  36. package/dist/esm/models/DocumentVersionMetadataUpdate.js +55 -0
  37. package/dist/esm/models/DocumentVersionResponse.d.ts +13 -0
  38. package/dist/esm/models/DocumentVersionResponse.js +5 -0
  39. package/dist/esm/models/FolderResponse.d.ts +2 -2
  40. package/dist/esm/models/FolderResponse.js +3 -3
  41. package/dist/esm/models/IngestDocumentResponse.d.ts +59 -0
  42. package/dist/esm/models/IngestDocumentResponse.js +52 -0
  43. package/dist/esm/models/PaginatedResponseWorkflowSummaryResponse.d.ts +66 -0
  44. package/dist/esm/models/PaginatedResponseWorkflowSummaryResponse.js +70 -0
  45. package/dist/esm/models/PipelineState.d.ts +78 -0
  46. package/dist/esm/models/PipelineState.js +57 -0
  47. package/dist/esm/models/PipelineStatus.d.ts +28 -0
  48. package/dist/esm/models/PipelineStatus.js +46 -0
  49. package/dist/esm/models/UpdateDocumentRequest.d.ts +2 -2
  50. package/dist/esm/models/UpdateDocumentRequest.js +2 -2
  51. package/dist/esm/models/UpdateFolderRequest.d.ts +2 -2
  52. package/dist/esm/models/UpdateFolderRequest.js +2 -2
  53. package/dist/esm/models/WorkflowAction.d.ts +25 -0
  54. package/dist/esm/models/WorkflowAction.js +43 -0
  55. package/dist/esm/models/WorkflowActionResponse.d.ts +59 -0
  56. package/dist/esm/models/WorkflowActionResponse.js +52 -0
  57. package/dist/esm/models/WorkflowDetailResponse.d.ts +132 -0
  58. package/dist/esm/models/WorkflowDetailResponse.js +93 -0
  59. package/dist/esm/models/WorkflowSummaryResponse.d.ts +90 -0
  60. package/dist/esm/models/WorkflowSummaryResponse.js +69 -0
  61. package/dist/esm/models/index.d.ts +10 -0
  62. package/dist/esm/models/index.js +10 -0
  63. package/dist/models/CreateDocumentRequest.d.ts +2 -2
  64. package/dist/models/CreateDocumentRequest.js +3 -3
  65. package/dist/models/CreateFolderRequest.d.ts +2 -2
  66. package/dist/models/CreateFolderRequest.js +3 -3
  67. package/dist/models/DocumentResponse.d.ts +2 -2
  68. package/dist/models/DocumentResponse.js +3 -3
  69. package/dist/models/DocumentVersionMetadata.d.ts +89 -0
  70. package/dist/models/DocumentVersionMetadata.js +63 -0
  71. package/dist/models/DocumentVersionMetadataUpdate.d.ts +87 -0
  72. package/dist/models/DocumentVersionMetadataUpdate.js +63 -0
  73. package/dist/models/DocumentVersionResponse.d.ts +13 -0
  74. package/dist/models/DocumentVersionResponse.js +5 -0
  75. package/dist/models/FolderResponse.d.ts +2 -2
  76. package/dist/models/FolderResponse.js +3 -3
  77. package/dist/models/IngestDocumentResponse.d.ts +59 -0
  78. package/dist/models/IngestDocumentResponse.js +60 -0
  79. package/dist/models/PaginatedResponseWorkflowSummaryResponse.d.ts +66 -0
  80. package/dist/models/PaginatedResponseWorkflowSummaryResponse.js +78 -0
  81. package/dist/models/PipelineState.d.ts +78 -0
  82. package/dist/models/PipelineState.js +65 -0
  83. package/dist/models/PipelineStatus.d.ts +28 -0
  84. package/dist/models/PipelineStatus.js +54 -0
  85. package/dist/models/UpdateDocumentRequest.d.ts +2 -2
  86. package/dist/models/UpdateDocumentRequest.js +2 -2
  87. package/dist/models/UpdateFolderRequest.d.ts +2 -2
  88. package/dist/models/UpdateFolderRequest.js +2 -2
  89. package/dist/models/WorkflowAction.d.ts +25 -0
  90. package/dist/models/WorkflowAction.js +51 -0
  91. package/dist/models/WorkflowActionResponse.d.ts +59 -0
  92. package/dist/models/WorkflowActionResponse.js +60 -0
  93. package/dist/models/WorkflowDetailResponse.d.ts +132 -0
  94. package/dist/models/WorkflowDetailResponse.js +101 -0
  95. package/dist/models/WorkflowSummaryResponse.d.ts +90 -0
  96. package/dist/models/WorkflowSummaryResponse.js +77 -0
  97. package/dist/models/index.d.ts +10 -0
  98. package/dist/models/index.js +10 -0
  99. package/package.json +1 -1
  100. package/src/apis/DocumentVersionsApi.ts +76 -0
  101. package/src/apis/DocumentsApi.ts +115 -12
  102. package/src/apis/FoldersApi.ts +12 -12
  103. package/src/apis/TenantsApi.ts +4 -4
  104. package/src/apis/WorkflowsApi.ts +249 -0
  105. package/src/apis/index.ts +1 -0
  106. package/src/models/CreateDocumentRequest.ts +5 -5
  107. package/src/models/CreateFolderRequest.ts +5 -5
  108. package/src/models/DocumentResponse.ts +5 -5
  109. package/src/models/DocumentVersionMetadata.ts +143 -0
  110. package/src/models/DocumentVersionMetadataUpdate.ts +141 -0
  111. package/src/models/DocumentVersionResponse.ts +24 -0
  112. package/src/models/FolderResponse.ts +5 -5
  113. package/src/models/IngestDocumentResponse.ts +101 -0
  114. package/src/models/PaginatedResponseWorkflowSummaryResponse.ts +130 -0
  115. package/src/models/PipelineState.ts +134 -0
  116. package/src/models/PipelineStatus.ts +56 -0
  117. package/src/models/UpdateDocumentRequest.ts +4 -4
  118. package/src/models/UpdateFolderRequest.ts +4 -4
  119. package/src/models/WorkflowAction.ts +53 -0
  120. package/src/models/WorkflowActionResponse.ts +101 -0
  121. package/src/models/WorkflowDetailResponse.ts +215 -0
  122. package/src/models/WorkflowSummaryResponse.ts +154 -0
  123. package/src/models/index.ts +10 -0
@@ -32,7 +32,7 @@ export interface ListFolderContentsRequest {
32
32
  ksUat?: string;
33
33
  }
34
34
  export interface ListFoldersRequest {
35
- parentId?: string;
35
+ parentFolderId?: string;
36
36
  sortOrder?: PathOrder;
37
37
  limit?: number;
38
38
  offset?: number;
@@ -115,9 +115,9 @@ export interface FoldersApiInterface {
115
115
  */
116
116
  listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
117
117
  /**
118
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
118
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
119
119
  * @summary List Folders Handler
120
- * @param {string} [parentId] Parent folder PathPart ID (defaults to root)
120
+ * @param {string} [parentFolderId] Parent folder ID (defaults to root)
121
121
  * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
122
122
  * @param {number} [limit] Number of items per page
123
123
  * @param {number} [offset] Number of items to skip
@@ -128,12 +128,12 @@ export interface FoldersApiInterface {
128
128
  */
129
129
  listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>>;
130
130
  /**
131
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
131
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
132
132
  * List Folders Handler
133
133
  */
134
134
  listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
135
135
  /**
136
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
136
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
137
137
  * @summary Update Folder Handler
138
138
  * @param {string} folderId
139
139
  * @param {UpdateFolderRequest} updateFolderRequest
@@ -144,7 +144,7 @@ export interface FoldersApiInterface {
144
144
  */
145
145
  updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>>;
146
146
  /**
147
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
147
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
148
148
  * Update Folder Handler
149
149
  */
150
150
  updateFolder(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
@@ -194,22 +194,22 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
194
194
  */
195
195
  listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
196
196
  /**
197
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
197
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
198
198
  * List Folders Handler
199
199
  */
200
200
  listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>>;
201
201
  /**
202
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
202
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
203
203
  * List Folders Handler
204
204
  */
205
205
  listFolders(requestParameters?: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
206
206
  /**
207
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
207
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
208
208
  * Update Folder Handler
209
209
  */
210
210
  updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FolderResponse>>;
211
211
  /**
212
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
212
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
213
213
  * Update Folder Handler
214
214
  */
215
215
  updateFolder(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
@@ -167,14 +167,14 @@ export class FoldersApi extends runtime.BaseAPI {
167
167
  });
168
168
  }
169
169
  /**
170
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
170
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
171
171
  * List Folders Handler
172
172
  */
173
173
  listFoldersRaw(requestParameters, initOverrides) {
174
174
  return __awaiter(this, void 0, void 0, function* () {
175
175
  const queryParameters = {};
176
- if (requestParameters['parentId'] != null) {
177
- queryParameters['parent_id'] = requestParameters['parentId'];
176
+ if (requestParameters['parentFolderId'] != null) {
177
+ queryParameters['parent_folder_id'] = requestParameters['parentFolderId'];
178
178
  }
179
179
  if (requestParameters['sortOrder'] != null) {
180
180
  queryParameters['sort_order'] = requestParameters['sortOrder'];
@@ -197,7 +197,7 @@ export class FoldersApi extends runtime.BaseAPI {
197
197
  });
198
198
  }
199
199
  /**
200
- * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_id is not provided, lists folders in the root folder.
200
+ * List child folders of a parent folder. Returns only direct child folders (depth=1) of the specified parent. If parent_folder_id is not provided, lists folders in the root folder.
201
201
  * List Folders Handler
202
202
  */
203
203
  listFolders() {
@@ -207,7 +207,7 @@ export class FoldersApi extends runtime.BaseAPI {
207
207
  });
208
208
  }
209
209
  /**
210
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
210
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
211
211
  * Update Folder Handler
212
212
  */
213
213
  updateFolderRaw(requestParameters, initOverrides) {
@@ -234,7 +234,7 @@ export class FoldersApi extends runtime.BaseAPI {
234
234
  });
235
235
  }
236
236
  /**
237
- * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_id` field. Both can be done in a single request.
237
+ * Update a folder (rename and/or move). To rename: provide `name` field. To move: provide `parent_folder_id` field. Both can be done in a single request.
238
238
  * Update Folder Handler
239
239
  */
240
240
  updateFolder(requestParameters, initOverrides) {
@@ -62,7 +62,7 @@ export interface TenantsApiInterface {
62
62
  */
63
63
  createTenant(requestParameters: CreateTenantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantResponse>;
64
64
  /**
65
- * Delete a tenant. Requires OWNER role in the tenant.
65
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
66
66
  * @summary Delete Tenant
67
67
  * @param {string} tenantId
68
68
  * @param {string} [ksUat]
@@ -72,7 +72,7 @@ export interface TenantsApiInterface {
72
72
  */
73
73
  deleteTenantRaw(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
74
74
  /**
75
- * Delete a tenant. Requires OWNER role in the tenant.
75
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
76
76
  * Delete Tenant
77
77
  */
78
78
  deleteTenant(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -156,12 +156,12 @@ export declare class TenantsApi extends runtime.BaseAPI implements TenantsApiInt
156
156
  */
157
157
  createTenant(requestParameters: CreateTenantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantResponse>;
158
158
  /**
159
- * Delete a tenant. Requires OWNER role in the tenant.
159
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
160
160
  * Delete Tenant
161
161
  */
162
162
  deleteTenantRaw(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
163
163
  /**
164
- * Delete a tenant. Requires OWNER role in the tenant.
164
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
165
165
  * Delete Tenant
166
166
  */
167
167
  deleteTenant(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -60,7 +60,7 @@ export class TenantsApi extends runtime.BaseAPI {
60
60
  });
61
61
  }
62
62
  /**
63
- * Delete a tenant. Requires OWNER role in the tenant.
63
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
64
64
  * Delete Tenant
65
65
  */
66
66
  deleteTenantRaw(requestParameters, initOverrides) {
@@ -82,7 +82,7 @@ export class TenantsApi extends runtime.BaseAPI {
82
82
  });
83
83
  }
84
84
  /**
85
- * Delete a tenant. Requires OWNER role in the tenant.
85
+ * Delete a tenant. Requires OWNER role in the tenant. Deletes the tenant\'s S3 bucket after the DB transaction commits.
86
86
  * Delete Tenant
87
87
  */
88
88
  deleteTenant(requestParameters, initOverrides) {
@@ -0,0 +1,117 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { PaginatedResponseWorkflowSummaryResponse, WorkflowAction, WorkflowActionResponse, WorkflowDetailResponse } from '../models/index';
14
+ export interface GetWorkflowRequest {
15
+ workflowId: string;
16
+ ksUat?: string;
17
+ }
18
+ export interface ListWorkflowsRequest {
19
+ limit?: number;
20
+ offset?: number;
21
+ ksUat?: string;
22
+ }
23
+ export interface WorkflowActionRequest {
24
+ workflowId: string;
25
+ action: WorkflowAction;
26
+ ksUat?: string;
27
+ }
28
+ /**
29
+ * WorkflowsApi - interface
30
+ *
31
+ * @export
32
+ * @interface WorkflowsApiInterface
33
+ */
34
+ export interface WorkflowsApiInterface {
35
+ /**
36
+ * Get single workflow detail with live Temporal status.
37
+ * @summary Get Workflow Handler
38
+ * @param {string} workflowId
39
+ * @param {string} [ksUat]
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ * @memberof WorkflowsApiInterface
43
+ */
44
+ getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
45
+ /**
46
+ * Get single workflow detail with live Temporal status.
47
+ * Get Workflow Handler
48
+ */
49
+ getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
50
+ /**
51
+ * List all workflows for the current tenant (paginated, DB-backed).
52
+ * @summary List Workflows Handler
53
+ * @param {number} [limit] Number of items per page
54
+ * @param {number} [offset] Number of items to skip
55
+ * @param {string} [ksUat]
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ * @memberof WorkflowsApiInterface
59
+ */
60
+ listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
61
+ /**
62
+ * List all workflows for the current tenant (paginated, DB-backed).
63
+ * List Workflows Handler
64
+ */
65
+ listWorkflows(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
66
+ /**
67
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
68
+ * @summary Workflow Action Handler
69
+ * @param {string} workflowId
70
+ * @param {WorkflowAction} action Action to perform
71
+ * @param {string} [ksUat]
72
+ * @param {*} [options] Override http request option.
73
+ * @throws {RequiredError}
74
+ * @memberof WorkflowsApiInterface
75
+ */
76
+ workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
77
+ /**
78
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
79
+ * Workflow Action Handler
80
+ */
81
+ workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
82
+ }
83
+ /**
84
+ *
85
+ */
86
+ export declare class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterface {
87
+ /**
88
+ * Get single workflow detail with live Temporal status.
89
+ * Get Workflow Handler
90
+ */
91
+ getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>>;
92
+ /**
93
+ * Get single workflow detail with live Temporal status.
94
+ * Get Workflow Handler
95
+ */
96
+ getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
97
+ /**
98
+ * List all workflows for the current tenant (paginated, DB-backed).
99
+ * List Workflows Handler
100
+ */
101
+ listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
102
+ /**
103
+ * List all workflows for the current tenant (paginated, DB-backed).
104
+ * List Workflows Handler
105
+ */
106
+ listWorkflows(requestParameters?: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
107
+ /**
108
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
109
+ * Workflow Action Handler
110
+ */
111
+ workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
112
+ /**
113
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
114
+ * Workflow Action Handler
115
+ */
116
+ workflowAction(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
117
+ }
@@ -0,0 +1,133 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
6
+ *
7
+ * The version of the OpenAPI document: 0.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import * as runtime from '../runtime';
24
+ import { PaginatedResponseWorkflowSummaryResponseFromJSON, WorkflowActionResponseFromJSON, WorkflowDetailResponseFromJSON, } from '../models/index';
25
+ /**
26
+ *
27
+ */
28
+ export class WorkflowsApi extends runtime.BaseAPI {
29
+ /**
30
+ * Get single workflow detail with live Temporal status.
31
+ * Get Workflow Handler
32
+ */
33
+ getWorkflowRaw(requestParameters, initOverrides) {
34
+ return __awaiter(this, void 0, void 0, function* () {
35
+ if (requestParameters['workflowId'] == null) {
36
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getWorkflow().');
37
+ }
38
+ const queryParameters = {};
39
+ const headerParameters = {};
40
+ let urlPath = `/v1/workflows/{workflow_id}`;
41
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
42
+ const response = yield this.request({
43
+ path: urlPath,
44
+ method: 'GET',
45
+ headers: headerParameters,
46
+ query: queryParameters,
47
+ }, initOverrides);
48
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDetailResponseFromJSON(jsonValue));
49
+ });
50
+ }
51
+ /**
52
+ * Get single workflow detail with live Temporal status.
53
+ * Get Workflow Handler
54
+ */
55
+ getWorkflow(requestParameters, initOverrides) {
56
+ return __awaiter(this, void 0, void 0, function* () {
57
+ const response = yield this.getWorkflowRaw(requestParameters, initOverrides);
58
+ return yield response.value();
59
+ });
60
+ }
61
+ /**
62
+ * List all workflows for the current tenant (paginated, DB-backed).
63
+ * List Workflows Handler
64
+ */
65
+ listWorkflowsRaw(requestParameters, initOverrides) {
66
+ return __awaiter(this, void 0, void 0, function* () {
67
+ const queryParameters = {};
68
+ if (requestParameters['limit'] != null) {
69
+ queryParameters['limit'] = requestParameters['limit'];
70
+ }
71
+ if (requestParameters['offset'] != null) {
72
+ queryParameters['offset'] = requestParameters['offset'];
73
+ }
74
+ const headerParameters = {};
75
+ let urlPath = `/v1/workflows`;
76
+ const response = yield this.request({
77
+ path: urlPath,
78
+ method: 'GET',
79
+ headers: headerParameters,
80
+ query: queryParameters,
81
+ }, initOverrides);
82
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseWorkflowSummaryResponseFromJSON(jsonValue));
83
+ });
84
+ }
85
+ /**
86
+ * List all workflows for the current tenant (paginated, DB-backed).
87
+ * List Workflows Handler
88
+ */
89
+ listWorkflows() {
90
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
91
+ const response = yield this.listWorkflowsRaw(requestParameters, initOverrides);
92
+ return yield response.value();
93
+ });
94
+ }
95
+ /**
96
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
97
+ * Workflow Action Handler
98
+ */
99
+ workflowActionRaw(requestParameters, initOverrides) {
100
+ return __awaiter(this, void 0, void 0, function* () {
101
+ if (requestParameters['workflowId'] == null) {
102
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling workflowAction().');
103
+ }
104
+ if (requestParameters['action'] == null) {
105
+ throw new runtime.RequiredError('action', 'Required parameter "action" was null or undefined when calling workflowAction().');
106
+ }
107
+ const queryParameters = {};
108
+ if (requestParameters['action'] != null) {
109
+ queryParameters['action'] = requestParameters['action'];
110
+ }
111
+ const headerParameters = {};
112
+ let urlPath = `/v1/workflows/{workflow_id}`;
113
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
114
+ const response = yield this.request({
115
+ path: urlPath,
116
+ method: 'POST',
117
+ headers: headerParameters,
118
+ query: queryParameters,
119
+ }, initOverrides);
120
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowActionResponseFromJSON(jsonValue));
121
+ });
122
+ }
123
+ /**
124
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
125
+ * Workflow Action Handler
126
+ */
127
+ workflowAction(requestParameters, initOverrides) {
128
+ return __awaiter(this, void 0, void 0, function* () {
129
+ const response = yield this.workflowActionRaw(requestParameters, initOverrides);
130
+ return yield response.value();
131
+ });
132
+ }
133
+ }
@@ -14,3 +14,4 @@ export * from './ThreadMessagesApi';
14
14
  export * from './ThreadsApi';
15
15
  export * from './UserPermissionsApi';
16
16
  export * from './UsersApi';
17
+ export * from './WorkflowsApi';
@@ -16,3 +16,4 @@ export * from './ThreadMessagesApi';
16
16
  export * from './ThreadsApi';
17
17
  export * from './UserPermissionsApi';
18
18
  export * from './UsersApi';
19
+ export * from './WorkflowsApi';
@@ -24,11 +24,11 @@ export interface CreateDocumentRequest {
24
24
  */
25
25
  name: string;
26
26
  /**
27
- * Parent folder PathPart ID
27
+ * Parent folder ID
28
28
  * @type {string}
29
29
  * @memberof CreateDocumentRequest
30
30
  */
31
- parentId: string;
31
+ parentFolderId: string;
32
32
  /**
33
33
  * Type of document (PDF, UNKNOWN, etc.)
34
34
  * @type {DocumentType}
@@ -19,7 +19,7 @@ import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
19
19
  export function instanceOfCreateDocumentRequest(value) {
20
20
  if (!('name' in value) || value['name'] === undefined)
21
21
  return false;
22
- if (!('parentId' in value) || value['parentId'] === undefined)
22
+ if (!('parentFolderId' in value) || value['parentFolderId'] === undefined)
23
23
  return false;
24
24
  if (!('documentType' in value) || value['documentType'] === undefined)
25
25
  return false;
@@ -36,7 +36,7 @@ export function CreateDocumentRequestFromJSONTyped(json, ignoreDiscriminator) {
36
36
  }
37
37
  return {
38
38
  'name': json['name'],
39
- 'parentId': json['parent_id'],
39
+ 'parentFolderId': json['parent_folder_id'],
40
40
  'documentType': DocumentTypeFromJSON(json['document_type']),
41
41
  'documentOrigin': DocumentOriginFromJSON(json['document_origin']),
42
42
  };
@@ -50,7 +50,7 @@ export function CreateDocumentRequestToJSONTyped(value, ignoreDiscriminator = fa
50
50
  }
51
51
  return {
52
52
  'name': value['name'],
53
- 'parent_id': value['parentId'],
53
+ 'parent_folder_id': value['parentFolderId'],
54
54
  'document_type': DocumentTypeToJSON(value['documentType']),
55
55
  'document_origin': DocumentOriginToJSON(value['documentOrigin']),
56
56
  };
@@ -22,11 +22,11 @@ export interface CreateFolderRequest {
22
22
  */
23
23
  name: string;
24
24
  /**
25
- * Parent folder PathPart ID
25
+ * Parent folder ID
26
26
  * @type {string}
27
27
  * @memberof CreateFolderRequest
28
28
  */
29
- parentId: string;
29
+ parentFolderId: string;
30
30
  }
31
31
  /**
32
32
  * Check if a given object implements the CreateFolderRequest interface.
@@ -17,7 +17,7 @@
17
17
  export function instanceOfCreateFolderRequest(value) {
18
18
  if (!('name' in value) || value['name'] === undefined)
19
19
  return false;
20
- if (!('parentId' in value) || value['parentId'] === undefined)
20
+ if (!('parentFolderId' in value) || value['parentFolderId'] === undefined)
21
21
  return false;
22
22
  return true;
23
23
  }
@@ -30,7 +30,7 @@ export function CreateFolderRequestFromJSONTyped(json, ignoreDiscriminator) {
30
30
  }
31
31
  return {
32
32
  'name': json['name'],
33
- 'parentId': json['parent_id'],
33
+ 'parentFolderId': json['parent_folder_id'],
34
34
  };
35
35
  }
36
36
  export function CreateFolderRequestToJSON(json) {
@@ -42,7 +42,7 @@ export function CreateFolderRequestToJSONTyped(value, ignoreDiscriminator = fals
42
42
  }
43
43
  return {
44
44
  'name': value['name'],
45
- 'parent_id': value['parentId'],
45
+ 'parent_folder_id': value['parentFolderId'],
46
46
  };
47
47
  }
48
48
  export const CreateFolderRequestPropertyValidationAttributesMap = {
@@ -37,11 +37,11 @@ export interface DocumentResponse {
37
37
  */
38
38
  name: string;
39
39
  /**
40
- * Parent PathPart ID
40
+ * Parent folder ID
41
41
  * @type {string}
42
42
  * @memberof DocumentResponse
43
43
  */
44
- parentId: string;
44
+ parentFolderId: string;
45
45
  /**
46
46
  * Type of document
47
47
  * @type {DocumentType}
@@ -24,7 +24,7 @@ export function instanceOfDocumentResponse(value) {
24
24
  return false;
25
25
  if (!('name' in value) || value['name'] === undefined)
26
26
  return false;
27
- if (!('parentId' in value) || value['parentId'] === undefined)
27
+ if (!('parentFolderId' in value) || value['parentFolderId'] === undefined)
28
28
  return false;
29
29
  if (!('documentType' in value) || value['documentType'] === undefined)
30
30
  return false;
@@ -55,7 +55,7 @@ export function DocumentResponseFromJSONTyped(json, ignoreDiscriminator) {
55
55
  'id': json['id'],
56
56
  'pathPartId': json['path_part_id'],
57
57
  'name': json['name'],
58
- 'parentId': json['parent_id'],
58
+ 'parentFolderId': json['parent_folder_id'],
59
59
  'documentType': DocumentTypeFromJSON(json['document_type']),
60
60
  'documentOrigin': DocumentOriginFromJSON(json['document_origin']),
61
61
  'activeVersionId': json['active_version_id'],
@@ -77,7 +77,7 @@ export function DocumentResponseToJSONTyped(value, ignoreDiscriminator = false)
77
77
  'id': value['id'],
78
78
  'path_part_id': value['pathPartId'],
79
79
  'name': value['name'],
80
- 'parent_id': value['parentId'],
80
+ 'parent_folder_id': value['parentFolderId'],
81
81
  'document_type': DocumentTypeToJSON(value['documentType']),
82
82
  'document_origin': DocumentOriginToJSON(value['documentOrigin']),
83
83
  'active_version_id': value['activeVersionId'],
@@ -0,0 +1,89 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { PipelineState } from './PipelineState';
13
+ /**
14
+ * Schema for document_version.metadata JSONB field.
15
+ *
16
+ * Tracks S3 URLs for generated artifacts, pipeline execution state,
17
+ * and document statistics. Convention-based paths (images, page screenshots)
18
+ * are derived from document_id/document_version_id via s3_paths helpers,
19
+ * using a flat S3 layout: documents/{document_id}/{document_version_id}/...
20
+ * @export
21
+ * @interface DocumentVersionMetadata
22
+ */
23
+ export interface DocumentVersionMetadata {
24
+ /**
25
+ * S3 URL to the source document (set by API on upload)
26
+ * @type {string}
27
+ * @memberof DocumentVersionMetadata
28
+ */
29
+ sourceS3?: string;
30
+ /**
31
+ * S3 URL to watermark-removed source document
32
+ * @type {string}
33
+ * @memberof DocumentVersionMetadata
34
+ */
35
+ cleanedSourceS3?: string;
36
+ /**
37
+ * S3 URL to the Docling JSON conversion output
38
+ * @type {string}
39
+ * @memberof DocumentVersionMetadata
40
+ */
41
+ doclingJsonS3?: string;
42
+ /**
43
+ * Current state of the ingestion pipeline workflow
44
+ * @type {PipelineState}
45
+ * @memberof DocumentVersionMetadata
46
+ */
47
+ pipelineState?: PipelineState;
48
+ /**
49
+ * Total number of pages in the document
50
+ * @type {number}
51
+ * @memberof DocumentVersionMetadata
52
+ */
53
+ totalPages?: number;
54
+ /**
55
+ * Total number of sections created
56
+ * @type {number}
57
+ * @memberof DocumentVersionMetadata
58
+ */
59
+ totalSections?: number;
60
+ /**
61
+ * Total number of chunks created
62
+ * @type {number}
63
+ * @memberof DocumentVersionMetadata
64
+ */
65
+ totalChunks?: number;
66
+ }
67
+ /**
68
+ * Check if a given object implements the DocumentVersionMetadata interface.
69
+ */
70
+ export declare function instanceOfDocumentVersionMetadata(value: object): value is DocumentVersionMetadata;
71
+ export declare function DocumentVersionMetadataFromJSON(json: any): DocumentVersionMetadata;
72
+ export declare function DocumentVersionMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionMetadata;
73
+ export declare function DocumentVersionMetadataToJSON(json: any): DocumentVersionMetadata;
74
+ export declare function DocumentVersionMetadataToJSONTyped(value?: DocumentVersionMetadata | null, ignoreDiscriminator?: boolean): any;
75
+ export declare const DocumentVersionMetadataPropertyValidationAttributesMap: {
76
+ [property: string]: {
77
+ maxLength?: number;
78
+ minLength?: number;
79
+ pattern?: string;
80
+ maximum?: number;
81
+ exclusiveMaximum?: boolean;
82
+ minimum?: number;
83
+ exclusiveMinimum?: boolean;
84
+ multipleOf?: number;
85
+ maxItems?: number;
86
+ minItems?: number;
87
+ uniqueItems?: boolean;
88
+ };
89
+ };