@knowledge-stack/ksapi 1.123.2 → 1.124.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.
- package/README.md +2 -2
- package/dist/apis/FoldersApi.d.ts +14 -5
- package/dist/apis/FoldersApi.js +11 -2
- package/dist/apis/WorkflowRunsApi.d.ts +17 -8
- package/dist/apis/WorkflowRunsApi.js +13 -4
- package/dist/esm/apis/FoldersApi.d.ts +14 -5
- package/dist/esm/apis/FoldersApi.js +11 -2
- package/dist/esm/apis/WorkflowRunsApi.d.ts +17 -8
- package/dist/esm/apis/WorkflowRunsApi.js +13 -4
- package/docs/FoldersApi.md +11 -2
- package/docs/WorkflowRunsApi.md +14 -5
- package/package.json +1 -1
- package/src/apis/FoldersApi.ts +28 -4
- package/src/apis/WorkflowRunsApi.ts +33 -9
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.
|
|
1
|
+
# @knowledge-stack/ksapi@1.124.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -616,7 +616,7 @@ and is automatically generated by the
|
|
|
616
616
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
617
617
|
|
|
618
618
|
- API version: `0.1.0`
|
|
619
|
-
- Package version: `1.
|
|
619
|
+
- Package version: `1.124.0`
|
|
620
620
|
- Generator version: `7.21.0`
|
|
621
621
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
622
622
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
13
|
+
import type { CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
14
14
|
export interface CreateFolderOperationRequest {
|
|
15
15
|
createFolderRequest: CreateFolderRequest;
|
|
16
16
|
}
|
|
@@ -32,6 +32,9 @@ export interface ListFolderContentsRequest {
|
|
|
32
32
|
withTags?: boolean;
|
|
33
33
|
limit?: number;
|
|
34
34
|
offset?: number;
|
|
35
|
+
approvalState?: Array<PathPartApprovalState> | null;
|
|
36
|
+
includeTagIds?: Array<string> | null;
|
|
37
|
+
excludeTagIds?: Array<string> | null;
|
|
35
38
|
}
|
|
36
39
|
export interface ListFoldersRequest {
|
|
37
40
|
parentPathPartId?: string | null;
|
|
@@ -161,12 +164,15 @@ export interface FoldersApiInterface {
|
|
|
161
164
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
162
165
|
* @param {number} [limit] Number of items per page
|
|
163
166
|
* @param {number} [offset] Number of items to skip
|
|
167
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
168
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
169
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
164
170
|
* @throws {RequiredError}
|
|
165
171
|
* @memberof FoldersApiInterface
|
|
166
172
|
*/
|
|
167
173
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
168
174
|
/**
|
|
169
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
175
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
170
176
|
* @summary List Folder Contents Handler
|
|
171
177
|
* @param {string} folderId
|
|
172
178
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
@@ -174,13 +180,16 @@ export interface FoldersApiInterface {
|
|
|
174
180
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
175
181
|
* @param {number} [limit] Number of items per page
|
|
176
182
|
* @param {number} [offset] Number of items to skip
|
|
183
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
184
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
185
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
177
186
|
* @param {*} [options] Override http request option.
|
|
178
187
|
* @throws {RequiredError}
|
|
179
188
|
* @memberof FoldersApiInterface
|
|
180
189
|
*/
|
|
181
190
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
182
191
|
/**
|
|
183
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
192
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
184
193
|
* List Folder Contents Handler
|
|
185
194
|
*/
|
|
186
195
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
|
@@ -345,12 +354,12 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
345
354
|
*/
|
|
346
355
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
347
356
|
/**
|
|
348
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
357
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
349
358
|
* List Folder Contents Handler
|
|
350
359
|
*/
|
|
351
360
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
352
361
|
/**
|
|
353
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
362
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
354
363
|
* List Folder Contents Handler
|
|
355
364
|
*/
|
|
356
365
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
package/dist/apis/FoldersApi.js
CHANGED
|
@@ -285,6 +285,15 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
285
285
|
if (requestParameters['offset'] != null) {
|
|
286
286
|
queryParameters['offset'] = requestParameters['offset'];
|
|
287
287
|
}
|
|
288
|
+
if (requestParameters['approvalState'] != null) {
|
|
289
|
+
queryParameters['approval_state'] = requestParameters['approvalState'];
|
|
290
|
+
}
|
|
291
|
+
if (requestParameters['includeTagIds'] != null) {
|
|
292
|
+
queryParameters['include_tag_ids'] = requestParameters['includeTagIds'];
|
|
293
|
+
}
|
|
294
|
+
if (requestParameters['excludeTagIds'] != null) {
|
|
295
|
+
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
296
|
+
}
|
|
288
297
|
const headerParameters = {};
|
|
289
298
|
if (this.configuration && this.configuration.accessToken) {
|
|
290
299
|
const token = this.configuration.accessToken;
|
|
@@ -304,7 +313,7 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
304
313
|
});
|
|
305
314
|
}
|
|
306
315
|
/**
|
|
307
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
316
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
308
317
|
* List Folder Contents Handler
|
|
309
318
|
*/
|
|
310
319
|
listFolderContentsRaw(requestParameters, initOverrides) {
|
|
@@ -315,7 +324,7 @@ class FoldersApi extends runtime.BaseAPI {
|
|
|
315
324
|
});
|
|
316
325
|
}
|
|
317
326
|
/**
|
|
318
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
327
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
319
328
|
* List Folder Contents Handler
|
|
320
329
|
*/
|
|
321
330
|
listFolderContents(requestParameters, initOverrides) {
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, SetWorkflowRunApprovalRequest, SortDirection, StartWorkflowRunRequest, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
|
|
13
|
+
import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, PathPartApprovalState, SetWorkflowRunApprovalRequest, SortDirection, StartWorkflowRunRequest, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
|
|
14
14
|
export interface CloneWorkflowRunOperationRequest {
|
|
15
15
|
runId: string;
|
|
16
16
|
cloneWorkflowRunRequest: CloneWorkflowRunRequest;
|
|
@@ -29,7 +29,7 @@ export interface GetWorkflowRunsSummaryRequest {
|
|
|
29
29
|
export interface ListWorkflowRunsForTenantRequest {
|
|
30
30
|
state?: Array<WorkflowExecutionState> | null;
|
|
31
31
|
mine?: boolean;
|
|
32
|
-
|
|
32
|
+
approvableByMe?: boolean;
|
|
33
33
|
definitionId?: string | null;
|
|
34
34
|
ownerId?: string | null;
|
|
35
35
|
sortBy?: WorkflowRunOrder;
|
|
@@ -40,6 +40,9 @@ export interface ListWorkflowRunsForTenantRequest {
|
|
|
40
40
|
createdBefore?: Date | null;
|
|
41
41
|
updatedAfter?: Date | null;
|
|
42
42
|
updatedBefore?: Date | null;
|
|
43
|
+
approvalState?: Array<PathPartApprovalState> | null;
|
|
44
|
+
includeTagIds?: Array<string> | null;
|
|
45
|
+
excludeTagIds?: Array<string> | null;
|
|
43
46
|
}
|
|
44
47
|
export interface RetryWorkflowRunRequest {
|
|
45
48
|
runId: string;
|
|
@@ -162,7 +165,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
162
165
|
* Creates request options for listWorkflowRunsForTenant without sending the request
|
|
163
166
|
* @param {Array<WorkflowExecutionState>} [state] Keep only runs in these execution states (repeatable).
|
|
164
167
|
* @param {boolean} [mine] Only runs the caller created (owner). Overrides owner_id.
|
|
165
|
-
* @param {boolean} [
|
|
168
|
+
* @param {boolean} [approvableByMe] Only runs the caller may approve (approve-path scoped). Compose with approval_state=pending for the approval worklist.
|
|
166
169
|
* @param {string} [definitionId] Only runs under this workflow definition.
|
|
167
170
|
* @param {string} [ownerId] Only runs created by this user.
|
|
168
171
|
* @param {WorkflowRunOrder} [sortBy] Field to sort runs by (default: STARTED_AT)
|
|
@@ -173,16 +176,19 @@ export interface WorkflowRunsApiInterface {
|
|
|
173
176
|
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
174
177
|
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
175
178
|
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
179
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
180
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
181
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
176
182
|
* @throws {RequiredError}
|
|
177
183
|
* @memberof WorkflowRunsApiInterface
|
|
178
184
|
*/
|
|
179
185
|
listWorkflowRunsForTenantRequestOpts(requestParameters: ListWorkflowRunsForTenantRequest): Promise<runtime.RequestOpts>;
|
|
180
186
|
/**
|
|
181
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
187
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
182
188
|
* @summary List Workflow Runs For Tenant Handler
|
|
183
189
|
* @param {Array<WorkflowExecutionState>} [state] Keep only runs in these execution states (repeatable).
|
|
184
190
|
* @param {boolean} [mine] Only runs the caller created (owner). Overrides owner_id.
|
|
185
|
-
* @param {boolean} [
|
|
191
|
+
* @param {boolean} [approvableByMe] Only runs the caller may approve (approve-path scoped). Compose with approval_state=pending for the approval worklist.
|
|
186
192
|
* @param {string} [definitionId] Only runs under this workflow definition.
|
|
187
193
|
* @param {string} [ownerId] Only runs created by this user.
|
|
188
194
|
* @param {WorkflowRunOrder} [sortBy] Field to sort runs by (default: STARTED_AT)
|
|
@@ -193,13 +199,16 @@ export interface WorkflowRunsApiInterface {
|
|
|
193
199
|
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
194
200
|
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
195
201
|
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
202
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
203
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
204
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
196
205
|
* @param {*} [options] Override http request option.
|
|
197
206
|
* @throws {RequiredError}
|
|
198
207
|
* @memberof WorkflowRunsApiInterface
|
|
199
208
|
*/
|
|
200
209
|
listWorkflowRunsForTenantRaw(requestParameters: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowRunResponse>>;
|
|
201
210
|
/**
|
|
202
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
211
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
203
212
|
* List Workflow Runs For Tenant Handler
|
|
204
213
|
*/
|
|
205
214
|
listWorkflowRunsForTenant(requestParameters: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowRunResponse>;
|
|
@@ -399,12 +408,12 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
|
|
|
399
408
|
*/
|
|
400
409
|
listWorkflowRunsForTenantRequestOpts(requestParameters: ListWorkflowRunsForTenantRequest): Promise<runtime.RequestOpts>;
|
|
401
410
|
/**
|
|
402
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
411
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
403
412
|
* List Workflow Runs For Tenant Handler
|
|
404
413
|
*/
|
|
405
414
|
listWorkflowRunsForTenantRaw(requestParameters: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowRunResponse>>;
|
|
406
415
|
/**
|
|
407
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
416
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
408
417
|
* List Workflow Runs For Tenant Handler
|
|
409
418
|
*/
|
|
410
419
|
listWorkflowRunsForTenant(requestParameters?: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowRunResponse>;
|
|
@@ -271,8 +271,8 @@ class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
271
271
|
if (requestParameters['mine'] != null) {
|
|
272
272
|
queryParameters['mine'] = requestParameters['mine'];
|
|
273
273
|
}
|
|
274
|
-
if (requestParameters['
|
|
275
|
-
queryParameters['
|
|
274
|
+
if (requestParameters['approvableByMe'] != null) {
|
|
275
|
+
queryParameters['approvable_by_me'] = requestParameters['approvableByMe'];
|
|
276
276
|
}
|
|
277
277
|
if (requestParameters['definitionId'] != null) {
|
|
278
278
|
queryParameters['definition_id'] = requestParameters['definitionId'];
|
|
@@ -304,6 +304,15 @@ class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
304
304
|
if (requestParameters['updatedBefore'] != null) {
|
|
305
305
|
queryParameters['updated_before'] = requestParameters['updatedBefore'].toISOString();
|
|
306
306
|
}
|
|
307
|
+
if (requestParameters['approvalState'] != null) {
|
|
308
|
+
queryParameters['approval_state'] = requestParameters['approvalState'];
|
|
309
|
+
}
|
|
310
|
+
if (requestParameters['includeTagIds'] != null) {
|
|
311
|
+
queryParameters['include_tag_ids'] = requestParameters['includeTagIds'];
|
|
312
|
+
}
|
|
313
|
+
if (requestParameters['excludeTagIds'] != null) {
|
|
314
|
+
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
315
|
+
}
|
|
307
316
|
const headerParameters = {};
|
|
308
317
|
if (this.configuration && this.configuration.accessToken) {
|
|
309
318
|
const token = this.configuration.accessToken;
|
|
@@ -322,7 +331,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
322
331
|
});
|
|
323
332
|
}
|
|
324
333
|
/**
|
|
325
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
334
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
326
335
|
* List Workflow Runs For Tenant Handler
|
|
327
336
|
*/
|
|
328
337
|
listWorkflowRunsForTenantRaw(requestParameters, initOverrides) {
|
|
@@ -333,7 +342,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
333
342
|
});
|
|
334
343
|
}
|
|
335
344
|
/**
|
|
336
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
345
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
337
346
|
* List Workflow Runs For Tenant Handler
|
|
338
347
|
*/
|
|
339
348
|
listWorkflowRunsForTenant() {
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
13
|
+
import type { CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, PathPartApprovalState, SearchSortOrder, SearchablePartType, SortDirection, UpdateFolderRequest } from '../models/index';
|
|
14
14
|
export interface CreateFolderOperationRequest {
|
|
15
15
|
createFolderRequest: CreateFolderRequest;
|
|
16
16
|
}
|
|
@@ -32,6 +32,9 @@ export interface ListFolderContentsRequest {
|
|
|
32
32
|
withTags?: boolean;
|
|
33
33
|
limit?: number;
|
|
34
34
|
offset?: number;
|
|
35
|
+
approvalState?: Array<PathPartApprovalState> | null;
|
|
36
|
+
includeTagIds?: Array<string> | null;
|
|
37
|
+
excludeTagIds?: Array<string> | null;
|
|
35
38
|
}
|
|
36
39
|
export interface ListFoldersRequest {
|
|
37
40
|
parentPathPartId?: string | null;
|
|
@@ -161,12 +164,15 @@ export interface FoldersApiInterface {
|
|
|
161
164
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
162
165
|
* @param {number} [limit] Number of items per page
|
|
163
166
|
* @param {number} [offset] Number of items to skip
|
|
167
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
168
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
169
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
164
170
|
* @throws {RequiredError}
|
|
165
171
|
* @memberof FoldersApiInterface
|
|
166
172
|
*/
|
|
167
173
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
168
174
|
/**
|
|
169
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
175
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
170
176
|
* @summary List Folder Contents Handler
|
|
171
177
|
* @param {string} folderId
|
|
172
178
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
@@ -174,13 +180,16 @@ export interface FoldersApiInterface {
|
|
|
174
180
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
175
181
|
* @param {number} [limit] Number of items per page
|
|
176
182
|
* @param {number} [offset] Number of items to skip
|
|
183
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
184
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
185
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
177
186
|
* @param {*} [options] Override http request option.
|
|
178
187
|
* @throws {RequiredError}
|
|
179
188
|
* @memberof FoldersApiInterface
|
|
180
189
|
*/
|
|
181
190
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
182
191
|
/**
|
|
183
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
192
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
184
193
|
* List Folder Contents Handler
|
|
185
194
|
*/
|
|
186
195
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
|
@@ -345,12 +354,12 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
|
|
|
345
354
|
*/
|
|
346
355
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
347
356
|
/**
|
|
348
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
357
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
349
358
|
* List Folder Contents Handler
|
|
350
359
|
*/
|
|
351
360
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
352
361
|
/**
|
|
353
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
362
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
354
363
|
* List Folder Contents Handler
|
|
355
364
|
*/
|
|
356
365
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
|
@@ -249,6 +249,15 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
249
249
|
if (requestParameters['offset'] != null) {
|
|
250
250
|
queryParameters['offset'] = requestParameters['offset'];
|
|
251
251
|
}
|
|
252
|
+
if (requestParameters['approvalState'] != null) {
|
|
253
|
+
queryParameters['approval_state'] = requestParameters['approvalState'];
|
|
254
|
+
}
|
|
255
|
+
if (requestParameters['includeTagIds'] != null) {
|
|
256
|
+
queryParameters['include_tag_ids'] = requestParameters['includeTagIds'];
|
|
257
|
+
}
|
|
258
|
+
if (requestParameters['excludeTagIds'] != null) {
|
|
259
|
+
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
260
|
+
}
|
|
252
261
|
const headerParameters = {};
|
|
253
262
|
if (this.configuration && this.configuration.accessToken) {
|
|
254
263
|
const token = this.configuration.accessToken;
|
|
@@ -268,7 +277,7 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
268
277
|
});
|
|
269
278
|
}
|
|
270
279
|
/**
|
|
271
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
280
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
272
281
|
* List Folder Contents Handler
|
|
273
282
|
*/
|
|
274
283
|
listFolderContentsRaw(requestParameters, initOverrides) {
|
|
@@ -279,7 +288,7 @@ export class FoldersApi extends runtime.BaseAPI {
|
|
|
279
288
|
});
|
|
280
289
|
}
|
|
281
290
|
/**
|
|
282
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
291
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
283
292
|
* List Folder Contents Handler
|
|
284
293
|
*/
|
|
285
294
|
listFolderContents(requestParameters, initOverrides) {
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, SetWorkflowRunApprovalRequest, SortDirection, StartWorkflowRunRequest, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
|
|
13
|
+
import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, PathPartApprovalState, SetWorkflowRunApprovalRequest, SortDirection, StartWorkflowRunRequest, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
|
|
14
14
|
export interface CloneWorkflowRunOperationRequest {
|
|
15
15
|
runId: string;
|
|
16
16
|
cloneWorkflowRunRequest: CloneWorkflowRunRequest;
|
|
@@ -29,7 +29,7 @@ export interface GetWorkflowRunsSummaryRequest {
|
|
|
29
29
|
export interface ListWorkflowRunsForTenantRequest {
|
|
30
30
|
state?: Array<WorkflowExecutionState> | null;
|
|
31
31
|
mine?: boolean;
|
|
32
|
-
|
|
32
|
+
approvableByMe?: boolean;
|
|
33
33
|
definitionId?: string | null;
|
|
34
34
|
ownerId?: string | null;
|
|
35
35
|
sortBy?: WorkflowRunOrder;
|
|
@@ -40,6 +40,9 @@ export interface ListWorkflowRunsForTenantRequest {
|
|
|
40
40
|
createdBefore?: Date | null;
|
|
41
41
|
updatedAfter?: Date | null;
|
|
42
42
|
updatedBefore?: Date | null;
|
|
43
|
+
approvalState?: Array<PathPartApprovalState> | null;
|
|
44
|
+
includeTagIds?: Array<string> | null;
|
|
45
|
+
excludeTagIds?: Array<string> | null;
|
|
43
46
|
}
|
|
44
47
|
export interface RetryWorkflowRunRequest {
|
|
45
48
|
runId: string;
|
|
@@ -162,7 +165,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
162
165
|
* Creates request options for listWorkflowRunsForTenant without sending the request
|
|
163
166
|
* @param {Array<WorkflowExecutionState>} [state] Keep only runs in these execution states (repeatable).
|
|
164
167
|
* @param {boolean} [mine] Only runs the caller created (owner). Overrides owner_id.
|
|
165
|
-
* @param {boolean} [
|
|
168
|
+
* @param {boolean} [approvableByMe] Only runs the caller may approve (approve-path scoped). Compose with approval_state=pending for the approval worklist.
|
|
166
169
|
* @param {string} [definitionId] Only runs under this workflow definition.
|
|
167
170
|
* @param {string} [ownerId] Only runs created by this user.
|
|
168
171
|
* @param {WorkflowRunOrder} [sortBy] Field to sort runs by (default: STARTED_AT)
|
|
@@ -173,16 +176,19 @@ export interface WorkflowRunsApiInterface {
|
|
|
173
176
|
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
174
177
|
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
175
178
|
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
179
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
180
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
181
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
176
182
|
* @throws {RequiredError}
|
|
177
183
|
* @memberof WorkflowRunsApiInterface
|
|
178
184
|
*/
|
|
179
185
|
listWorkflowRunsForTenantRequestOpts(requestParameters: ListWorkflowRunsForTenantRequest): Promise<runtime.RequestOpts>;
|
|
180
186
|
/**
|
|
181
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
187
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
182
188
|
* @summary List Workflow Runs For Tenant Handler
|
|
183
189
|
* @param {Array<WorkflowExecutionState>} [state] Keep only runs in these execution states (repeatable).
|
|
184
190
|
* @param {boolean} [mine] Only runs the caller created (owner). Overrides owner_id.
|
|
185
|
-
* @param {boolean} [
|
|
191
|
+
* @param {boolean} [approvableByMe] Only runs the caller may approve (approve-path scoped). Compose with approval_state=pending for the approval worklist.
|
|
186
192
|
* @param {string} [definitionId] Only runs under this workflow definition.
|
|
187
193
|
* @param {string} [ownerId] Only runs created by this user.
|
|
188
194
|
* @param {WorkflowRunOrder} [sortBy] Field to sort runs by (default: STARTED_AT)
|
|
@@ -193,13 +199,16 @@ export interface WorkflowRunsApiInterface {
|
|
|
193
199
|
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
194
200
|
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
195
201
|
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
202
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
203
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
204
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
196
205
|
* @param {*} [options] Override http request option.
|
|
197
206
|
* @throws {RequiredError}
|
|
198
207
|
* @memberof WorkflowRunsApiInterface
|
|
199
208
|
*/
|
|
200
209
|
listWorkflowRunsForTenantRaw(requestParameters: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowRunResponse>>;
|
|
201
210
|
/**
|
|
202
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
211
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
203
212
|
* List Workflow Runs For Tenant Handler
|
|
204
213
|
*/
|
|
205
214
|
listWorkflowRunsForTenant(requestParameters: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowRunResponse>;
|
|
@@ -399,12 +408,12 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
|
|
|
399
408
|
*/
|
|
400
409
|
listWorkflowRunsForTenantRequestOpts(requestParameters: ListWorkflowRunsForTenantRequest): Promise<runtime.RequestOpts>;
|
|
401
410
|
/**
|
|
402
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
411
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
403
412
|
* List Workflow Runs For Tenant Handler
|
|
404
413
|
*/
|
|
405
414
|
listWorkflowRunsForTenantRaw(requestParameters: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowRunResponse>>;
|
|
406
415
|
/**
|
|
407
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
416
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
408
417
|
* List Workflow Runs For Tenant Handler
|
|
409
418
|
*/
|
|
410
419
|
listWorkflowRunsForTenant(requestParameters?: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowRunResponse>;
|
|
@@ -235,8 +235,8 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
235
235
|
if (requestParameters['mine'] != null) {
|
|
236
236
|
queryParameters['mine'] = requestParameters['mine'];
|
|
237
237
|
}
|
|
238
|
-
if (requestParameters['
|
|
239
|
-
queryParameters['
|
|
238
|
+
if (requestParameters['approvableByMe'] != null) {
|
|
239
|
+
queryParameters['approvable_by_me'] = requestParameters['approvableByMe'];
|
|
240
240
|
}
|
|
241
241
|
if (requestParameters['definitionId'] != null) {
|
|
242
242
|
queryParameters['definition_id'] = requestParameters['definitionId'];
|
|
@@ -268,6 +268,15 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
268
268
|
if (requestParameters['updatedBefore'] != null) {
|
|
269
269
|
queryParameters['updated_before'] = requestParameters['updatedBefore'].toISOString();
|
|
270
270
|
}
|
|
271
|
+
if (requestParameters['approvalState'] != null) {
|
|
272
|
+
queryParameters['approval_state'] = requestParameters['approvalState'];
|
|
273
|
+
}
|
|
274
|
+
if (requestParameters['includeTagIds'] != null) {
|
|
275
|
+
queryParameters['include_tag_ids'] = requestParameters['includeTagIds'];
|
|
276
|
+
}
|
|
277
|
+
if (requestParameters['excludeTagIds'] != null) {
|
|
278
|
+
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
279
|
+
}
|
|
271
280
|
const headerParameters = {};
|
|
272
281
|
if (this.configuration && this.configuration.accessToken) {
|
|
273
282
|
const token = this.configuration.accessToken;
|
|
@@ -286,7 +295,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
286
295
|
});
|
|
287
296
|
}
|
|
288
297
|
/**
|
|
289
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
298
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
290
299
|
* List Workflow Runs For Tenant Handler
|
|
291
300
|
*/
|
|
292
301
|
listWorkflowRunsForTenantRaw(requestParameters, initOverrides) {
|
|
@@ -297,7 +306,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
|
|
|
297
306
|
});
|
|
298
307
|
}
|
|
299
308
|
/**
|
|
300
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
309
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
301
310
|
* List Workflow Runs For Tenant Handler
|
|
302
311
|
*/
|
|
303
312
|
listWorkflowRunsForTenant() {
|
package/docs/FoldersApi.md
CHANGED
|
@@ -321,11 +321,11 @@ example().catch(console.error);
|
|
|
321
321
|
|
|
322
322
|
## listFolderContents
|
|
323
323
|
|
|
324
|
-
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset)
|
|
324
|
+
> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset, approvalState, includeTagIds, excludeTagIds)
|
|
325
325
|
|
|
326
326
|
List Folder Contents Handler
|
|
327
327
|
|
|
328
|
-
List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
328
|
+
List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
329
329
|
|
|
330
330
|
### Example
|
|
331
331
|
|
|
@@ -359,6 +359,12 @@ async function example() {
|
|
|
359
359
|
limit: 56,
|
|
360
360
|
// number | Number of items to skip (optional)
|
|
361
361
|
offset: 56,
|
|
362
|
+
// Array<PathPartApprovalState> | Keep only items in these approval states (repeatable): not_required, pending, approved. (optional)
|
|
363
|
+
approvalState: ...,
|
|
364
|
+
// Array<string> | Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance). (optional)
|
|
365
|
+
includeTagIds: ...,
|
|
366
|
+
// Array<string> | Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids. (optional)
|
|
367
|
+
excludeTagIds: ...,
|
|
362
368
|
} satisfies ListFolderContentsRequest;
|
|
363
369
|
|
|
364
370
|
try {
|
|
@@ -384,6 +390,9 @@ example().catch(console.error);
|
|
|
384
390
|
| **withTags** | `boolean` | Include tag IDs for each item (default: false) | [Optional] [Defaults to `false`] |
|
|
385
391
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
386
392
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
393
|
+
| **approvalState** | `Array<PathPartApprovalState>` | Keep only items in these approval states (repeatable): not_required, pending, approved. | [Optional] |
|
|
394
|
+
| **includeTagIds** | `Array<string>` | Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance). | [Optional] |
|
|
395
|
+
| **excludeTagIds** | `Array<string>` | Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids. | [Optional] |
|
|
387
396
|
|
|
388
397
|
### Return type
|
|
389
398
|
|
package/docs/WorkflowRunsApi.md
CHANGED
|
@@ -325,11 +325,11 @@ example().catch(console.error);
|
|
|
325
325
|
|
|
326
326
|
## listWorkflowRunsForTenant
|
|
327
327
|
|
|
328
|
-
> PaginatedResponseWorkflowRunResponse listWorkflowRunsForTenant(state, mine,
|
|
328
|
+
> PaginatedResponseWorkflowRunResponse listWorkflowRunsForTenant(state, mine, approvableByMe, definitionId, ownerId, sortBy, sortDir, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore, approvalState, includeTagIds, excludeTagIds)
|
|
329
329
|
|
|
330
330
|
List Workflow Runs For Tenant Handler
|
|
331
331
|
|
|
332
|
-
List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
332
|
+
List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
333
333
|
|
|
334
334
|
### Example
|
|
335
335
|
|
|
@@ -355,8 +355,8 @@ async function example() {
|
|
|
355
355
|
state: ...,
|
|
356
356
|
// boolean | Only runs the caller created (owner). Overrides owner_id. (optional)
|
|
357
357
|
mine: true,
|
|
358
|
-
// boolean | Only runs
|
|
359
|
-
|
|
358
|
+
// boolean | Only runs the caller may approve (approve-path scoped). Compose with approval_state=pending for the approval worklist. (optional)
|
|
359
|
+
approvableByMe: true,
|
|
360
360
|
// string | Only runs under this workflow definition. (optional)
|
|
361
361
|
definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
362
362
|
// string | Only runs created by this user. (optional)
|
|
@@ -377,6 +377,12 @@ async function example() {
|
|
|
377
377
|
updatedAfter: 2013-10-20T19:20:30+01:00,
|
|
378
378
|
// Date | Only items updated strictly before this timestamp (optional)
|
|
379
379
|
updatedBefore: 2013-10-20T19:20:30+01:00,
|
|
380
|
+
// Array<PathPartApprovalState> | Keep only items in these approval states (repeatable): not_required, pending, approved. (optional)
|
|
381
|
+
approvalState: ...,
|
|
382
|
+
// Array<string> | Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance). (optional)
|
|
383
|
+
includeTagIds: ...,
|
|
384
|
+
// Array<string> | Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids. (optional)
|
|
385
|
+
excludeTagIds: ...,
|
|
380
386
|
} satisfies ListWorkflowRunsForTenantRequest;
|
|
381
387
|
|
|
382
388
|
try {
|
|
@@ -398,7 +404,7 @@ example().catch(console.error);
|
|
|
398
404
|
|------------- | ------------- | ------------- | -------------|
|
|
399
405
|
| **state** | `Array<WorkflowExecutionState>` | Keep only runs in these execution states (repeatable). | [Optional] |
|
|
400
406
|
| **mine** | `boolean` | Only runs the caller created (owner). Overrides owner_id. | [Optional] [Defaults to `false`] |
|
|
401
|
-
| **
|
|
407
|
+
| **approvableByMe** | `boolean` | Only runs the caller may approve (approve-path scoped). Compose with approval_state=pending for the approval worklist. | [Optional] [Defaults to `false`] |
|
|
402
408
|
| **definitionId** | `string` | Only runs under this workflow definition. | [Optional] [Defaults to `undefined`] |
|
|
403
409
|
| **ownerId** | `string` | Only runs created by this user. | [Optional] [Defaults to `undefined`] |
|
|
404
410
|
| **sortBy** | `WorkflowRunOrder` | Field to sort runs by (default: STARTED_AT) | [Optional] [Defaults to `undefined`] [Enum: STARTED_AT, CREATED_AT, COMPLETED_AT] |
|
|
@@ -409,6 +415,9 @@ example().catch(console.error);
|
|
|
409
415
|
| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
410
416
|
| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
|
|
411
417
|
| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
418
|
+
| **approvalState** | `Array<PathPartApprovalState>` | Keep only items in these approval states (repeatable): not_required, pending, approved. | [Optional] |
|
|
419
|
+
| **includeTagIds** | `Array<string>` | Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance). | [Optional] |
|
|
420
|
+
| **excludeTagIds** | `Array<string>` | Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids. | [Optional] |
|
|
412
421
|
|
|
413
422
|
### Return type
|
|
414
423
|
|
package/package.json
CHANGED
package/src/apis/FoldersApi.ts
CHANGED
|
@@ -24,6 +24,7 @@ import type {
|
|
|
24
24
|
PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator,
|
|
25
25
|
PaginatedResponseFolderResponse,
|
|
26
26
|
PathOrder,
|
|
27
|
+
PathPartApprovalState,
|
|
27
28
|
SearchSortOrder,
|
|
28
29
|
SearchablePartType,
|
|
29
30
|
SortDirection,
|
|
@@ -48,6 +49,8 @@ import {
|
|
|
48
49
|
PaginatedResponseFolderResponseToJSON,
|
|
49
50
|
PathOrderFromJSON,
|
|
50
51
|
PathOrderToJSON,
|
|
52
|
+
PathPartApprovalStateFromJSON,
|
|
53
|
+
PathPartApprovalStateToJSON,
|
|
51
54
|
SearchSortOrderFromJSON,
|
|
52
55
|
SearchSortOrderToJSON,
|
|
53
56
|
SearchablePartTypeFromJSON,
|
|
@@ -83,6 +86,9 @@ export interface ListFolderContentsRequest {
|
|
|
83
86
|
withTags?: boolean;
|
|
84
87
|
limit?: number;
|
|
85
88
|
offset?: number;
|
|
89
|
+
approvalState?: Array<PathPartApprovalState> | null;
|
|
90
|
+
includeTagIds?: Array<string> | null;
|
|
91
|
+
excludeTagIds?: Array<string> | null;
|
|
86
92
|
}
|
|
87
93
|
|
|
88
94
|
export interface ListFoldersRequest {
|
|
@@ -228,13 +234,16 @@ export interface FoldersApiInterface {
|
|
|
228
234
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
229
235
|
* @param {number} [limit] Number of items per page
|
|
230
236
|
* @param {number} [offset] Number of items to skip
|
|
237
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
238
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
239
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
231
240
|
* @throws {RequiredError}
|
|
232
241
|
* @memberof FoldersApiInterface
|
|
233
242
|
*/
|
|
234
243
|
listFolderContentsRequestOpts(requestParameters: ListFolderContentsRequest): Promise<runtime.RequestOpts>;
|
|
235
244
|
|
|
236
245
|
/**
|
|
237
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
246
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
238
247
|
* @summary List Folder Contents Handler
|
|
239
248
|
* @param {string} folderId
|
|
240
249
|
* @param {number} [maxDepth] Maximum depth to traverse (1=direct children, default: 1)
|
|
@@ -242,6 +251,9 @@ export interface FoldersApiInterface {
|
|
|
242
251
|
* @param {boolean} [withTags] Include tag IDs for each item (default: false)
|
|
243
252
|
* @param {number} [limit] Number of items per page
|
|
244
253
|
* @param {number} [offset] Number of items to skip
|
|
254
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
255
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
256
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
245
257
|
* @param {*} [options] Override http request option.
|
|
246
258
|
* @throws {RequiredError}
|
|
247
259
|
* @memberof FoldersApiInterface
|
|
@@ -249,7 +261,7 @@ export interface FoldersApiInterface {
|
|
|
249
261
|
listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>>;
|
|
250
262
|
|
|
251
263
|
/**
|
|
252
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
264
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
253
265
|
* List Folder Contents Handler
|
|
254
266
|
*/
|
|
255
267
|
listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>;
|
|
@@ -634,6 +646,18 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
634
646
|
queryParameters['offset'] = requestParameters['offset'];
|
|
635
647
|
}
|
|
636
648
|
|
|
649
|
+
if (requestParameters['approvalState'] != null) {
|
|
650
|
+
queryParameters['approval_state'] = requestParameters['approvalState'];
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
if (requestParameters['includeTagIds'] != null) {
|
|
654
|
+
queryParameters['include_tag_ids'] = requestParameters['includeTagIds'];
|
|
655
|
+
}
|
|
656
|
+
|
|
657
|
+
if (requestParameters['excludeTagIds'] != null) {
|
|
658
|
+
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
659
|
+
}
|
|
660
|
+
|
|
637
661
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
638
662
|
|
|
639
663
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -657,7 +681,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
657
681
|
}
|
|
658
682
|
|
|
659
683
|
/**
|
|
660
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
684
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
661
685
|
* List Folder Contents Handler
|
|
662
686
|
*/
|
|
663
687
|
async listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator>> {
|
|
@@ -668,7 +692,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
|
|
|
668
692
|
}
|
|
669
693
|
|
|
670
694
|
/**
|
|
671
|
-
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
695
|
+
* List all contents (folders and documents) under a folder. Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\"). When with_tags=true, each item includes a tags field with the full tag objects. ``approval_state`` / ``include_tag_ids`` / ``exclude_tag_ids`` filter the result at the path_part layer: approval state on the item, tags matched by self-or-ancestor inheritance (include = OR, exclude wins). This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
|
|
672
696
|
* List Folder Contents Handler
|
|
673
697
|
*/
|
|
674
698
|
async listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator> {
|
|
@@ -19,6 +19,7 @@ import type {
|
|
|
19
19
|
ErrorResponse,
|
|
20
20
|
HTTPValidationError,
|
|
21
21
|
PaginatedResponseWorkflowRunResponse,
|
|
22
|
+
PathPartApprovalState,
|
|
22
23
|
SetWorkflowRunApprovalRequest,
|
|
23
24
|
SortDirection,
|
|
24
25
|
StartWorkflowRunRequest,
|
|
@@ -39,6 +40,8 @@ import {
|
|
|
39
40
|
HTTPValidationErrorToJSON,
|
|
40
41
|
PaginatedResponseWorkflowRunResponseFromJSON,
|
|
41
42
|
PaginatedResponseWorkflowRunResponseToJSON,
|
|
43
|
+
PathPartApprovalStateFromJSON,
|
|
44
|
+
PathPartApprovalStateToJSON,
|
|
42
45
|
SetWorkflowRunApprovalRequestFromJSON,
|
|
43
46
|
SetWorkflowRunApprovalRequestToJSON,
|
|
44
47
|
SortDirectionFromJSON,
|
|
@@ -83,7 +86,7 @@ export interface GetWorkflowRunsSummaryRequest {
|
|
|
83
86
|
export interface ListWorkflowRunsForTenantRequest {
|
|
84
87
|
state?: Array<WorkflowExecutionState> | null;
|
|
85
88
|
mine?: boolean;
|
|
86
|
-
|
|
89
|
+
approvableByMe?: boolean;
|
|
87
90
|
definitionId?: string | null;
|
|
88
91
|
ownerId?: string | null;
|
|
89
92
|
sortBy?: WorkflowRunOrder;
|
|
@@ -94,6 +97,9 @@ export interface ListWorkflowRunsForTenantRequest {
|
|
|
94
97
|
createdBefore?: Date | null;
|
|
95
98
|
updatedAfter?: Date | null;
|
|
96
99
|
updatedBefore?: Date | null;
|
|
100
|
+
approvalState?: Array<PathPartApprovalState> | null;
|
|
101
|
+
includeTagIds?: Array<string> | null;
|
|
102
|
+
excludeTagIds?: Array<string> | null;
|
|
97
103
|
}
|
|
98
104
|
|
|
99
105
|
export interface RetryWorkflowRunRequest {
|
|
@@ -235,7 +241,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
235
241
|
* Creates request options for listWorkflowRunsForTenant without sending the request
|
|
236
242
|
* @param {Array<WorkflowExecutionState>} [state] Keep only runs in these execution states (repeatable).
|
|
237
243
|
* @param {boolean} [mine] Only runs the caller created (owner). Overrides owner_id.
|
|
238
|
-
* @param {boolean} [
|
|
244
|
+
* @param {boolean} [approvableByMe] Only runs the caller may approve (approve-path scoped). Compose with approval_state=pending for the approval worklist.
|
|
239
245
|
* @param {string} [definitionId] Only runs under this workflow definition.
|
|
240
246
|
* @param {string} [ownerId] Only runs created by this user.
|
|
241
247
|
* @param {WorkflowRunOrder} [sortBy] Field to sort runs by (default: STARTED_AT)
|
|
@@ -246,17 +252,20 @@ export interface WorkflowRunsApiInterface {
|
|
|
246
252
|
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
247
253
|
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
248
254
|
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
255
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
256
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
257
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
249
258
|
* @throws {RequiredError}
|
|
250
259
|
* @memberof WorkflowRunsApiInterface
|
|
251
260
|
*/
|
|
252
261
|
listWorkflowRunsForTenantRequestOpts(requestParameters: ListWorkflowRunsForTenantRequest): Promise<runtime.RequestOpts>;
|
|
253
262
|
|
|
254
263
|
/**
|
|
255
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
264
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
256
265
|
* @summary List Workflow Runs For Tenant Handler
|
|
257
266
|
* @param {Array<WorkflowExecutionState>} [state] Keep only runs in these execution states (repeatable).
|
|
258
267
|
* @param {boolean} [mine] Only runs the caller created (owner). Overrides owner_id.
|
|
259
|
-
* @param {boolean} [
|
|
268
|
+
* @param {boolean} [approvableByMe] Only runs the caller may approve (approve-path scoped). Compose with approval_state=pending for the approval worklist.
|
|
260
269
|
* @param {string} [definitionId] Only runs under this workflow definition.
|
|
261
270
|
* @param {string} [ownerId] Only runs created by this user.
|
|
262
271
|
* @param {WorkflowRunOrder} [sortBy] Field to sort runs by (default: STARTED_AT)
|
|
@@ -267,6 +276,9 @@ export interface WorkflowRunsApiInterface {
|
|
|
267
276
|
* @param {Date} [createdBefore] Only items created strictly before this timestamp
|
|
268
277
|
* @param {Date} [updatedAfter] Only items updated at or after this timestamp (inclusive)
|
|
269
278
|
* @param {Date} [updatedBefore] Only items updated strictly before this timestamp
|
|
279
|
+
* @param {Array<PathPartApprovalState>} [approvalState] Keep only items in these approval states (repeatable): not_required, pending, approved.
|
|
280
|
+
* @param {Array<string>} [includeTagIds] Keep only items that carry at least one of these tags on the item itself or any ancestor folder (repeatable, OR / tag inheritance).
|
|
281
|
+
* @param {Array<string>} [excludeTagIds] Drop items that carry any of these tags on the item itself or any ancestor folder (repeatable). Takes precedence over include_tag_ids.
|
|
270
282
|
* @param {*} [options] Override http request option.
|
|
271
283
|
* @throws {RequiredError}
|
|
272
284
|
* @memberof WorkflowRunsApiInterface
|
|
@@ -274,7 +286,7 @@ export interface WorkflowRunsApiInterface {
|
|
|
274
286
|
listWorkflowRunsForTenantRaw(requestParameters: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowRunResponse>>;
|
|
275
287
|
|
|
276
288
|
/**
|
|
277
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
289
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
278
290
|
* List Workflow Runs For Tenant Handler
|
|
279
291
|
*/
|
|
280
292
|
listWorkflowRunsForTenant(requestParameters: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowRunResponse>;
|
|
@@ -681,8 +693,8 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
|
|
|
681
693
|
queryParameters['mine'] = requestParameters['mine'];
|
|
682
694
|
}
|
|
683
695
|
|
|
684
|
-
if (requestParameters['
|
|
685
|
-
queryParameters['
|
|
696
|
+
if (requestParameters['approvableByMe'] != null) {
|
|
697
|
+
queryParameters['approvable_by_me'] = requestParameters['approvableByMe'];
|
|
686
698
|
}
|
|
687
699
|
|
|
688
700
|
if (requestParameters['definitionId'] != null) {
|
|
@@ -725,6 +737,18 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
|
|
|
725
737
|
queryParameters['updated_before'] = (requestParameters['updatedBefore'] as any).toISOString();
|
|
726
738
|
}
|
|
727
739
|
|
|
740
|
+
if (requestParameters['approvalState'] != null) {
|
|
741
|
+
queryParameters['approval_state'] = requestParameters['approvalState'];
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
if (requestParameters['includeTagIds'] != null) {
|
|
745
|
+
queryParameters['include_tag_ids'] = requestParameters['includeTagIds'];
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
if (requestParameters['excludeTagIds'] != null) {
|
|
749
|
+
queryParameters['exclude_tag_ids'] = requestParameters['excludeTagIds'];
|
|
750
|
+
}
|
|
751
|
+
|
|
728
752
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
729
753
|
|
|
730
754
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -747,7 +771,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
|
|
|
747
771
|
}
|
|
748
772
|
|
|
749
773
|
/**
|
|
750
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
774
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
751
775
|
* List Workflow Runs For Tenant Handler
|
|
752
776
|
*/
|
|
753
777
|
async listWorkflowRunsForTenantRaw(requestParameters: ListWorkflowRunsForTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowRunResponse>> {
|
|
@@ -758,7 +782,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
|
|
|
758
782
|
}
|
|
759
783
|
|
|
760
784
|
/**
|
|
761
|
-
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, ``
|
|
785
|
+
* List runs across every workflow in the tenant, permission-scoped. The single spine behind the dashboard worklists — the FE composes its tabs from preset filters (``mine`` + ``state``, and the approval worklist ``approval_state=pending`` + ``approvable_by_me``). Visibility follows the same model as the per-definition list: OWNER/ADMIN see all; a USER sees runs under workflows they can read.
|
|
762
786
|
* List Workflow Runs For Tenant Handler
|
|
763
787
|
*/
|
|
764
788
|
async listWorkflowRunsForTenant(requestParameters: ListWorkflowRunsForTenantRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowRunResponse> {
|