@knowledge-stack/ksapi 1.104.0 → 1.106.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 (44) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +4 -3
  3. package/dist/apis/WorkflowRunsApi.d.ts +15 -12
  4. package/dist/apis/WorkflowRunsApi.js +4 -2
  5. package/dist/esm/apis/WorkflowRunsApi.d.ts +15 -12
  6. package/dist/esm/apis/WorkflowRunsApi.js +5 -3
  7. package/dist/esm/models/DirectorySyncResponse.d.ts +30 -0
  8. package/dist/esm/models/DirectorySyncResponse.js +10 -0
  9. package/dist/esm/models/GroupResponse.d.ts +6 -0
  10. package/dist/esm/models/GroupResponse.js +2 -0
  11. package/dist/esm/models/MembershipResponse.d.ts +6 -0
  12. package/dist/esm/models/MembershipResponse.js +2 -0
  13. package/dist/esm/models/StartWorkflowRunRequest.d.ts +53 -0
  14. package/dist/esm/models/StartWorkflowRunRequest.js +46 -0
  15. package/dist/esm/models/WorkflowRunSnapshot.d.ts +6 -0
  16. package/dist/esm/models/WorkflowRunSnapshot.js +7 -1
  17. package/dist/esm/models/index.d.ts +1 -0
  18. package/dist/esm/models/index.js +1 -0
  19. package/dist/models/DirectorySyncResponse.d.ts +30 -0
  20. package/dist/models/DirectorySyncResponse.js +10 -0
  21. package/dist/models/GroupResponse.d.ts +6 -0
  22. package/dist/models/GroupResponse.js +2 -0
  23. package/dist/models/MembershipResponse.d.ts +6 -0
  24. package/dist/models/MembershipResponse.js +2 -0
  25. package/dist/models/StartWorkflowRunRequest.d.ts +53 -0
  26. package/dist/models/StartWorkflowRunRequest.js +54 -0
  27. package/dist/models/WorkflowRunSnapshot.d.ts +6 -0
  28. package/dist/models/WorkflowRunSnapshot.js +7 -1
  29. package/dist/models/index.d.ts +1 -0
  30. package/dist/models/index.js +1 -0
  31. package/docs/DirectorySyncResponse.md +10 -0
  32. package/docs/GroupResponse.md +2 -0
  33. package/docs/MembershipResponse.md +2 -0
  34. package/docs/StartWorkflowRunRequest.md +35 -0
  35. package/docs/WorkflowRunSnapshot.md +2 -0
  36. package/docs/WorkflowRunsApi.md +9 -6
  37. package/package.json +1 -1
  38. package/src/apis/WorkflowRunsApi.ts +20 -11
  39. package/src/models/DirectorySyncResponse.ts +40 -0
  40. package/src/models/GroupResponse.ts +8 -0
  41. package/src/models/MembershipResponse.ts +8 -0
  42. package/src/models/StartWorkflowRunRequest.ts +91 -0
  43. package/src/models/WorkflowRunSnapshot.ts +11 -0
  44. package/src/models/index.ts +1 -0
@@ -236,6 +236,7 @@ docs/SetApprovalStateRequest.md
236
236
  docs/SetWorkflowRunApprovalRequest.md
237
237
  docs/SignInRequest.md
238
238
  docs/SortDirection.md
239
+ docs/StartWorkflowRunRequest.md
239
240
  docs/StepInput.md
240
241
  docs/StepKind.md
241
242
  docs/StepOutput.md
@@ -577,6 +578,7 @@ src/models/SetApprovalStateRequest.ts
577
578
  src/models/SetWorkflowRunApprovalRequest.ts
578
579
  src/models/SignInRequest.ts
579
580
  src/models/SortDirection.ts
581
+ src/models/StartWorkflowRunRequest.ts
580
582
  src/models/StepInput.ts
581
583
  src/models/StepKind.ts
582
584
  src/models/StepOutput.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@1.104.0
1
+ # @knowledge-stack/ksapi@1.106.0
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -247,7 +247,7 @@ All URIs are relative to *http://localhost:8000*
247
247
  *WorkflowRunsApi* | [**listWorkflowRunsForTenant**](docs/WorkflowRunsApi.md#listworkflowrunsfortenant) | **GET** /v1/workflow-runs | List Workflow Runs For Tenant Handler
248
248
  *WorkflowRunsApi* | [**retryWorkflowRun**](docs/WorkflowRunsApi.md#retryworkflowrun) | **POST** /v1/workflow-runs/{run_id}/retry | Retry Workflow Run Handler
249
249
  *WorkflowRunsApi* | [**setWorkflowRunApproval**](docs/WorkflowRunsApi.md#setworkflowrunapprovaloperation) | **POST** /v1/workflow-runs/{run_id}/approval | Set Workflow Run Approval Handler
250
- *WorkflowRunsApi* | [**startWorkflowRun**](docs/WorkflowRunsApi.md#startworkflowrun) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler
250
+ *WorkflowRunsApi* | [**startWorkflowRun**](docs/WorkflowRunsApi.md#startworkflowrunoperation) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler
251
251
  *WorkflowRunsApi* | [**stopWorkflowRun**](docs/WorkflowRunsApi.md#stopworkflowrun) | **POST** /v1/workflow-runs/{run_id}/stop | Stop Workflow Run Handler
252
252
  *WorkflowRunsApi* | [**updateWorkflowRun**](docs/WorkflowRunsApi.md#updateworkflowrunoperation) | **PATCH** /v1/workflow-runs/{run_id} | Update Workflow Run Handler
253
253
  *WorkflowRunsApi* | [**workflowRunCallback**](docs/WorkflowRunsApi.md#workflowruncallbackoperation) | **POST** /v1/workflow-runs/{run_id}/callback | Workflow Run Callback Handler
@@ -473,6 +473,7 @@ All URIs are relative to *http://localhost:8000*
473
473
  - [SetWorkflowRunApprovalRequest](docs/SetWorkflowRunApprovalRequest.md)
474
474
  - [SignInRequest](docs/SignInRequest.md)
475
475
  - [SortDirection](docs/SortDirection.md)
476
+ - [StartWorkflowRunRequest](docs/StartWorkflowRunRequest.md)
476
477
  - [StepInput](docs/StepInput.md)
477
478
  - [StepKind](docs/StepKind.md)
478
479
  - [StepOutput](docs/StepOutput.md)
@@ -576,7 +577,7 @@ and is automatically generated by the
576
577
  [OpenAPI Generator](https://openapi-generator.tech) project:
577
578
 
578
579
  - API version: `0.1.0`
579
- - Package version: `1.104.0`
580
+ - Package version: `1.106.0`
580
581
  - Generator version: `7.21.0`
581
582
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
582
583
 
@@ -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, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
13
+ import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, 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;
@@ -48,8 +48,9 @@ export interface SetWorkflowRunApprovalOperationRequest {
48
48
  runId: string;
49
49
  setWorkflowRunApprovalRequest: SetWorkflowRunApprovalRequest;
50
50
  }
51
- export interface StartWorkflowRunRequest {
51
+ export interface StartWorkflowRunOperationRequest {
52
52
  runId: string;
53
+ startWorkflowRunRequest?: StartWorkflowRunRequest | null;
53
54
  }
54
55
  export interface StopWorkflowRunRequest {
55
56
  runId: string;
@@ -249,24 +250,26 @@ export interface WorkflowRunsApiInterface {
249
250
  /**
250
251
  * Creates request options for startWorkflowRun without sending the request
251
252
  * @param {string} runId
253
+ * @param {StartWorkflowRunRequest} [startWorkflowRunRequest]
252
254
  * @throws {RequiredError}
253
255
  * @memberof WorkflowRunsApiInterface
254
256
  */
255
- startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts>;
257
+ startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
256
258
  /**
257
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
259
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
258
260
  * @summary Start Workflow Run Handler
259
261
  * @param {string} runId
262
+ * @param {StartWorkflowRunRequest} [startWorkflowRunRequest]
260
263
  * @param {*} [options] Override http request option.
261
264
  * @throws {RequiredError}
262
265
  * @memberof WorkflowRunsApiInterface
263
266
  */
264
- startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
267
+ startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
265
268
  /**
266
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
269
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
267
270
  * Start Workflow Run Handler
268
271
  */
269
- startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
272
+ startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
270
273
  /**
271
274
  * Creates request options for stopWorkflowRun without sending the request
272
275
  * @param {string} runId
@@ -436,17 +439,17 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
436
439
  /**
437
440
  * Creates request options for startWorkflowRun without sending the request
438
441
  */
439
- startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts>;
442
+ startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
440
443
  /**
441
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
444
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
442
445
  * Start Workflow Run Handler
443
446
  */
444
- startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
447
+ startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
445
448
  /**
446
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
449
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
447
450
  * Start Workflow Run Handler
448
451
  */
449
- startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
452
+ startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
450
453
  /**
451
454
  * Creates request options for stopWorkflowRun without sending the request
452
455
  */
@@ -453,6 +453,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
453
453
  }
454
454
  const queryParameters = {};
455
455
  const headerParameters = {};
456
+ headerParameters['Content-Type'] = 'application/json';
456
457
  if (this.configuration && this.configuration.accessToken) {
457
458
  const token = this.configuration.accessToken;
458
459
  const tokenString = yield token("bearerAuth", []);
@@ -467,11 +468,12 @@ class WorkflowRunsApi extends runtime.BaseAPI {
467
468
  method: 'POST',
468
469
  headers: headerParameters,
469
470
  query: queryParameters,
471
+ body: (0, index_1.StartWorkflowRunRequestToJSON)(requestParameters['startWorkflowRunRequest']),
470
472
  };
471
473
  });
472
474
  }
473
475
  /**
474
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
476
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
475
477
  * Start Workflow Run Handler
476
478
  */
477
479
  startWorkflowRunRaw(requestParameters, initOverrides) {
@@ -482,7 +484,7 @@ class WorkflowRunsApi extends runtime.BaseAPI {
482
484
  });
483
485
  }
484
486
  /**
485
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
487
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
486
488
  * Start Workflow Run Handler
487
489
  */
488
490
  startWorkflowRun(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, UpdateWorkflowRunRequest, WorkflowCallbackResponse, WorkflowExecutionState, WorkflowRunCallbackRequest, WorkflowRunOrder, WorkflowRunResponse, WorkflowRunSummaryResponse } from '../models/index';
13
+ import type { CloneWorkflowRunRequest, PaginatedResponseWorkflowRunResponse, 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;
@@ -48,8 +48,9 @@ export interface SetWorkflowRunApprovalOperationRequest {
48
48
  runId: string;
49
49
  setWorkflowRunApprovalRequest: SetWorkflowRunApprovalRequest;
50
50
  }
51
- export interface StartWorkflowRunRequest {
51
+ export interface StartWorkflowRunOperationRequest {
52
52
  runId: string;
53
+ startWorkflowRunRequest?: StartWorkflowRunRequest | null;
53
54
  }
54
55
  export interface StopWorkflowRunRequest {
55
56
  runId: string;
@@ -249,24 +250,26 @@ export interface WorkflowRunsApiInterface {
249
250
  /**
250
251
  * Creates request options for startWorkflowRun without sending the request
251
252
  * @param {string} runId
253
+ * @param {StartWorkflowRunRequest} [startWorkflowRunRequest]
252
254
  * @throws {RequiredError}
253
255
  * @memberof WorkflowRunsApiInterface
254
256
  */
255
- startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts>;
257
+ startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
256
258
  /**
257
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
259
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
258
260
  * @summary Start Workflow Run Handler
259
261
  * @param {string} runId
262
+ * @param {StartWorkflowRunRequest} [startWorkflowRunRequest]
260
263
  * @param {*} [options] Override http request option.
261
264
  * @throws {RequiredError}
262
265
  * @memberof WorkflowRunsApiInterface
263
266
  */
264
- startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
267
+ startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
265
268
  /**
266
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
269
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
267
270
  * Start Workflow Run Handler
268
271
  */
269
- startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
272
+ startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
270
273
  /**
271
274
  * Creates request options for stopWorkflowRun without sending the request
272
275
  * @param {string} runId
@@ -436,17 +439,17 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
436
439
  /**
437
440
  * Creates request options for startWorkflowRun without sending the request
438
441
  */
439
- startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunRequest): Promise<runtime.RequestOpts>;
442
+ startWorkflowRunRequestOpts(requestParameters: StartWorkflowRunOperationRequest): Promise<runtime.RequestOpts>;
440
443
  /**
441
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
444
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
442
445
  * Start Workflow Run Handler
443
446
  */
444
- startWorkflowRunRaw(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
447
+ startWorkflowRunRaw(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
445
448
  /**
446
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
449
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
447
450
  * Start Workflow Run Handler
448
451
  */
449
- startWorkflowRun(requestParameters: StartWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
452
+ startWorkflowRun(requestParameters: StartWorkflowRunOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
450
453
  /**
451
454
  * Creates request options for stopWorkflowRun without sending the request
452
455
  */
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { CloneWorkflowRunRequestToJSON, PaginatedResponseWorkflowRunResponseFromJSON, SetWorkflowRunApprovalRequestToJSON, UpdateWorkflowRunRequestToJSON, WorkflowCallbackResponseFromJSON, WorkflowRunCallbackRequestToJSON, WorkflowRunResponseFromJSON, WorkflowRunSummaryResponseFromJSON, } from '../models/index';
24
+ import { CloneWorkflowRunRequestToJSON, PaginatedResponseWorkflowRunResponseFromJSON, SetWorkflowRunApprovalRequestToJSON, StartWorkflowRunRequestToJSON, UpdateWorkflowRunRequestToJSON, WorkflowCallbackResponseFromJSON, WorkflowRunCallbackRequestToJSON, WorkflowRunResponseFromJSON, WorkflowRunSummaryResponseFromJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -417,6 +417,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
417
417
  }
418
418
  const queryParameters = {};
419
419
  const headerParameters = {};
420
+ headerParameters['Content-Type'] = 'application/json';
420
421
  if (this.configuration && this.configuration.accessToken) {
421
422
  const token = this.configuration.accessToken;
422
423
  const tokenString = yield token("bearerAuth", []);
@@ -431,11 +432,12 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
431
432
  method: 'POST',
432
433
  headers: headerParameters,
433
434
  query: queryParameters,
435
+ body: StartWorkflowRunRequestToJSON(requestParameters['startWorkflowRunRequest']),
434
436
  };
435
437
  });
436
438
  }
437
439
  /**
438
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
440
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
439
441
  * Start Workflow Run Handler
440
442
  */
441
443
  startWorkflowRunRaw(requestParameters, initOverrides) {
@@ -446,7 +448,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
446
448
  });
447
449
  }
448
450
  /**
449
- * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live).
451
+ * Flip a NOT_STARTED run to IN_PROGRESS and dispatch its agent run. Idempotent on IN_PROGRESS (returns the row). Terminal states → 409. Inputs still ingesting or in a failed terminal state → 409. The snapshot is built at this point (KB DOCUMENTs resolve to active versions, uploaded DVs are walked from inputs/, KB FOLDERs stay live). The body is optional; ``user_message`` (when sent) is pinned into the snapshot and shown in the run thread (see ``StartWorkflowRunRequest``).
450
452
  * Start Workflow Run Handler
451
453
  */
452
454
  startWorkflowRun(requestParameters, initOverrides) {
@@ -45,6 +45,36 @@ export interface DirectorySyncResponse {
45
45
  * @memberof DirectorySyncResponse
46
46
  */
47
47
  usersSkipped?: number;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof DirectorySyncResponse
52
+ */
53
+ seatCapExcludedNum?: number;
54
+ /**
55
+ *
56
+ * @type {number}
57
+ * @memberof DirectorySyncResponse
58
+ */
59
+ groupsCreated?: number;
60
+ /**
61
+ *
62
+ * @type {number}
63
+ * @memberof DirectorySyncResponse
64
+ */
65
+ groupsUpdated?: number;
66
+ /**
67
+ *
68
+ * @type {number}
69
+ * @memberof DirectorySyncResponse
70
+ */
71
+ groupMembershipsAdded?: number;
72
+ /**
73
+ *
74
+ * @type {number}
75
+ * @memberof DirectorySyncResponse
76
+ */
77
+ groupMembershipsRemoved?: number;
48
78
  /**
49
79
  *
50
80
  * @type {Array<string>}
@@ -31,6 +31,11 @@ export function DirectorySyncResponseFromJSONTyped(json, ignoreDiscriminator) {
31
31
  'usersActivated': json['users_activated'] == null ? undefined : json['users_activated'],
32
32
  'usersDeactivated': json['users_deactivated'] == null ? undefined : json['users_deactivated'],
33
33
  'usersSkipped': json['users_skipped'] == null ? undefined : json['users_skipped'],
34
+ 'seatCapExcludedNum': json['seat_cap_excluded_num'] == null ? undefined : json['seat_cap_excluded_num'],
35
+ 'groupsCreated': json['groups_created'] == null ? undefined : json['groups_created'],
36
+ 'groupsUpdated': json['groups_updated'] == null ? undefined : json['groups_updated'],
37
+ 'groupMembershipsAdded': json['group_memberships_added'] == null ? undefined : json['group_memberships_added'],
38
+ 'groupMembershipsRemoved': json['group_memberships_removed'] == null ? undefined : json['group_memberships_removed'],
34
39
  'warnings': json['warnings'] == null ? undefined : json['warnings'],
35
40
  'errors': json['errors'] == null ? undefined : json['errors'],
36
41
  };
@@ -48,6 +53,11 @@ export function DirectorySyncResponseToJSONTyped(value, ignoreDiscriminator = fa
48
53
  'users_activated': value['usersActivated'],
49
54
  'users_deactivated': value['usersDeactivated'],
50
55
  'users_skipped': value['usersSkipped'],
56
+ 'seat_cap_excluded_num': value['seatCapExcludedNum'],
57
+ 'groups_created': value['groupsCreated'],
58
+ 'groups_updated': value['groupsUpdated'],
59
+ 'group_memberships_added': value['groupMembershipsAdded'],
60
+ 'group_memberships_removed': value['groupMembershipsRemoved'],
51
61
  'warnings': value['warnings'],
52
62
  'errors': value['errors'],
53
63
  };
@@ -39,6 +39,12 @@ export interface GroupResponse {
39
39
  * @memberof GroupResponse
40
40
  */
41
41
  description: string | null;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof GroupResponse
46
+ */
47
+ idpGroupId?: string | null;
42
48
  /**
43
49
  *
44
50
  * @type {number}
@@ -42,6 +42,7 @@ export function GroupResponseFromJSONTyped(json, ignoreDiscriminator) {
42
42
  'tenantId': json['tenant_id'],
43
43
  'name': json['name'],
44
44
  'description': json['description'],
45
+ 'idpGroupId': json['idp_group_id'] == null ? undefined : json['idp_group_id'],
45
46
  'memberCount': json['member_count'] == null ? undefined : json['member_count'],
46
47
  'createdAt': (new Date(json['created_at'])),
47
48
  'updatedAt': (new Date(json['updated_at'])),
@@ -59,6 +60,7 @@ export function GroupResponseToJSONTyped(value, ignoreDiscriminator = false) {
59
60
  'tenant_id': value['tenantId'],
60
61
  'name': value['name'],
61
62
  'description': value['description'],
63
+ 'idp_group_id': value['idpGroupId'],
62
64
  'member_count': value['memberCount'],
63
65
  'created_at': value['createdAt'].toISOString(),
64
66
  'updated_at': value['updatedAt'].toISOString(),
@@ -39,6 +39,12 @@ export interface MembershipResponse {
39
39
  * @memberof MembershipResponse
40
40
  */
41
41
  userId: string;
42
+ /**
43
+ *
44
+ * @type {boolean}
45
+ * @memberof MembershipResponse
46
+ */
47
+ idpManaged?: boolean;
42
48
  /**
43
49
  *
44
50
  * @type {Date}
@@ -42,6 +42,7 @@ export function MembershipResponseFromJSONTyped(json, ignoreDiscriminator) {
42
42
  'tenantId': json['tenant_id'],
43
43
  'groupId': json['group_id'],
44
44
  'userId': json['user_id'],
45
+ 'idpManaged': json['idp_managed'] == null ? undefined : json['idp_managed'],
45
46
  'createdAt': (new Date(json['created_at'])),
46
47
  'updatedAt': (new Date(json['updated_at'])),
47
48
  };
@@ -58,6 +59,7 @@ export function MembershipResponseToJSONTyped(value, ignoreDiscriminator = false
58
59
  'tenant_id': value['tenantId'],
59
60
  'group_id': value['groupId'],
60
61
  'user_id': value['userId'],
62
+ 'idp_managed': value['idpManaged'],
61
63
  'created_at': value['createdAt'].toISOString(),
62
64
  'updated_at': value['updatedAt'].toISOString(),
63
65
  };
@@ -0,0 +1,53 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Optional JSON body for ``POST /v1/workflow-runs/{id}/start``.
14
+ *
15
+ * The whole body is optional: an absent body starts the run with just
16
+ * the localized "Started workflow: X" opening message, exactly as
17
+ * before. When ``user_message`` is set it is appended to that opening
18
+ * thread message AND injected into the runner's first user turn, so the
19
+ * agent acts on it as guidance layered on the workflow instruction.
20
+ * @export
21
+ * @interface StartWorkflowRunRequest
22
+ */
23
+ export interface StartWorkflowRunRequest {
24
+ /**
25
+ * Free-text instruction shown in the run thread and passed to the agent as additional guidance on top of the workflow instruction. Optional.
26
+ * @type {string}
27
+ * @memberof StartWorkflowRunRequest
28
+ */
29
+ userMessage?: string | null;
30
+ }
31
+ export declare const StartWorkflowRunRequestPropertyValidationAttributesMap: {
32
+ [property: string]: {
33
+ maxLength?: number;
34
+ minLength?: number;
35
+ pattern?: string;
36
+ maximum?: number;
37
+ exclusiveMaximum?: boolean;
38
+ minimum?: number;
39
+ exclusiveMinimum?: boolean;
40
+ multipleOf?: number;
41
+ maxItems?: number;
42
+ minItems?: number;
43
+ uniqueItems?: boolean;
44
+ };
45
+ };
46
+ /**
47
+ * Check if a given object implements the StartWorkflowRunRequest interface.
48
+ */
49
+ export declare function instanceOfStartWorkflowRunRequest(value: object): value is StartWorkflowRunRequest;
50
+ export declare function StartWorkflowRunRequestFromJSON(json: any): StartWorkflowRunRequest;
51
+ export declare function StartWorkflowRunRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): StartWorkflowRunRequest;
52
+ export declare function StartWorkflowRunRequestToJSON(json: any): StartWorkflowRunRequest;
53
+ export declare function StartWorkflowRunRequestToJSONTyped(value?: StartWorkflowRunRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,46 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
6
+ *
7
+ * The version of the OpenAPI document: 0.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const StartWorkflowRunRequestPropertyValidationAttributesMap = {
15
+ userMessage: {
16
+ maxLength: 4000,
17
+ },
18
+ };
19
+ /**
20
+ * Check if a given object implements the StartWorkflowRunRequest interface.
21
+ */
22
+ export function instanceOfStartWorkflowRunRequest(value) {
23
+ return true;
24
+ }
25
+ export function StartWorkflowRunRequestFromJSON(json) {
26
+ return StartWorkflowRunRequestFromJSONTyped(json, false);
27
+ }
28
+ export function StartWorkflowRunRequestFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return {
33
+ 'userMessage': json['user_message'] == null ? undefined : json['user_message'],
34
+ };
35
+ }
36
+ export function StartWorkflowRunRequestToJSON(json) {
37
+ return StartWorkflowRunRequestToJSONTyped(json, false);
38
+ }
39
+ export function StartWorkflowRunRequestToJSONTyped(value, ignoreDiscriminator = false) {
40
+ if (value == null) {
41
+ return value;
42
+ }
43
+ return {
44
+ 'user_message': value['userMessage'],
45
+ };
46
+ }
@@ -49,6 +49,12 @@ export interface WorkflowRunSnapshot {
49
49
  * @memberof WorkflowRunSnapshot
50
50
  */
51
51
  inputs: Array<InputSnapshot>;
52
+ /**
53
+ * Optional free-text message the caller supplied at Start. Pinned here so the runner injects it into the agent's first user turn and it survives retry, redrive, and workflow-thread follow-ups (all of which re-assemble the prompt from this snapshot).
54
+ * @type {string}
55
+ * @memberof WorkflowRunSnapshot
56
+ */
57
+ userMessage?: string | null;
52
58
  }
53
59
  export declare const WorkflowRunSnapshotPropertyValidationAttributesMap: {
54
60
  [property: string]: {
@@ -13,7 +13,11 @@
13
13
  */
14
14
  import { InputSnapshotFromJSON, InputSnapshotToJSON, } from './InputSnapshot';
15
15
  import { InstructionSnapshotFromJSON, InstructionSnapshotToJSON, } from './InstructionSnapshot';
16
- export const WorkflowRunSnapshotPropertyValidationAttributesMap = {};
16
+ export const WorkflowRunSnapshotPropertyValidationAttributesMap = {
17
+ userMessage: {
18
+ maxLength: 4000,
19
+ },
20
+ };
17
21
  /**
18
22
  * Check if a given object implements the WorkflowRunSnapshot interface.
19
23
  */
@@ -40,6 +44,7 @@ export function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
40
44
  'maxRunDurationSeconds': json['max_run_duration_seconds'],
41
45
  'instruction': InstructionSnapshotFromJSON(json['instruction']),
42
46
  'inputs': (json['inputs'].map(InputSnapshotFromJSON)),
47
+ 'userMessage': json['user_message'] == null ? undefined : json['user_message'],
43
48
  };
44
49
  }
45
50
  export function WorkflowRunSnapshotToJSON(json) {
@@ -54,5 +59,6 @@ export function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = fals
54
59
  'max_run_duration_seconds': value['maxRunDurationSeconds'],
55
60
  'instruction': InstructionSnapshotToJSON(value['instruction']),
56
61
  'inputs': (value['inputs'].map(InputSnapshotToJSON)),
62
+ 'user_message': value['userMessage'],
57
63
  };
58
64
  }
@@ -211,6 +211,7 @@ export * from './SetApprovalStateRequest';
211
211
  export * from './SetWorkflowRunApprovalRequest';
212
212
  export * from './SignInRequest';
213
213
  export * from './SortDirection';
214
+ export * from './StartWorkflowRunRequest';
214
215
  export * from './StepInput';
215
216
  export * from './StepKind';
216
217
  export * from './StepOutput';
@@ -213,6 +213,7 @@ export * from './SetApprovalStateRequest';
213
213
  export * from './SetWorkflowRunApprovalRequest';
214
214
  export * from './SignInRequest';
215
215
  export * from './SortDirection';
216
+ export * from './StartWorkflowRunRequest';
216
217
  export * from './StepInput';
217
218
  export * from './StepKind';
218
219
  export * from './StepOutput';
@@ -45,6 +45,36 @@ export interface DirectorySyncResponse {
45
45
  * @memberof DirectorySyncResponse
46
46
  */
47
47
  usersSkipped?: number;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof DirectorySyncResponse
52
+ */
53
+ seatCapExcludedNum?: number;
54
+ /**
55
+ *
56
+ * @type {number}
57
+ * @memberof DirectorySyncResponse
58
+ */
59
+ groupsCreated?: number;
60
+ /**
61
+ *
62
+ * @type {number}
63
+ * @memberof DirectorySyncResponse
64
+ */
65
+ groupsUpdated?: number;
66
+ /**
67
+ *
68
+ * @type {number}
69
+ * @memberof DirectorySyncResponse
70
+ */
71
+ groupMembershipsAdded?: number;
72
+ /**
73
+ *
74
+ * @type {number}
75
+ * @memberof DirectorySyncResponse
76
+ */
77
+ groupMembershipsRemoved?: number;
48
78
  /**
49
79
  *
50
80
  * @type {Array<string>}
@@ -39,6 +39,11 @@ function DirectorySyncResponseFromJSONTyped(json, ignoreDiscriminator) {
39
39
  'usersActivated': json['users_activated'] == null ? undefined : json['users_activated'],
40
40
  'usersDeactivated': json['users_deactivated'] == null ? undefined : json['users_deactivated'],
41
41
  'usersSkipped': json['users_skipped'] == null ? undefined : json['users_skipped'],
42
+ 'seatCapExcludedNum': json['seat_cap_excluded_num'] == null ? undefined : json['seat_cap_excluded_num'],
43
+ 'groupsCreated': json['groups_created'] == null ? undefined : json['groups_created'],
44
+ 'groupsUpdated': json['groups_updated'] == null ? undefined : json['groups_updated'],
45
+ 'groupMembershipsAdded': json['group_memberships_added'] == null ? undefined : json['group_memberships_added'],
46
+ 'groupMembershipsRemoved': json['group_memberships_removed'] == null ? undefined : json['group_memberships_removed'],
42
47
  'warnings': json['warnings'] == null ? undefined : json['warnings'],
43
48
  'errors': json['errors'] == null ? undefined : json['errors'],
44
49
  };
@@ -56,6 +61,11 @@ function DirectorySyncResponseToJSONTyped(value, ignoreDiscriminator = false) {
56
61
  'users_activated': value['usersActivated'],
57
62
  'users_deactivated': value['usersDeactivated'],
58
63
  'users_skipped': value['usersSkipped'],
64
+ 'seat_cap_excluded_num': value['seatCapExcludedNum'],
65
+ 'groups_created': value['groupsCreated'],
66
+ 'groups_updated': value['groupsUpdated'],
67
+ 'group_memberships_added': value['groupMembershipsAdded'],
68
+ 'group_memberships_removed': value['groupMembershipsRemoved'],
59
69
  'warnings': value['warnings'],
60
70
  'errors': value['errors'],
61
71
  };
@@ -39,6 +39,12 @@ export interface GroupResponse {
39
39
  * @memberof GroupResponse
40
40
  */
41
41
  description: string | null;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof GroupResponse
46
+ */
47
+ idpGroupId?: string | null;
42
48
  /**
43
49
  *
44
50
  * @type {number}