@knowledge-stack/ksapi 3.13.1 → 3.14.1
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.
- package/.openapi-generator/FILES +4 -0
- package/README.md +6 -2
- package/dist/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/apis/DocumentVersionsApi.js +2 -2
- package/dist/apis/DocumentsApi.d.ts +4 -4
- package/dist/apis/DocumentsApi.js +2 -2
- package/dist/apis/SystemJobsApi.d.ts +126 -17
- package/dist/apis/SystemJobsApi.js +137 -8
- package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/esm/apis/DocumentVersionsApi.js +2 -2
- package/dist/esm/apis/DocumentsApi.d.ts +4 -4
- package/dist/esm/apis/DocumentsApi.js +2 -2
- package/dist/esm/apis/SystemJobsApi.d.ts +126 -17
- package/dist/esm/apis/SystemJobsApi.js +138 -9
- package/dist/esm/models/BulkFailureReason.d.ts +3 -0
- package/dist/esm/models/BulkFailureReason.js +4 -1
- package/dist/esm/models/BulkRerunRequest.d.ts +47 -0
- package/dist/esm/models/BulkRerunRequest.js +42 -0
- package/dist/esm/models/PaginatedResponseUserInfo.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseUserInfo.js +70 -0
- package/dist/esm/models/WorkflowDetailResponse.d.ts +26 -1
- package/dist/esm/models/WorkflowDetailResponse.js +17 -0
- package/dist/esm/models/WorkflowSummaryResponse.d.ts +26 -1
- package/dist/esm/models/WorkflowSummaryResponse.js +17 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/BulkFailureReason.d.ts +3 -0
- package/dist/models/BulkFailureReason.js +4 -1
- package/dist/models/BulkRerunRequest.d.ts +47 -0
- package/dist/models/BulkRerunRequest.js +50 -0
- package/dist/models/PaginatedResponseUserInfo.d.ts +66 -0
- package/dist/models/PaginatedResponseUserInfo.js +78 -0
- package/dist/models/WorkflowDetailResponse.d.ts +26 -1
- package/dist/models/WorkflowDetailResponse.js +17 -0
- package/dist/models/WorkflowSummaryResponse.d.ts +26 -1
- package/dist/models/WorkflowSummaryResponse.js +17 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/BulkRerunRequest.md +35 -0
- package/docs/DocumentVersionsApi.md +1 -1
- package/docs/DocumentsApi.md +1 -1
- package/docs/PaginatedResponseUserInfo.md +40 -0
- package/docs/SystemJobsApi.md +190 -5
- package/docs/WorkflowDetailResponse.md +8 -0
- package/docs/WorkflowSummaryResponse.md +8 -0
- package/package.json +1 -1
- package/src/apis/DocumentVersionsApi.ts +4 -4
- package/src/apis/DocumentsApi.ts +4 -4
- package/src/apis/SystemJobsApi.ts +272 -16
- package/src/models/BulkFailureReason.ts +4 -1
- package/src/models/BulkRerunRequest.ts +82 -0
- package/src/models/PaginatedResponseUserInfo.ts +130 -0
- package/src/models/WorkflowDetailResponse.ts +44 -1
- package/src/models/WorkflowSummaryResponse.ts +44 -1
- package/src/models/index.ts +2 -0
|
@@ -62,6 +62,55 @@ const index_1 = require("../models/index");
|
|
|
62
62
|
*
|
|
63
63
|
*/
|
|
64
64
|
class SystemJobsApi extends runtime.BaseAPI {
|
|
65
|
+
/**
|
|
66
|
+
* Creates request options for bulkRerunDvWorkflows without sending the request
|
|
67
|
+
*/
|
|
68
|
+
bulkRerunDvWorkflowsRequestOpts(requestParameters) {
|
|
69
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
70
|
+
if (requestParameters['bulkRerunRequest'] == null) {
|
|
71
|
+
throw new runtime.RequiredError('bulkRerunRequest', 'Required parameter "bulkRerunRequest" was null or undefined when calling bulkRerunDvWorkflows().');
|
|
72
|
+
}
|
|
73
|
+
const queryParameters = {};
|
|
74
|
+
const headerParameters = {};
|
|
75
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
76
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
77
|
+
const token = this.configuration.accessToken;
|
|
78
|
+
const tokenString = yield token("bearerAuth", []);
|
|
79
|
+
if (tokenString) {
|
|
80
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
let urlPath = `/v1/system-jobs/document_versions/bulk-rerun`;
|
|
84
|
+
return {
|
|
85
|
+
path: urlPath,
|
|
86
|
+
method: 'POST',
|
|
87
|
+
headers: headerParameters,
|
|
88
|
+
query: queryParameters,
|
|
89
|
+
body: (0, index_1.BulkRerunRequestToJSON)(requestParameters['bulkRerunRequest']),
|
|
90
|
+
};
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Re-run ingestion for the selected document versions, reporting per item. ``not_found``: missing, trashed, never ingested or without its stored source; ``forbidden``: no ``can_write``; ``in_progress_workflow``: still pending/processing; ``already_ingested``: completed; ``unsupported_document_type``: a type that is no longer ingested; ``superseded``: a newer version of the document exists. More than 200 ids is a 400 before any re-run.
|
|
95
|
+
* Bulk Rerun Dv Workflows Handler
|
|
96
|
+
*/
|
|
97
|
+
bulkRerunDvWorkflowsRaw(requestParameters, initOverrides) {
|
|
98
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
99
|
+
const requestOptions = yield this.bulkRerunDvWorkflowsRequestOpts(requestParameters);
|
|
100
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
101
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BulkOperationResponseFromJSON)(jsonValue));
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Re-run ingestion for the selected document versions, reporting per item. ``not_found``: missing, trashed, never ingested or without its stored source; ``forbidden``: no ``can_write``; ``in_progress_workflow``: still pending/processing; ``already_ingested``: completed; ``unsupported_document_type``: a type that is no longer ingested; ``superseded``: a newer version of the document exists. More than 200 ids is a 400 before any re-run.
|
|
106
|
+
* Bulk Rerun Dv Workflows Handler
|
|
107
|
+
*/
|
|
108
|
+
bulkRerunDvWorkflows(requestParameters, initOverrides) {
|
|
109
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
110
|
+
const response = yield this.bulkRerunDvWorkflowsRaw(requestParameters, initOverrides);
|
|
111
|
+
return yield response.value();
|
|
112
|
+
});
|
|
113
|
+
}
|
|
65
114
|
/**
|
|
66
115
|
* Creates request options for cancelTemporalWorkflow without sending the request
|
|
67
116
|
*/
|
|
@@ -90,7 +139,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
90
139
|
});
|
|
91
140
|
}
|
|
92
141
|
/**
|
|
93
|
-
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side.
|
|
142
|
+
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side. A run no worker ever picked up is terminated instead, since a cancel request is itself a workflow task nobody would process. When Temporal no longer has the run, or it was terminated here, a document version still showing it running is settled as cancelled (needs ``can_write``) so it can be re-run.
|
|
94
143
|
* Cancel Temporal Workflow Handler
|
|
95
144
|
*/
|
|
96
145
|
cancelTemporalWorkflowRaw(requestParameters, initOverrides) {
|
|
@@ -101,7 +150,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
101
150
|
});
|
|
102
151
|
}
|
|
103
152
|
/**
|
|
104
|
-
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side.
|
|
153
|
+
* Cancel any Temporal workflow owned by the caller\'s tenant. No status guard — this is a thin Temporal wrapper. Cancelling an already-terminal workflow is a no-op on the Temporal side. A run no worker ever picked up is terminated instead, since a cancel request is itself a workflow task nobody would process. When Temporal no longer has the run, or it was terminated here, a document version still showing it running is settled as cancelled (needs ``can_write``) so it can be re-run.
|
|
105
154
|
* Cancel Temporal Workflow Handler
|
|
106
155
|
*/
|
|
107
156
|
cancelTemporalWorkflow(requestParameters, initOverrides) {
|
|
@@ -138,7 +187,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
138
187
|
});
|
|
139
188
|
}
|
|
140
189
|
/**
|
|
141
|
-
* Rerun a workflow. USER role requires ``can_write`` on the document path. ``s3_client`` is injected because ``DocumentIngestionService.__init__`` requires it, even though the re-ingestion path reuses the existing S3 source.
|
|
190
|
+
* Rerun a workflow. USER role requires ``can_write`` on the document path. A version that a newer live version supersedes is refused with 409. ``s3_client`` is injected because ``DocumentIngestionService.__init__`` requires it, even though the re-ingestion path reuses the existing S3 source.
|
|
142
191
|
* Dv Workflow Rerun Handler
|
|
143
192
|
*/
|
|
144
193
|
dvWorkflowRerunRaw(requestParameters, initOverrides) {
|
|
@@ -149,7 +198,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
149
198
|
});
|
|
150
199
|
}
|
|
151
200
|
/**
|
|
152
|
-
* Rerun a workflow. USER role requires ``can_write`` on the document path. ``s3_client`` is injected because ``DocumentIngestionService.__init__`` requires it, even though the re-ingestion path reuses the existing S3 source.
|
|
201
|
+
* Rerun a workflow. USER role requires ``can_write`` on the document path. A version that a newer live version supersedes is refused with 409. ``s3_client`` is injected because ``DocumentIngestionService.__init__`` requires it, even though the re-ingestion path reuses the existing S3 source.
|
|
153
202
|
* Dv Workflow Rerun Handler
|
|
154
203
|
*/
|
|
155
204
|
dvWorkflowRerun(requestParameters, initOverrides) {
|
|
@@ -282,7 +331,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
282
331
|
});
|
|
283
332
|
}
|
|
284
333
|
/**
|
|
285
|
-
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
334
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s. Any other workflow type has no ``results`` query and is a 404, not a 500.
|
|
286
335
|
* Get Zip Ingestion Status Handler
|
|
287
336
|
*/
|
|
288
337
|
getZipIngestionStatusRaw(requestParameters, initOverrides) {
|
|
@@ -293,7 +342,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
293
342
|
});
|
|
294
343
|
}
|
|
295
344
|
/**
|
|
296
|
-
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
345
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s. Any other workflow type has no ``results`` query and is a 404, not a 500.
|
|
297
346
|
* Get Zip Ingestion Status Handler
|
|
298
347
|
*/
|
|
299
348
|
getZipIngestionStatus(requestParameters, initOverrides) {
|
|
@@ -302,6 +351,59 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
302
351
|
return yield response.value();
|
|
303
352
|
});
|
|
304
353
|
}
|
|
354
|
+
/**
|
|
355
|
+
* Creates request options for listDvWorkflowUploaders without sending the request
|
|
356
|
+
*/
|
|
357
|
+
listDvWorkflowUploadersRequestOpts(requestParameters) {
|
|
358
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
359
|
+
const queryParameters = {};
|
|
360
|
+
if (requestParameters['usernameLike'] != null) {
|
|
361
|
+
queryParameters['username_like'] = requestParameters['usernameLike'];
|
|
362
|
+
}
|
|
363
|
+
if (requestParameters['limit'] != null) {
|
|
364
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
365
|
+
}
|
|
366
|
+
if (requestParameters['offset'] != null) {
|
|
367
|
+
queryParameters['offset'] = requestParameters['offset'];
|
|
368
|
+
}
|
|
369
|
+
const headerParameters = {};
|
|
370
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
371
|
+
const token = this.configuration.accessToken;
|
|
372
|
+
const tokenString = yield token("bearerAuth", []);
|
|
373
|
+
if (tokenString) {
|
|
374
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
375
|
+
}
|
|
376
|
+
}
|
|
377
|
+
let urlPath = `/v1/system-jobs/document_versions/uploaders`;
|
|
378
|
+
return {
|
|
379
|
+
path: urlPath,
|
|
380
|
+
method: 'GET',
|
|
381
|
+
headers: headerParameters,
|
|
382
|
+
query: queryParameters,
|
|
383
|
+
};
|
|
384
|
+
});
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* People who uploaded a version the caller can list, for the uploader filter. Scoped like ``list_dv_workflows``: USER only counts versions under readable paths.
|
|
388
|
+
* List Dv Workflow Uploaders Handler
|
|
389
|
+
*/
|
|
390
|
+
listDvWorkflowUploadersRaw(requestParameters, initOverrides) {
|
|
391
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
392
|
+
const requestOptions = yield this.listDvWorkflowUploadersRequestOpts(requestParameters);
|
|
393
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
394
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseUserInfoFromJSON)(jsonValue));
|
|
395
|
+
});
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* People who uploaded a version the caller can list, for the uploader filter. Scoped like ``list_dv_workflows``: USER only counts versions under readable paths.
|
|
399
|
+
* List Dv Workflow Uploaders Handler
|
|
400
|
+
*/
|
|
401
|
+
listDvWorkflowUploaders() {
|
|
402
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
403
|
+
const response = yield this.listDvWorkflowUploadersRaw(requestParameters, initOverrides);
|
|
404
|
+
return yield response.value();
|
|
405
|
+
});
|
|
406
|
+
}
|
|
305
407
|
/**
|
|
306
408
|
* Creates request options for listDvWorkflows without sending the request
|
|
307
409
|
*/
|
|
@@ -314,6 +416,33 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
314
416
|
if (requestParameters['offset'] != null) {
|
|
315
417
|
queryParameters['offset'] = requestParameters['offset'];
|
|
316
418
|
}
|
|
419
|
+
if (requestParameters['sortDir'] != null) {
|
|
420
|
+
queryParameters['sort_dir'] = requestParameters['sortDir'];
|
|
421
|
+
}
|
|
422
|
+
if (requestParameters['status'] != null) {
|
|
423
|
+
queryParameters['status'] = requestParameters['status'];
|
|
424
|
+
}
|
|
425
|
+
if (requestParameters['nameLike'] != null) {
|
|
426
|
+
queryParameters['name_like'] = requestParameters['nameLike'];
|
|
427
|
+
}
|
|
428
|
+
if (requestParameters['latestVersionOnly'] != null) {
|
|
429
|
+
queryParameters['latest_version_only'] = requestParameters['latestVersionOnly'];
|
|
430
|
+
}
|
|
431
|
+
if (requestParameters['uploaderUserId'] != null) {
|
|
432
|
+
queryParameters['uploader_user_id'] = requestParameters['uploaderUserId'];
|
|
433
|
+
}
|
|
434
|
+
if (requestParameters['createdAfter'] != null) {
|
|
435
|
+
queryParameters['created_after'] = requestParameters['createdAfter'].toISOString();
|
|
436
|
+
}
|
|
437
|
+
if (requestParameters['createdBefore'] != null) {
|
|
438
|
+
queryParameters['created_before'] = requestParameters['createdBefore'].toISOString();
|
|
439
|
+
}
|
|
440
|
+
if (requestParameters['updatedAfter'] != null) {
|
|
441
|
+
queryParameters['updated_after'] = requestParameters['updatedAfter'].toISOString();
|
|
442
|
+
}
|
|
443
|
+
if (requestParameters['updatedBefore'] != null) {
|
|
444
|
+
queryParameters['updated_before'] = requestParameters['updatedBefore'].toISOString();
|
|
445
|
+
}
|
|
317
446
|
const headerParameters = {};
|
|
318
447
|
if (this.configuration && this.configuration.accessToken) {
|
|
319
448
|
const token = this.configuration.accessToken;
|
|
@@ -332,7 +461,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
332
461
|
});
|
|
333
462
|
}
|
|
334
463
|
/**
|
|
335
|
-
* List
|
|
464
|
+
* List ingestions of live documents in the current tenant, newest upload first. ADMIN/OWNER see every version; USER only versions under readable paths. ``sort_dir=ASC`` lists the oldest upload first.
|
|
336
465
|
* List Dv Workflows Handler
|
|
337
466
|
*/
|
|
338
467
|
listDvWorkflowsRaw(requestParameters, initOverrides) {
|
|
@@ -343,7 +472,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
343
472
|
});
|
|
344
473
|
}
|
|
345
474
|
/**
|
|
346
|
-
* List
|
|
475
|
+
* List ingestions of live documents in the current tenant, newest upload first. ADMIN/OWNER see every version; USER only versions under readable paths. ``sort_dir=ASC`` lists the oldest upload first.
|
|
347
476
|
* List Dv Workflows Handler
|
|
348
477
|
*/
|
|
349
478
|
listDvWorkflows() {
|
|
@@ -324,7 +324,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
324
324
|
*/
|
|
325
325
|
updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts>;
|
|
326
326
|
/**
|
|
327
|
-
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
327
|
+
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``). Any settle pushes a tenant-wide ``document_detail_changed``; a failed, cancelled or quota-limited one does so with the ``ingestion_failed`` kind so open views (the Ingestions page) refetch.
|
|
328
328
|
* @summary Update Document Version Metadata Handler
|
|
329
329
|
* @param {string} versionId DocumentVersion ID
|
|
330
330
|
* @param {DocumentVersionMetadataUpdate} documentVersionMetadataUpdate
|
|
@@ -334,7 +334,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
334
334
|
*/
|
|
335
335
|
updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
|
|
336
336
|
/**
|
|
337
|
-
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
337
|
+
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``). Any settle pushes a tenant-wide ``document_detail_changed``; a failed, cancelled or quota-limited one does so with the ``ingestion_failed`` kind so open views (the Ingestions page) refetch.
|
|
338
338
|
* Update Document Version Metadata Handler
|
|
339
339
|
*/
|
|
340
340
|
updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
|
|
@@ -486,12 +486,12 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
|
|
|
486
486
|
*/
|
|
487
487
|
updateDocumentVersionMetadataRequestOpts(requestParameters: UpdateDocumentVersionMetadataRequest): Promise<runtime.RequestOpts>;
|
|
488
488
|
/**
|
|
489
|
-
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
489
|
+
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``). Any settle pushes a tenant-wide ``document_detail_changed``; a failed, cancelled or quota-limited one does so with the ``ingestion_failed`` kind so open views (the Ingestions page) refetch.
|
|
490
490
|
* Update Document Version Metadata Handler
|
|
491
491
|
*/
|
|
492
492
|
updateDocumentVersionMetadataRaw(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
|
|
493
493
|
/**
|
|
494
|
-
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
494
|
+
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``). Any settle pushes a tenant-wide ``document_detail_changed``; a failed, cancelled or quota-limited one does so with the ``ingestion_failed`` kind so open views (the Ingestions page) refetch.
|
|
495
495
|
* Update Document Version Metadata Handler
|
|
496
496
|
*/
|
|
497
497
|
updateDocumentVersionMetadata(requestParameters: UpdateDocumentVersionMetadataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
|
|
@@ -613,7 +613,7 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
|
|
|
613
613
|
});
|
|
614
614
|
}
|
|
615
615
|
/**
|
|
616
|
-
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
616
|
+
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``). Any settle pushes a tenant-wide ``document_detail_changed``; a failed, cancelled or quota-limited one does so with the ``ingestion_failed`` kind so open views (the Ingestions page) refetch.
|
|
617
617
|
* Update Document Version Metadata Handler
|
|
618
618
|
*/
|
|
619
619
|
updateDocumentVersionMetadataRaw(requestParameters, initOverrides) {
|
|
@@ -624,7 +624,7 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
|
|
|
624
624
|
});
|
|
625
625
|
}
|
|
626
626
|
/**
|
|
627
|
-
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``).
|
|
627
|
+
* 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. When this PATCH settles an ``inputs/`` upload\'s ingestion (an in-progress pipeline reaching a terminal state), it drives the parent workflow run forward: the two-step ``PENDING <-> NOT_STARTED`` toggle, plus auto-start / auto-fail for an ``auto_start`` run (see ``WorkflowRunStartService.auto_advance_on_input_settled``). Any settle pushes a tenant-wide ``document_detail_changed``; a failed, cancelled or quota-limited one does so with the ``ingestion_failed`` kind so open views (the Ingestions page) refetch.
|
|
628
628
|
* Update Document Version Metadata Handler
|
|
629
629
|
*/
|
|
630
630
|
updateDocumentVersionMetadata(requestParameters, initOverrides) {
|
|
@@ -356,7 +356,7 @@ export interface DocumentsApiInterface {
|
|
|
356
356
|
*/
|
|
357
357
|
ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
|
|
358
358
|
/**
|
|
359
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
359
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
360
360
|
* @summary Ingest Zip Handler
|
|
361
361
|
* @param {Blob} file
|
|
362
362
|
* @param {string} pathPartId Parent path part ID (must be a FOLDER type)
|
|
@@ -368,7 +368,7 @@ export interface DocumentsApiInterface {
|
|
|
368
368
|
*/
|
|
369
369
|
ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
|
|
370
370
|
/**
|
|
371
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
371
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
372
372
|
* Ingest Zip Handler
|
|
373
373
|
*/
|
|
374
374
|
ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
|
|
@@ -615,12 +615,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
615
615
|
*/
|
|
616
616
|
ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
|
|
617
617
|
/**
|
|
618
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
618
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
619
619
|
* Ingest Zip Handler
|
|
620
620
|
*/
|
|
621
621
|
ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
|
|
622
622
|
/**
|
|
623
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
623
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
624
624
|
* Ingest Zip Handler
|
|
625
625
|
*/
|
|
626
626
|
ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
|
|
@@ -664,7 +664,7 @@ export class DocumentsApi extends runtime.BaseAPI {
|
|
|
664
664
|
});
|
|
665
665
|
}
|
|
666
666
|
/**
|
|
667
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
667
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
668
668
|
* Ingest Zip Handler
|
|
669
669
|
*/
|
|
670
670
|
ingestZipRaw(requestParameters, initOverrides) {
|
|
@@ -675,7 +675,7 @@ export class DocumentsApi extends runtime.BaseAPI {
|
|
|
675
675
|
});
|
|
676
676
|
}
|
|
677
677
|
/**
|
|
678
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
678
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
679
679
|
* Ingest Zip Handler
|
|
680
680
|
*/
|
|
681
681
|
ingestZip(requestParameters, initOverrides) {
|