@knowledge-stack/ksapi 3.13.1 → 3.14.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 (49) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +6 -2
  3. package/dist/apis/DocumentVersionsApi.d.ts +4 -4
  4. package/dist/apis/DocumentVersionsApi.js +2 -2
  5. package/dist/apis/SystemJobsApi.d.ts +126 -17
  6. package/dist/apis/SystemJobsApi.js +137 -8
  7. package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
  8. package/dist/esm/apis/DocumentVersionsApi.js +2 -2
  9. package/dist/esm/apis/SystemJobsApi.d.ts +126 -17
  10. package/dist/esm/apis/SystemJobsApi.js +138 -9
  11. package/dist/esm/models/BulkFailureReason.d.ts +3 -0
  12. package/dist/esm/models/BulkFailureReason.js +4 -1
  13. package/dist/esm/models/BulkRerunRequest.d.ts +47 -0
  14. package/dist/esm/models/BulkRerunRequest.js +42 -0
  15. package/dist/esm/models/PaginatedResponseUserInfo.d.ts +66 -0
  16. package/dist/esm/models/PaginatedResponseUserInfo.js +70 -0
  17. package/dist/esm/models/WorkflowDetailResponse.d.ts +26 -1
  18. package/dist/esm/models/WorkflowDetailResponse.js +17 -0
  19. package/dist/esm/models/WorkflowSummaryResponse.d.ts +26 -1
  20. package/dist/esm/models/WorkflowSummaryResponse.js +17 -0
  21. package/dist/esm/models/index.d.ts +2 -0
  22. package/dist/esm/models/index.js +2 -0
  23. package/dist/models/BulkFailureReason.d.ts +3 -0
  24. package/dist/models/BulkFailureReason.js +4 -1
  25. package/dist/models/BulkRerunRequest.d.ts +47 -0
  26. package/dist/models/BulkRerunRequest.js +50 -0
  27. package/dist/models/PaginatedResponseUserInfo.d.ts +66 -0
  28. package/dist/models/PaginatedResponseUserInfo.js +78 -0
  29. package/dist/models/WorkflowDetailResponse.d.ts +26 -1
  30. package/dist/models/WorkflowDetailResponse.js +17 -0
  31. package/dist/models/WorkflowSummaryResponse.d.ts +26 -1
  32. package/dist/models/WorkflowSummaryResponse.js +17 -0
  33. package/dist/models/index.d.ts +2 -0
  34. package/dist/models/index.js +2 -0
  35. package/docs/BulkRerunRequest.md +35 -0
  36. package/docs/DocumentVersionsApi.md +1 -1
  37. package/docs/PaginatedResponseUserInfo.md +40 -0
  38. package/docs/SystemJobsApi.md +190 -5
  39. package/docs/WorkflowDetailResponse.md +8 -0
  40. package/docs/WorkflowSummaryResponse.md +8 -0
  41. package/package.json +1 -1
  42. package/src/apis/DocumentVersionsApi.ts +4 -4
  43. package/src/apis/SystemJobsApi.ts +272 -16
  44. package/src/models/BulkFailureReason.ts +4 -1
  45. package/src/models/BulkRerunRequest.ts +82 -0
  46. package/src/models/PaginatedResponseUserInfo.ts +130 -0
  47. package/src/models/WorkflowDetailResponse.ts +44 -1
  48. package/src/models/WorkflowSummaryResponse.ts +44 -1
  49. package/src/models/index.ts +2 -0
@@ -50,6 +50,7 @@ docs/BulkModelTablesResponse.md
50
50
  docs/BulkMoveApi.md
51
51
  docs/BulkMoveRequest.md
52
52
  docs/BulkOperationResponse.md
53
+ docs/BulkRerunRequest.md
53
54
  docs/BulkRevokeRequest.md
54
55
  docs/BulkTagRequest.md
55
56
  docs/BulkTrashRequest.md
@@ -263,6 +264,7 @@ docs/PaginatedResponseTenantUserResponse.md
263
264
  docs/PaginatedResponseThreadMessageResponse.md
264
265
  docs/PaginatedResponseThreadResponse.md
265
266
  docs/PaginatedResponseTrashItemResponse.md
267
+ docs/PaginatedResponseUserInfo.md
266
268
  docs/PaginatedResponseWorkflowDefinitionResponse.md
267
269
  docs/PaginatedResponseWorkflowRunResponse.md
268
270
  docs/PaginatedResponseWorkflowSummaryResponse.md
@@ -544,6 +546,7 @@ src/models/BulkModelTablesRequest.ts
544
546
  src/models/BulkModelTablesResponse.ts
545
547
  src/models/BulkMoveRequest.ts
546
548
  src/models/BulkOperationResponse.ts
549
+ src/models/BulkRerunRequest.ts
547
550
  src/models/BulkRevokeRequest.ts
548
551
  src/models/BulkTagRequest.ts
549
552
  src/models/BulkTrashRequest.ts
@@ -744,6 +747,7 @@ src/models/PaginatedResponseTenantUserResponse.ts
744
747
  src/models/PaginatedResponseThreadMessageResponse.ts
745
748
  src/models/PaginatedResponseThreadResponse.ts
746
749
  src/models/PaginatedResponseTrashItemResponse.ts
750
+ src/models/PaginatedResponseUserInfo.ts
747
751
  src/models/PaginatedResponseWorkflowDefinitionResponse.ts
748
752
  src/models/PaginatedResponseWorkflowRunResponse.ts
749
753
  src/models/PaginatedResponseWorkflowSummaryResponse.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@3.13.1
1
+ # @knowledge-stack/ksapi@3.14.0
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -216,11 +216,13 @@ All URIs are relative to *http://localhost:8000*
216
216
  *SkillsApi* | [**updateSkill**](docs/SkillsApi.md#updateskilloperation) | **PATCH** /v1/skills/{skill_id} | Update Skill Handler
217
217
  *SubscriptionsApi* | [**changeTenantSubscription**](docs/SubscriptionsApi.md#changetenantsubscription) | **POST** /v1/tenants/{tenant_id}/subscriptions | Change Tenant Subscription Handler
218
218
  *SubscriptionsApi* | [**getTenantSubscription**](docs/SubscriptionsApi.md#gettenantsubscription) | **GET** /v1/tenants/{tenant_id}/subscriptions | Get Tenant Subscription Handler
219
+ *SystemJobsApi* | [**bulkRerunDvWorkflows**](docs/SystemJobsApi.md#bulkrerundvworkflows) | **POST** /v1/system-jobs/document_versions/bulk-rerun | Bulk Rerun Dv Workflows Handler
219
220
  *SystemJobsApi* | [**cancelTemporalWorkflow**](docs/SystemJobsApi.md#canceltemporalworkflow) | **DELETE** /v1/system-jobs/{workflow_id} | Cancel Temporal Workflow Handler
220
221
  *SystemJobsApi* | [**dvWorkflowRerun**](docs/SystemJobsApi.md#dvworkflowrerun) | **POST** /v1/system-jobs/document_versions/{workflow_id} | Dv Workflow Rerun Handler
221
222
  *SystemJobsApi* | [**getDvWorkflow**](docs/SystemJobsApi.md#getdvworkflow) | **GET** /v1/system-jobs/document_versions/{workflow_id} | Get Dv Workflow Handler
222
223
  *SystemJobsApi* | [**getTemporalWorkflowStatus**](docs/SystemJobsApi.md#gettemporalworkflowstatus) | **GET** /v1/system-jobs/{workflow_id} | Get Temporal Workflow Status Handler
223
224
  *SystemJobsApi* | [**getZipIngestionStatus**](docs/SystemJobsApi.md#getzipingestionstatus) | **GET** /v1/system-jobs/zip-ingestions/{workflow_id} | Get Zip Ingestion Status Handler
225
+ *SystemJobsApi* | [**listDvWorkflowUploaders**](docs/SystemJobsApi.md#listdvworkflowuploaders) | **GET** /v1/system-jobs/document_versions/uploaders | List Dv Workflow Uploaders Handler
224
226
  *SystemJobsApi* | [**listDvWorkflows**](docs/SystemJobsApi.md#listdvworkflows) | **GET** /v1/system-jobs/document_versions | List Dv Workflows Handler
225
227
  *TagsApi* | [**createTag**](docs/TagsApi.md#createtagoperation) | **POST** /v1/tags | Create Tag Handler
226
228
  *TagsApi* | [**deleteTag**](docs/TagsApi.md#deletetag) | **DELETE** /v1/tags/{tag_id} | Delete Tag Handler
@@ -348,6 +350,7 @@ All URIs are relative to *http://localhost:8000*
348
350
  - [BulkModelTablesResponse](docs/BulkModelTablesResponse.md)
349
351
  - [BulkMoveRequest](docs/BulkMoveRequest.md)
350
352
  - [BulkOperationResponse](docs/BulkOperationResponse.md)
353
+ - [BulkRerunRequest](docs/BulkRerunRequest.md)
351
354
  - [BulkRevokeRequest](docs/BulkRevokeRequest.md)
352
355
  - [BulkTagRequest](docs/BulkTagRequest.md)
353
356
  - [BulkTrashRequest](docs/BulkTrashRequest.md)
@@ -548,6 +551,7 @@ All URIs are relative to *http://localhost:8000*
548
551
  - [PaginatedResponseThreadMessageResponse](docs/PaginatedResponseThreadMessageResponse.md)
549
552
  - [PaginatedResponseThreadResponse](docs/PaginatedResponseThreadResponse.md)
550
553
  - [PaginatedResponseTrashItemResponse](docs/PaginatedResponseTrashItemResponse.md)
554
+ - [PaginatedResponseUserInfo](docs/PaginatedResponseUserInfo.md)
551
555
  - [PaginatedResponseWorkflowDefinitionResponse](docs/PaginatedResponseWorkflowDefinitionResponse.md)
552
556
  - [PaginatedResponseWorkflowRunResponse](docs/PaginatedResponseWorkflowRunResponse.md)
553
557
  - [PaginatedResponseWorkflowSummaryResponse](docs/PaginatedResponseWorkflowSummaryResponse.md)
@@ -752,7 +756,7 @@ and is automatically generated by the
752
756
  [OpenAPI Generator](https://openapi-generator.tech) project:
753
757
 
754
758
  - API version: `0.1.0`
755
- - Package version: `3.13.1`
759
+ - Package version: `3.14.0`
756
760
  - Generator version: `7.21.0`
757
761
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
758
762
 
@@ -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>;
@@ -649,7 +649,7 @@ class DocumentVersionsApi extends runtime.BaseAPI {
649
649
  });
650
650
  }
651
651
  /**
652
- * 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``).
652
+ * 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.
653
653
  * Update Document Version Metadata Handler
654
654
  */
655
655
  updateDocumentVersionMetadataRaw(requestParameters, initOverrides) {
@@ -660,7 +660,7 @@ class DocumentVersionsApi extends runtime.BaseAPI {
660
660
  });
661
661
  }
662
662
  /**
663
- * 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``).
663
+ * 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.
664
664
  * Update Document Version Metadata Handler
665
665
  */
666
666
  updateDocumentVersionMetadata(requestParameters, initOverrides) {
@@ -10,7 +10,10 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { PaginatedResponseWorkflowSummaryResponse, TemporalWorkflowStatusResponse, WorkflowActionResponse, WorkflowCancelResponse, WorkflowDetailResponse, ZipIngestionStatusResponse } from '../models/index';
13
+ import type { BulkOperationResponse, BulkRerunRequest, PaginatedResponseUserInfo, PaginatedResponseWorkflowSummaryResponse, PipelineStatus, SortDirection, TemporalWorkflowStatusResponse, WorkflowActionResponse, WorkflowCancelResponse, WorkflowDetailResponse, ZipIngestionStatusResponse } from '../models/index';
14
+ export interface BulkRerunDvWorkflowsRequest {
15
+ bulkRerunRequest: BulkRerunRequest;
16
+ }
14
17
  export interface CancelTemporalWorkflowRequest {
15
18
  workflowId: string;
16
19
  }
@@ -26,9 +29,23 @@ export interface GetTemporalWorkflowStatusRequest {
26
29
  export interface GetZipIngestionStatusRequest {
27
30
  workflowId: string;
28
31
  }
32
+ export interface ListDvWorkflowUploadersRequest {
33
+ usernameLike?: string | null;
34
+ limit?: number;
35
+ offset?: number;
36
+ }
29
37
  export interface ListDvWorkflowsRequest {
30
38
  limit?: number;
31
39
  offset?: number;
40
+ sortDir?: SortDirection;
41
+ status?: Array<PipelineStatus> | null;
42
+ nameLike?: string | null;
43
+ latestVersionOnly?: boolean;
44
+ uploaderUserId?: string | null;
45
+ createdAfter?: Date | null;
46
+ createdBefore?: Date | null;
47
+ updatedAfter?: Date | null;
48
+ updatedBefore?: Date | null;
32
49
  }
33
50
  /**
34
51
  * SystemJobsApi - interface
@@ -37,6 +54,27 @@ export interface ListDvWorkflowsRequest {
37
54
  * @interface SystemJobsApiInterface
38
55
  */
39
56
  export interface SystemJobsApiInterface {
57
+ /**
58
+ * Creates request options for bulkRerunDvWorkflows without sending the request
59
+ * @param {BulkRerunRequest} bulkRerunRequest
60
+ * @throws {RequiredError}
61
+ * @memberof SystemJobsApiInterface
62
+ */
63
+ bulkRerunDvWorkflowsRequestOpts(requestParameters: BulkRerunDvWorkflowsRequest): Promise<runtime.RequestOpts>;
64
+ /**
65
+ * 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.
66
+ * @summary Bulk Rerun Dv Workflows Handler
67
+ * @param {BulkRerunRequest} bulkRerunRequest
68
+ * @param {*} [options] Override http request option.
69
+ * @throws {RequiredError}
70
+ * @memberof SystemJobsApiInterface
71
+ */
72
+ bulkRerunDvWorkflowsRaw(requestParameters: BulkRerunDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkOperationResponse>>;
73
+ /**
74
+ * 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.
75
+ * Bulk Rerun Dv Workflows Handler
76
+ */
77
+ bulkRerunDvWorkflows(requestParameters: BulkRerunDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkOperationResponse>;
40
78
  /**
41
79
  * Creates request options for cancelTemporalWorkflow without sending the request
42
80
  * @param {string} workflowId
@@ -45,7 +83,7 @@ export interface SystemJobsApiInterface {
45
83
  */
46
84
  cancelTemporalWorkflowRequestOpts(requestParameters: CancelTemporalWorkflowRequest): Promise<runtime.RequestOpts>;
47
85
  /**
48
- * 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.
86
+ * 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.
49
87
  * @summary Cancel Temporal Workflow Handler
50
88
  * @param {string} workflowId
51
89
  * @param {*} [options] Override http request option.
@@ -54,7 +92,7 @@ export interface SystemJobsApiInterface {
54
92
  */
55
93
  cancelTemporalWorkflowRaw(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCancelResponse>>;
56
94
  /**
57
- * 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.
95
+ * 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.
58
96
  * Cancel Temporal Workflow Handler
59
97
  */
60
98
  cancelTemporalWorkflow(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCancelResponse>;
@@ -66,7 +104,7 @@ export interface SystemJobsApiInterface {
66
104
  */
67
105
  dvWorkflowRerunRequestOpts(requestParameters: DvWorkflowRerunRequest): Promise<runtime.RequestOpts>;
68
106
  /**
69
- * 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.
107
+ * 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.
70
108
  * @summary Dv Workflow Rerun Handler
71
109
  * @param {string} workflowId
72
110
  * @param {*} [options] Override http request option.
@@ -75,7 +113,7 @@ export interface SystemJobsApiInterface {
75
113
  */
76
114
  dvWorkflowRerunRaw(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
77
115
  /**
78
- * 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.
116
+ * 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.
79
117
  * Dv Workflow Rerun Handler
80
118
  */
81
119
  dvWorkflowRerun(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
@@ -129,7 +167,7 @@ export interface SystemJobsApiInterface {
129
167
  */
130
168
  getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
131
169
  /**
132
- * 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.
170
+ * 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.
133
171
  * @summary Get Zip Ingestion Status Handler
134
172
  * @param {string} workflowId
135
173
  * @param {*} [options] Override http request option.
@@ -138,30 +176,73 @@ export interface SystemJobsApiInterface {
138
176
  */
139
177
  getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
140
178
  /**
141
- * 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.
179
+ * 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.
142
180
  * Get Zip Ingestion Status Handler
143
181
  */
144
182
  getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
183
+ /**
184
+ * Creates request options for listDvWorkflowUploaders without sending the request
185
+ * @param {string} [usernameLike] Case-insensitive substring of the first or last name
186
+ * @param {number} [limit] Number of items per page
187
+ * @param {number} [offset] Number of items to skip
188
+ * @throws {RequiredError}
189
+ * @memberof SystemJobsApiInterface
190
+ */
191
+ listDvWorkflowUploadersRequestOpts(requestParameters: ListDvWorkflowUploadersRequest): Promise<runtime.RequestOpts>;
192
+ /**
193
+ * 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.
194
+ * @summary List Dv Workflow Uploaders Handler
195
+ * @param {string} [usernameLike] Case-insensitive substring of the first or last name
196
+ * @param {number} [limit] Number of items per page
197
+ * @param {number} [offset] Number of items to skip
198
+ * @param {*} [options] Override http request option.
199
+ * @throws {RequiredError}
200
+ * @memberof SystemJobsApiInterface
201
+ */
202
+ listDvWorkflowUploadersRaw(requestParameters: ListDvWorkflowUploadersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseUserInfo>>;
203
+ /**
204
+ * 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.
205
+ * List Dv Workflow Uploaders Handler
206
+ */
207
+ listDvWorkflowUploaders(requestParameters: ListDvWorkflowUploadersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseUserInfo>;
145
208
  /**
146
209
  * Creates request options for listDvWorkflows without sending the request
147
210
  * @param {number} [limit] Number of items per page
148
211
  * @param {number} [offset] Number of items to skip
212
+ * @param {SortDirection} [sortDir] Sort direction (ASC or DESC); overrides the field\&#39;s natural default. Every sort field supports both directions.
213
+ * @param {Array<PipelineStatus>} [status] Only versions in one of these pipeline statuses
214
+ * @param {string} [nameLike] Case-insensitive substring filter on document name
215
+ * @param {boolean} [latestVersionOnly] Skip versions superseded by a newer version
216
+ * @param {string} [uploaderUserId] Filter to versions uploaded by this user
217
+ * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
218
+ * @param {Date} [createdBefore] Only items created strictly before this timestamp
219
+ * @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
220
+ * @param {Date} [updatedBefore] Only items updated strictly before this timestamp
149
221
  * @throws {RequiredError}
150
222
  * @memberof SystemJobsApiInterface
151
223
  */
152
224
  listDvWorkflowsRequestOpts(requestParameters: ListDvWorkflowsRequest): Promise<runtime.RequestOpts>;
153
225
  /**
154
- * List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
226
+ * 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.
155
227
  * @summary List Dv Workflows Handler
156
228
  * @param {number} [limit] Number of items per page
157
229
  * @param {number} [offset] Number of items to skip
230
+ * @param {SortDirection} [sortDir] Sort direction (ASC or DESC); overrides the field\&#39;s natural default. Every sort field supports both directions.
231
+ * @param {Array<PipelineStatus>} [status] Only versions in one of these pipeline statuses
232
+ * @param {string} [nameLike] Case-insensitive substring filter on document name
233
+ * @param {boolean} [latestVersionOnly] Skip versions superseded by a newer version
234
+ * @param {string} [uploaderUserId] Filter to versions uploaded by this user
235
+ * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
236
+ * @param {Date} [createdBefore] Only items created strictly before this timestamp
237
+ * @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
238
+ * @param {Date} [updatedBefore] Only items updated strictly before this timestamp
158
239
  * @param {*} [options] Override http request option.
159
240
  * @throws {RequiredError}
160
241
  * @memberof SystemJobsApiInterface
161
242
  */
162
243
  listDvWorkflowsRaw(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
163
244
  /**
164
- * List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
245
+ * 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.
165
246
  * List Dv Workflows Handler
166
247
  */
167
248
  listDvWorkflows(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
@@ -170,17 +251,31 @@ export interface SystemJobsApiInterface {
170
251
  *
171
252
  */
172
253
  export declare class SystemJobsApi extends runtime.BaseAPI implements SystemJobsApiInterface {
254
+ /**
255
+ * Creates request options for bulkRerunDvWorkflows without sending the request
256
+ */
257
+ bulkRerunDvWorkflowsRequestOpts(requestParameters: BulkRerunDvWorkflowsRequest): Promise<runtime.RequestOpts>;
258
+ /**
259
+ * 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.
260
+ * Bulk Rerun Dv Workflows Handler
261
+ */
262
+ bulkRerunDvWorkflowsRaw(requestParameters: BulkRerunDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkOperationResponse>>;
263
+ /**
264
+ * 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.
265
+ * Bulk Rerun Dv Workflows Handler
266
+ */
267
+ bulkRerunDvWorkflows(requestParameters: BulkRerunDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkOperationResponse>;
173
268
  /**
174
269
  * Creates request options for cancelTemporalWorkflow without sending the request
175
270
  */
176
271
  cancelTemporalWorkflowRequestOpts(requestParameters: CancelTemporalWorkflowRequest): Promise<runtime.RequestOpts>;
177
272
  /**
178
- * 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.
273
+ * 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.
179
274
  * Cancel Temporal Workflow Handler
180
275
  */
181
276
  cancelTemporalWorkflowRaw(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCancelResponse>>;
182
277
  /**
183
- * 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.
278
+ * 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.
184
279
  * Cancel Temporal Workflow Handler
185
280
  */
186
281
  cancelTemporalWorkflow(requestParameters: CancelTemporalWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCancelResponse>;
@@ -189,12 +284,12 @@ export declare class SystemJobsApi extends runtime.BaseAPI implements SystemJobs
189
284
  */
190
285
  dvWorkflowRerunRequestOpts(requestParameters: DvWorkflowRerunRequest): Promise<runtime.RequestOpts>;
191
286
  /**
192
- * 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.
287
+ * 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.
193
288
  * Dv Workflow Rerun Handler
194
289
  */
195
290
  dvWorkflowRerunRaw(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>>;
196
291
  /**
197
- * 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.
292
+ * 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.
198
293
  * Dv Workflow Rerun Handler
199
294
  */
200
295
  dvWorkflowRerun(requestParameters: DvWorkflowRerunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowActionResponse>;
@@ -231,26 +326,40 @@ export declare class SystemJobsApi extends runtime.BaseAPI implements SystemJobs
231
326
  */
232
327
  getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
233
328
  /**
234
- * 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.
329
+ * 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.
235
330
  * Get Zip Ingestion Status Handler
236
331
  */
237
332
  getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
238
333
  /**
239
- * 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.
240
335
  * Get Zip Ingestion Status Handler
241
336
  */
242
337
  getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
338
+ /**
339
+ * Creates request options for listDvWorkflowUploaders without sending the request
340
+ */
341
+ listDvWorkflowUploadersRequestOpts(requestParameters: ListDvWorkflowUploadersRequest): Promise<runtime.RequestOpts>;
342
+ /**
343
+ * 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.
344
+ * List Dv Workflow Uploaders Handler
345
+ */
346
+ listDvWorkflowUploadersRaw(requestParameters: ListDvWorkflowUploadersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseUserInfo>>;
347
+ /**
348
+ * 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.
349
+ * List Dv Workflow Uploaders Handler
350
+ */
351
+ listDvWorkflowUploaders(requestParameters?: ListDvWorkflowUploadersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseUserInfo>;
243
352
  /**
244
353
  * Creates request options for listDvWorkflows without sending the request
245
354
  */
246
355
  listDvWorkflowsRequestOpts(requestParameters: ListDvWorkflowsRequest): Promise<runtime.RequestOpts>;
247
356
  /**
248
- * List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
357
+ * 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.
249
358
  * List Dv Workflows Handler
250
359
  */
251
360
  listDvWorkflowsRaw(requestParameters: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>>;
252
361
  /**
253
- * List all workflows for the current tenant (paginated, DB-backed). ADMIN/OWNER see all workflows; USER sees only those under permitted paths.
362
+ * 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.
254
363
  * List Dv Workflows Handler
255
364
  */
256
365
  listDvWorkflows(requestParameters?: ListDvWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;