@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
@@ -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,137 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
+ return new (P || (P = Promise))(function (resolve, reject) {
18
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
22
+ });
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.WorkflowsApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const index_1 = require("../models/index");
28
+ /**
29
+ *
30
+ */
31
+ class WorkflowsApi extends runtime.BaseAPI {
32
+ /**
33
+ * Get single workflow detail with live Temporal status.
34
+ * Get Workflow Handler
35
+ */
36
+ getWorkflowRaw(requestParameters, initOverrides) {
37
+ return __awaiter(this, void 0, void 0, function* () {
38
+ if (requestParameters['workflowId'] == null) {
39
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling getWorkflow().');
40
+ }
41
+ const queryParameters = {};
42
+ const headerParameters = {};
43
+ let urlPath = `/v1/workflows/{workflow_id}`;
44
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
45
+ const response = yield this.request({
46
+ path: urlPath,
47
+ method: 'GET',
48
+ headers: headerParameters,
49
+ query: queryParameters,
50
+ }, initOverrides);
51
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowDetailResponseFromJSON)(jsonValue));
52
+ });
53
+ }
54
+ /**
55
+ * Get single workflow detail with live Temporal status.
56
+ * Get Workflow Handler
57
+ */
58
+ getWorkflow(requestParameters, initOverrides) {
59
+ return __awaiter(this, void 0, void 0, function* () {
60
+ const response = yield this.getWorkflowRaw(requestParameters, initOverrides);
61
+ return yield response.value();
62
+ });
63
+ }
64
+ /**
65
+ * List all workflows for the current tenant (paginated, DB-backed).
66
+ * List Workflows Handler
67
+ */
68
+ listWorkflowsRaw(requestParameters, initOverrides) {
69
+ return __awaiter(this, void 0, void 0, function* () {
70
+ const queryParameters = {};
71
+ if (requestParameters['limit'] != null) {
72
+ queryParameters['limit'] = requestParameters['limit'];
73
+ }
74
+ if (requestParameters['offset'] != null) {
75
+ queryParameters['offset'] = requestParameters['offset'];
76
+ }
77
+ const headerParameters = {};
78
+ let urlPath = `/v1/workflows`;
79
+ const response = yield this.request({
80
+ path: urlPath,
81
+ method: 'GET',
82
+ headers: headerParameters,
83
+ query: queryParameters,
84
+ }, initOverrides);
85
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseWorkflowSummaryResponseFromJSON)(jsonValue));
86
+ });
87
+ }
88
+ /**
89
+ * List all workflows for the current tenant (paginated, DB-backed).
90
+ * List Workflows Handler
91
+ */
92
+ listWorkflows() {
93
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
94
+ const response = yield this.listWorkflowsRaw(requestParameters, initOverrides);
95
+ return yield response.value();
96
+ });
97
+ }
98
+ /**
99
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
100
+ * Workflow Action Handler
101
+ */
102
+ workflowActionRaw(requestParameters, initOverrides) {
103
+ return __awaiter(this, void 0, void 0, function* () {
104
+ if (requestParameters['workflowId'] == null) {
105
+ throw new runtime.RequiredError('workflowId', 'Required parameter "workflowId" was null or undefined when calling workflowAction().');
106
+ }
107
+ if (requestParameters['action'] == null) {
108
+ throw new runtime.RequiredError('action', 'Required parameter "action" was null or undefined when calling workflowAction().');
109
+ }
110
+ const queryParameters = {};
111
+ if (requestParameters['action'] != null) {
112
+ queryParameters['action'] = requestParameters['action'];
113
+ }
114
+ const headerParameters = {};
115
+ let urlPath = `/v1/workflows/{workflow_id}`;
116
+ urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
117
+ const response = yield this.request({
118
+ path: urlPath,
119
+ method: 'POST',
120
+ headers: headerParameters,
121
+ query: queryParameters,
122
+ }, initOverrides);
123
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowActionResponseFromJSON)(jsonValue));
124
+ });
125
+ }
126
+ /**
127
+ * Cancel or rerun a workflow (OWNER/ADMIN only).
128
+ * Workflow Action Handler
129
+ */
130
+ workflowAction(requestParameters, initOverrides) {
131
+ return __awaiter(this, void 0, void 0, function* () {
132
+ const response = yield this.workflowActionRaw(requestParameters, initOverrides);
133
+ return yield response.value();
134
+ });
135
+ }
136
+ }
137
+ exports.WorkflowsApi = WorkflowsApi;
@@ -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';
@@ -32,3 +32,4 @@ __exportStar(require("./ThreadMessagesApi"), exports);
32
32
  __exportStar(require("./ThreadsApi"), exports);
33
33
  __exportStar(require("./UserPermissionsApi"), exports);
34
34
  __exportStar(require("./UsersApi"), exports);
35
+ __exportStar(require("./WorkflowsApi"), exports);
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { DocumentVersionResponse, PaginatedResponseDocumentContentPathPart, PaginatedResponseDocumentVersionResponse } from '../models/index';
13
+ import type { DocumentVersionMetadataUpdate, DocumentVersionResponse, PaginatedResponseDocumentContentPathPart, PaginatedResponseDocumentVersionResponse } from '../models/index';
14
14
  export interface CreateDocumentVersionRequest {
15
15
  documentId: string;
16
16
  ksUat?: string;
@@ -36,6 +36,11 @@ export interface ListDocumentVersionsRequest {
36
36
  offset?: number;
37
37
  ksUat?: string;
38
38
  }
39
+ export interface UpdateDocumentVersionMetadataRequest {
40
+ versionId: string;
41
+ documentVersionMetadataUpdate: DocumentVersionMetadataUpdate;
42
+ ksUat?: string;
43
+ }
39
44
  /**
40
45
  * DocumentVersionsApi - interface
41
46
  *
@@ -123,6 +128,22 @@ export interface DocumentVersionsApiInterface {
123
128
  * List Document Versions Handler
124
129
  */
125
130
  listDocumentVersions(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentVersionResponse>;
131
+ /**
132
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
133
+ * @summary Update Document Version Metadata Handler
134
+ * @param {string} versionId DocumentVersion ID
135
+ * @param {DocumentVersionMetadataUpdate} documentVersionMetadataUpdate
136
+ * @param {string} [ksUat]
137
+ * @param {*} [options] Override http request option.
138
+ * @throws {RequiredError}
139
+ * @memberof DocumentVersionsApiInterface
140
+ */
141
+ updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
142
+ /**
143
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
144
+ * Update Document Version Metadata Handler
145
+ */
146
+ updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
126
147
  }
127
148
  /**
128
149
  *
@@ -178,4 +199,14 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
178
199
  * List Document Versions Handler
179
200
  */
180
201
  listDocumentVersions(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentVersionResponse>;
202
+ /**
203
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
204
+ * Update Document Version Metadata Handler
205
+ */
206
+ updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
207
+ /**
208
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
209
+ * Update Document Version Metadata Handler
210
+ */
211
+ updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
181
212
  }
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { DocumentVersionResponseFromJSON, PaginatedResponseDocumentContentPathPartFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
24
+ import { DocumentVersionMetadataUpdateToJSON, DocumentVersionResponseFromJSON, PaginatedResponseDocumentContentPathPartFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -202,4 +202,41 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
202
202
  return yield response.value();
203
203
  });
204
204
  }
205
+ /**
206
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
207
+ * Update Document Version Metadata Handler
208
+ */
209
+ updateDocumentVersionMetadataRaw(requestParameters, initOverrides) {
210
+ return __awaiter(this, void 0, void 0, function* () {
211
+ if (requestParameters['versionId'] == null) {
212
+ throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling updateDocumentVersionMetadata().');
213
+ }
214
+ if (requestParameters['documentVersionMetadataUpdate'] == null) {
215
+ throw new runtime.RequiredError('documentVersionMetadataUpdate', 'Required parameter "documentVersionMetadataUpdate" was null or undefined when calling updateDocumentVersionMetadata().');
216
+ }
217
+ const queryParameters = {};
218
+ const headerParameters = {};
219
+ headerParameters['Content-Type'] = 'application/json';
220
+ let urlPath = `/v1/document_versions/{version_id}/metadata`;
221
+ urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
222
+ const response = yield this.request({
223
+ path: urlPath,
224
+ method: 'PATCH',
225
+ headers: headerParameters,
226
+ query: queryParameters,
227
+ body: DocumentVersionMetadataUpdateToJSON(requestParameters['documentVersionMetadataUpdate']),
228
+ }, initOverrides);
229
+ return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
230
+ });
231
+ }
232
+ /**
233
+ * Merge metadata fields into an existing document version\'s metadata. Only non-null fields in the request body are merged; existing metadata fields not present in the request are preserved.
234
+ * Update Document Version Metadata Handler
235
+ */
236
+ updateDocumentVersionMetadata(requestParameters, initOverrides) {
237
+ return __awaiter(this, void 0, void 0, function* () {
238
+ const response = yield this.updateDocumentVersionMetadataRaw(requestParameters, initOverrides);
239
+ return yield response.value();
240
+ });
241
+ }
205
242
  }
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { CreateDocumentRequest, DocumentResponse, PaginatedResponseDocumentResponse, PathOrder, UpdateDocumentRequest } from '../models/index';
13
+ import type { CreateDocumentRequest, DocumentResponse, IngestDocumentResponse, PaginatedResponseDocumentResponse, PathOrder, UpdateDocumentRequest } from '../models/index';
14
14
  export interface CreateDocumentOperationRequest {
15
15
  createDocumentRequest: CreateDocumentRequest;
16
16
  ksUat?: string;
@@ -23,8 +23,14 @@ export interface GetDocumentRequest {
23
23
  documentId: string;
24
24
  ksUat?: string;
25
25
  }
26
+ export interface IngestDocumentRequest {
27
+ file: Blob;
28
+ folderId: string;
29
+ ksUat?: string;
30
+ name?: string;
31
+ }
26
32
  export interface ListDocumentsRequest {
27
- parentId?: string;
33
+ parentFolderId?: string;
28
34
  sortOrder?: PathOrder;
29
35
  limit?: number;
30
36
  offset?: number;
@@ -88,9 +94,26 @@ export interface DocumentsApiInterface {
88
94
  */
89
95
  getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
90
96
  /**
91
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
97
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
98
+ * @summary Ingest Document Handler
99
+ * @param {Blob} file
100
+ * @param {string} folderId Parent folder ID
101
+ * @param {string} [ksUat]
102
+ * @param {string} [name] Document name (defaults to filename)
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ * @memberof DocumentsApiInterface
106
+ */
107
+ ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
108
+ /**
109
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
110
+ * Ingest Document Handler
111
+ */
112
+ ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
113
+ /**
114
+ * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
92
115
  * @summary List Documents Handler
93
- * @param {string} [parentId] Parent folder PathPart ID (defaults to root)
116
+ * @param {string} [parentFolderId] Parent folder ID (defaults to root)
94
117
  * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
95
118
  * @param {number} [limit] Number of items per page
96
119
  * @param {number} [offset] Number of items to skip
@@ -101,12 +124,12 @@ export interface DocumentsApiInterface {
101
124
  */
102
125
  listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
103
126
  /**
104
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
127
+ * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
105
128
  * List Documents Handler
106
129
  */
107
130
  listDocuments(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
108
131
  /**
109
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
132
+ * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
110
133
  * @summary Update Document Handler
111
134
  * @param {string} documentId
112
135
  * @param {UpdateDocumentRequest} updateDocumentRequest
@@ -117,7 +140,7 @@ export interface DocumentsApiInterface {
117
140
  */
118
141
  updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
119
142
  /**
120
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
143
+ * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
121
144
  * Update Document Handler
122
145
  */
123
146
  updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
@@ -157,22 +180,32 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
157
180
  */
158
181
  getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
159
182
  /**
160
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
183
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
184
+ * Ingest Document Handler
185
+ */
186
+ ingestDocumentRaw(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
187
+ /**
188
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
189
+ * Ingest Document Handler
190
+ */
191
+ ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
192
+ /**
193
+ * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
161
194
  * List Documents Handler
162
195
  */
163
196
  listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
164
197
  /**
165
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
198
+ * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
166
199
  * List Documents Handler
167
200
  */
168
201
  listDocuments(requestParameters?: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
169
202
  /**
170
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
203
+ * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
171
204
  * Update Document Handler
172
205
  */
173
206
  updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
174
207
  /**
175
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
208
+ * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
176
209
  * Update Document Handler
177
210
  */
178
211
  updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { CreateDocumentRequestToJSON, DocumentResponseFromJSON, PaginatedResponseDocumentResponseFromJSON, UpdateDocumentRequestToJSON, } from '../models/index';
24
+ import { CreateDocumentRequestToJSON, DocumentResponseFromJSON, IngestDocumentResponseFromJSON, PaginatedResponseDocumentResponseFromJSON, UpdateDocumentRequestToJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -123,14 +123,73 @@ export class DocumentsApi extends runtime.BaseAPI {
123
123
  });
124
124
  }
125
125
  /**
126
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
126
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
127
+ * Ingest Document Handler
128
+ */
129
+ ingestDocumentRaw(requestParameters, initOverrides) {
130
+ return __awaiter(this, void 0, void 0, function* () {
131
+ if (requestParameters['file'] == null) {
132
+ throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling ingestDocument().');
133
+ }
134
+ if (requestParameters['folderId'] == null) {
135
+ throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling ingestDocument().');
136
+ }
137
+ const queryParameters = {};
138
+ const headerParameters = {};
139
+ const consumes = [
140
+ { contentType: 'multipart/form-data' },
141
+ ];
142
+ // @ts-ignore: canConsumeForm may be unused
143
+ const canConsumeForm = runtime.canConsumeForm(consumes);
144
+ let formParams;
145
+ let useForm = false;
146
+ // use FormData to transmit files using content-type "multipart/form-data"
147
+ useForm = canConsumeForm;
148
+ if (useForm) {
149
+ formParams = new FormData();
150
+ }
151
+ else {
152
+ formParams = new URLSearchParams();
153
+ }
154
+ if (requestParameters['file'] != null) {
155
+ formParams.append('file', requestParameters['file']);
156
+ }
157
+ if (requestParameters['folderId'] != null) {
158
+ formParams.append('folder_id', requestParameters['folderId']);
159
+ }
160
+ if (requestParameters['name'] != null) {
161
+ formParams.append('name', requestParameters['name']);
162
+ }
163
+ let urlPath = `/v1/documents/ingest`;
164
+ const response = yield this.request({
165
+ path: urlPath,
166
+ method: 'POST',
167
+ headers: headerParameters,
168
+ query: queryParameters,
169
+ body: formParams,
170
+ }, initOverrides);
171
+ return new runtime.JSONApiResponse(response, (jsonValue) => IngestDocumentResponseFromJSON(jsonValue));
172
+ });
173
+ }
174
+ /**
175
+ * Upload a file, create document + version, and trigger ingestion workflow. Returns 201 with the Temporal workflow ID. Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
176
+ * Ingest Document Handler
177
+ */
178
+ ingestDocument(requestParameters, initOverrides) {
179
+ return __awaiter(this, void 0, void 0, function* () {
180
+ const response = yield this.ingestDocumentRaw(requestParameters, initOverrides);
181
+ return yield response.value();
182
+ });
183
+ }
184
+ /**
185
+ * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
127
186
  * List Documents Handler
128
187
  */
129
188
  listDocumentsRaw(requestParameters, initOverrides) {
130
189
  return __awaiter(this, void 0, void 0, function* () {
131
190
  const queryParameters = {};
132
- if (requestParameters['parentId'] != null) {
133
- queryParameters['parent_id'] = requestParameters['parentId'];
191
+ if (requestParameters['parentFolderId'] != null) {
192
+ queryParameters['parent_folder_id'] = requestParameters['parentFolderId'];
134
193
  }
135
194
  if (requestParameters['sortOrder'] != null) {
136
195
  queryParameters['sort_order'] = requestParameters['sortOrder'];
@@ -153,7 +212,7 @@ export class DocumentsApi extends runtime.BaseAPI {
153
212
  });
154
213
  }
155
214
  /**
156
- * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
215
+ * List documents in a folder. Returns only direct child documents (depth=1) of the specified parent folder. If parent_folder_id is not provided, lists documents in the root folder.
157
216
  * List Documents Handler
158
217
  */
159
218
  listDocuments() {
@@ -163,7 +222,7 @@ export class DocumentsApi extends runtime.BaseAPI {
163
222
  });
164
223
  }
165
224
  /**
166
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
225
+ * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
167
226
  * Update Document Handler
168
227
  */
169
228
  updateDocumentRaw(requestParameters, initOverrides) {
@@ -190,7 +249,7 @@ export class DocumentsApi extends runtime.BaseAPI {
190
249
  });
191
250
  }
192
251
  /**
193
- * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
252
+ * Update a document (rename, move, and/or change active version). To rename: provide `name` field. To move: provide `parent_folder_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
194
253
  * Update Document Handler
195
254
  */
196
255
  updateDocument(requestParameters, initOverrides) {