@knowledge-stack/ksapi 3.3.1 → 3.5.0

package/.openapi-generator/FILES

@@ -441,6 +441,7 @@ docs/XlsxCellAnchorInputOrDocxParagraphAnchorInput.md
 docs/XlsxCellAnchorOutput.md
 docs/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.md
 docs/YidingConfig.md
+docs/YidingConfigChange.md
 docs/YidingCursor.md
 docs/ZipFileResult.md
 docs/ZipIngestionStatusResponse.md
@@ -887,6 +888,7 @@ src/models/XlsxCellAnchorInputOrDocxParagraphAnchorInput.ts
 src/models/XlsxCellAnchorOutput.ts
 src/models/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.ts
 src/models/YidingConfig.ts
+src/models/YidingConfigChange.ts
 src/models/YidingCursor.ts
 src/models/ZipFileResult.ts
 src/models/ZipIngestionStatusResponse.ts

package/README.md

@@ -1,4 +1,4 @@
-# @knowledge-stack/ksapi@3.3.1
+# @knowledge-stack/ksapi@3.5.0
 
 A TypeScript SDK client for the localhost API.
 
@@ -703,6 +703,7 @@ All URIs are relative to *http://localhost:8000*
 - [XlsxCellAnchorOutput](docs/XlsxCellAnchorOutput.md)
 - [XlsxCellAnchorOutputOrDocxParagraphAnchorOutput](docs/XlsxCellAnchorOutputOrDocxParagraphAnchorOutput.md)
 - [YidingConfig](docs/YidingConfig.md)
+- [YidingConfigChange](docs/YidingConfigChange.md)
 - [YidingCursor](docs/YidingCursor.md)
 - [ZipFileResult](docs/ZipFileResult.md)
 - [ZipIngestionStatusResponse](docs/ZipIngestionStatusResponse.md)
@@ -732,7 +733,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `0.1.0`
-- Package version: `3.3.1`
+- Package version: `3.5.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/WorkflowDefinitionsApi.d.ts

@@ -40,6 +40,7 @@ export interface ListWorkflowDefinitionsRequest {
     sortBy?: WorkflowDefinitionOrder;
     sortDir?: SortDirection;
     isTemplate?: boolean;
+    needsApproval?: boolean;
     limit?: number;
     offset?: number;
     createdAfter?: Date | null;
@@ -195,6 +196,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {WorkflowDefinitionOrder} [sortBy] Field to sort definitions by (default: CREATED_AT)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
      * @param {boolean} [isTemplate]
+     * @param {boolean} [needsApproval] Only definitions with a run awaiting approval.
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
@@ -215,6 +217,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {WorkflowDefinitionOrder} [sortBy] Field to sort definitions by (default: CREATED_AT)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
      * @param {boolean} [isTemplate]
+     * @param {boolean} [needsApproval] Only definitions with a run awaiting approval.
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)

package/dist/apis/WorkflowDefinitionsApi.js

@@ -359,6 +359,9 @@ class WorkflowDefinitionsApi extends runtime.BaseAPI {
             if (requestParameters['isTemplate'] != null) {
                 queryParameters['is_template'] = requestParameters['isTemplate'];
             }
+            if (requestParameters['needsApproval'] != null) {
+                queryParameters['needs_approval'] = requestParameters['needsApproval'];
+            }
             if (requestParameters['limit'] != null) {
                 queryParameters['limit'] = requestParameters['limit'];
             }

package/dist/esm/apis/WorkflowDefinitionsApi.d.ts

@@ -40,6 +40,7 @@ export interface ListWorkflowDefinitionsRequest {
     sortBy?: WorkflowDefinitionOrder;
     sortDir?: SortDirection;
     isTemplate?: boolean;
+    needsApproval?: boolean;
     limit?: number;
     offset?: number;
     createdAfter?: Date | null;
@@ -195,6 +196,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {WorkflowDefinitionOrder} [sortBy] Field to sort definitions by (default: CREATED_AT)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
      * @param {boolean} [isTemplate]
+     * @param {boolean} [needsApproval] Only definitions with a run awaiting approval.
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
@@ -215,6 +217,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {WorkflowDefinitionOrder} [sortBy] Field to sort definitions by (default: CREATED_AT)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
      * @param {boolean} [isTemplate]
+     * @param {boolean} [needsApproval] Only definitions with a run awaiting approval.
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)

package/dist/esm/apis/WorkflowDefinitionsApi.js

@@ -323,6 +323,9 @@ export class WorkflowDefinitionsApi extends runtime.BaseAPI {
             if (requestParameters['isTemplate'] != null) {
                 queryParameters['is_template'] = requestParameters['isTemplate'];
             }
+            if (requestParameters['needsApproval'] != null) {
+                queryParameters['needs_approval'] = requestParameters['needsApproval'];
+            }
             if (requestParameters['limit'] != null) {
                 queryParameters['limit'] = requestParameters['limit'];
             }

package/dist/esm/models/UpdateDataSourceRequest.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { YidingConfig } from './YidingConfig';
+import type { YidingConfigChange } from './YidingConfigChange';
 import type { YidingCursor } from './YidingCursor';
 import type { ConnectionConfig } from './ConnectionConfig';
 /**
@@ -45,11 +45,11 @@ export interface UpdateDataSourceRequest {
      */
     connectionConfig?: ConnectionConfig | null;
     /**
-     * Fresh YIDINGSYNC crawler config to replace the stored one (login, shop, start date, recurrence); rejected on a DIRECT connector. Changing ``cron`` re-arms the schedule. connection_config stays server-managed for YIDINGSYNC.
-     * @type {YidingConfig}
+     * What a YIDINGSYNC connector's crawler config may still change: the panel password and the crawl recurrence, each optional and each merged into the stored config rather than replacing it. Which shop and from when are fixed at creation. Rejected on a DIRECT connector. Changing ``cron`` re-arms the schedule. connection_config stays server-managed for YIDINGSYNC.
+     * @type {YidingConfigChange}
      * @memberof UpdateDataSourceRequest
      */
-    sourceConfig?: YidingConfig | null;
+    sourceConfig?: YidingConfigChange | null;
     /**
      * The crawl cursor, replaced whole. Written by the sync itself (the worker acts as the connector's owner) after each batch, so it records what has already been read. Moving it forward by hand makes the next run skip those days for good — the increment only re-scans what the cursor points at.
      * @type {YidingCursor}

package/dist/esm/models/UpdateDataSourceRequest.js

@@ -11,7 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { YidingConfigFromJSON, YidingConfigToJSON, } from './YidingConfig';
+import { YidingConfigChangeFromJSON, YidingConfigChangeToJSON, } from './YidingConfigChange';
 import { YidingCursorFromJSON, YidingCursorToJSON, } from './YidingCursor';
 import { ConnectionConfigFromJSON, ConnectionConfigToJSON, } from './ConnectionConfig';
 export const UpdateDataSourceRequestPropertyValidationAttributesMap = {
@@ -37,7 +37,7 @@ export function UpdateDataSourceRequestFromJSONTyped(json, ignoreDiscriminator)
         'name': json['name'] == null ? undefined : json['name'],
         'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
         'connectionConfig': json['connection_config'] == null ? undefined : ConnectionConfigFromJSON(json['connection_config']),
-        'sourceConfig': json['source_config'] == null ? undefined : YidingConfigFromJSON(json['source_config']),
+        'sourceConfig': json['source_config'] == null ? undefined : YidingConfigChangeFromJSON(json['source_config']),
         'syncState': json['sync_state'] == null ? undefined : YidingCursorFromJSON(json['sync_state']),
     };
 }
@@ -52,7 +52,7 @@ export function UpdateDataSourceRequestToJSONTyped(value, ignoreDiscriminator =
         'name': value['name'],
         'parent_path_part_id': value['parentPathPartId'],
         'connection_config': ConnectionConfigToJSON(value['connectionConfig']),
-        'source_config': YidingConfigToJSON(value['sourceConfig']),
+        'source_config': YidingConfigChangeToJSON(value['sourceConfig']),
         'sync_state': YidingCursorToJSON(value['syncState']),
     };
 }

package/dist/esm/models/YidingConfigChange.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface YidingConfigChange
+ */
+export interface YidingConfigChange {
+    /**
+     * Crawl recurrence, in the tenant's timezone
+     * @type {string}
+     * @memberof YidingConfigChange
+     */
+    cron?: string | null;
+    /**
+     * Write-only: omit it to keep the stored one
+     * @type {string}
+     * @memberof YidingConfigChange
+     */
+    password?: string | null;
+}
+export declare const YidingConfigChangePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the YidingConfigChange interface.
+ */
+export declare function instanceOfYidingConfigChange(value: object): value is YidingConfigChange;
+export declare function YidingConfigChangeFromJSON(json: any): YidingConfigChange;
+export declare function YidingConfigChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): YidingConfigChange;
+export declare function YidingConfigChangeToJSON(json: any): YidingConfigChange;
+export declare function YidingConfigChangeToJSONTyped(value?: YidingConfigChange | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/YidingConfigChange.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const YidingConfigChangePropertyValidationAttributesMap = {
+    password: {
+        minLength: 1,
+    },
+};
+/**
+ * Check if a given object implements the YidingConfigChange interface.
+ */
+export function instanceOfYidingConfigChange(value) {
+    return true;
+}
+export function YidingConfigChangeFromJSON(json) {
+    return YidingConfigChangeFromJSONTyped(json, false);
+}
+export function YidingConfigChangeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'cron': json['cron'] == null ? undefined : json['cron'],
+        'password': json['password'] == null ? undefined : json['password'],
+    };
+}
+export function YidingConfigChangeToJSON(json) {
+    return YidingConfigChangeToJSONTyped(json, false);
+}
+export function YidingConfigChangeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'cron': value['cron'],
+        'password': value['password'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -395,6 +395,7 @@ export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
 export * from './YidingConfig';
+export * from './YidingConfigChange';
 export * from './YidingCursor';
 export * from './ZipFileResult';
 export * from './ZipIngestionStatusResponse';

package/dist/esm/models/index.js

@@ -397,6 +397,7 @@ export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
 export * from './YidingConfig';
+export * from './YidingConfigChange';
 export * from './YidingCursor';
 export * from './ZipFileResult';
 export * from './ZipIngestionStatusResponse';

package/dist/models/UpdateDataSourceRequest.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { YidingConfig } from './YidingConfig';
+import type { YidingConfigChange } from './YidingConfigChange';
 import type { YidingCursor } from './YidingCursor';
 import type { ConnectionConfig } from './ConnectionConfig';
 /**
@@ -45,11 +45,11 @@ export interface UpdateDataSourceRequest {
      */
     connectionConfig?: ConnectionConfig | null;
     /**
-     * Fresh YIDINGSYNC crawler config to replace the stored one (login, shop, start date, recurrence); rejected on a DIRECT connector. Changing ``cron`` re-arms the schedule. connection_config stays server-managed for YIDINGSYNC.
-     * @type {YidingConfig}
+     * What a YIDINGSYNC connector's crawler config may still change: the panel password and the crawl recurrence, each optional and each merged into the stored config rather than replacing it. Which shop and from when are fixed at creation. Rejected on a DIRECT connector. Changing ``cron`` re-arms the schedule. connection_config stays server-managed for YIDINGSYNC.
+     * @type {YidingConfigChange}
      * @memberof UpdateDataSourceRequest
      */
-    sourceConfig?: YidingConfig | null;
+    sourceConfig?: YidingConfigChange | null;
     /**
      * The crawl cursor, replaced whole. Written by the sync itself (the worker acts as the connector's owner) after each batch, so it records what has already been read. Moving it forward by hand makes the next run skip those days for good — the increment only re-scans what the cursor points at.
      * @type {YidingCursor}

package/dist/models/UpdateDataSourceRequest.js

@@ -19,7 +19,7 @@ exports.UpdateDataSourceRequestFromJSON = UpdateDataSourceRequestFromJSON;
 exports.UpdateDataSourceRequestFromJSONTyped = UpdateDataSourceRequestFromJSONTyped;
 exports.UpdateDataSourceRequestToJSON = UpdateDataSourceRequestToJSON;
 exports.UpdateDataSourceRequestToJSONTyped = UpdateDataSourceRequestToJSONTyped;
-const YidingConfig_1 = require("./YidingConfig");
+const YidingConfigChange_1 = require("./YidingConfigChange");
 const YidingCursor_1 = require("./YidingCursor");
 const ConnectionConfig_1 = require("./ConnectionConfig");
 exports.UpdateDataSourceRequestPropertyValidationAttributesMap = {
@@ -45,7 +45,7 @@ function UpdateDataSourceRequestFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'] == null ? undefined : json['name'],
         'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
         'connectionConfig': json['connection_config'] == null ? undefined : (0, ConnectionConfig_1.ConnectionConfigFromJSON)(json['connection_config']),
-        'sourceConfig': json['source_config'] == null ? undefined : (0, YidingConfig_1.YidingConfigFromJSON)(json['source_config']),
+        'sourceConfig': json['source_config'] == null ? undefined : (0, YidingConfigChange_1.YidingConfigChangeFromJSON)(json['source_config']),
         'syncState': json['sync_state'] == null ? undefined : (0, YidingCursor_1.YidingCursorFromJSON)(json['sync_state']),
     };
 }
@@ -60,7 +60,7 @@ function UpdateDataSourceRequestToJSONTyped(value, ignoreDiscriminator = false)
         'name': value['name'],
         'parent_path_part_id': value['parentPathPartId'],
         'connection_config': (0, ConnectionConfig_1.ConnectionConfigToJSON)(value['connectionConfig']),
-        'source_config': (0, YidingConfig_1.YidingConfigToJSON)(value['sourceConfig']),
+        'source_config': (0, YidingConfigChange_1.YidingConfigChangeToJSON)(value['sourceConfig']),
         'sync_state': (0, YidingCursor_1.YidingCursorToJSON)(value['syncState']),
     };
 }

package/dist/models/YidingConfigChange.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface YidingConfigChange
+ */
+export interface YidingConfigChange {
+    /**
+     * Crawl recurrence, in the tenant's timezone
+     * @type {string}
+     * @memberof YidingConfigChange
+     */
+    cron?: string | null;
+    /**
+     * Write-only: omit it to keep the stored one
+     * @type {string}
+     * @memberof YidingConfigChange
+     */
+    password?: string | null;
+}
+export declare const YidingConfigChangePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the YidingConfigChange interface.
+ */
+export declare function instanceOfYidingConfigChange(value: object): value is YidingConfigChange;
+export declare function YidingConfigChangeFromJSON(json: any): YidingConfigChange;
+export declare function YidingConfigChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): YidingConfigChange;
+export declare function YidingConfigChangeToJSON(json: any): YidingConfigChange;
+export declare function YidingConfigChangeToJSONTyped(value?: YidingConfigChange | null, ignoreDiscriminator?: boolean): any;

package/dist/models/YidingConfigChange.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.YidingConfigChangePropertyValidationAttributesMap = void 0;
+exports.instanceOfYidingConfigChange = instanceOfYidingConfigChange;
+exports.YidingConfigChangeFromJSON = YidingConfigChangeFromJSON;
+exports.YidingConfigChangeFromJSONTyped = YidingConfigChangeFromJSONTyped;
+exports.YidingConfigChangeToJSON = YidingConfigChangeToJSON;
+exports.YidingConfigChangeToJSONTyped = YidingConfigChangeToJSONTyped;
+exports.YidingConfigChangePropertyValidationAttributesMap = {
+    password: {
+        minLength: 1,
+    },
+};
+/**
+ * Check if a given object implements the YidingConfigChange interface.
+ */
+function instanceOfYidingConfigChange(value) {
+    return true;
+}
+function YidingConfigChangeFromJSON(json) {
+    return YidingConfigChangeFromJSONTyped(json, false);
+}
+function YidingConfigChangeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'cron': json['cron'] == null ? undefined : json['cron'],
+        'password': json['password'] == null ? undefined : json['password'],
+    };
+}
+function YidingConfigChangeToJSON(json) {
+    return YidingConfigChangeToJSONTyped(json, false);
+}
+function YidingConfigChangeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'cron': value['cron'],
+        'password': value['password'],
+    };
+}

package/dist/models/index.d.ts

@@ -395,6 +395,7 @@ export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
 export * from './YidingConfig';
+export * from './YidingConfigChange';
 export * from './YidingCursor';
 export * from './ZipFileResult';
 export * from './ZipIngestionStatusResponse';

package/dist/models/index.js

@@ -413,6 +413,7 @@ __exportStar(require("./XlsxCellAnchorInputOrDocxParagraphAnchorInput"), exports
 __exportStar(require("./XlsxCellAnchorOutput"), exports);
 __exportStar(require("./XlsxCellAnchorOutputOrDocxParagraphAnchorOutput"), exports);
 __exportStar(require("./YidingConfig"), exports);
+__exportStar(require("./YidingConfigChange"), exports);
 __exportStar(require("./YidingCursor"), exports);
 __exportStar(require("./ZipFileResult"), exports);
 __exportStar(require("./ZipIngestionStatusResponse"), exports);

package/docs/UpdateDataSourceRequest.md

@@ -10,7 +10,7 @@ Name | Type
 `name` | string
 `parentPathPartId` | string
 `connectionConfig` | [ConnectionConfig](ConnectionConfig.md)
-`sourceConfig` | [YidingConfig](YidingConfig.md)
+`sourceConfig` | [YidingConfigChange](YidingConfigChange.md)
 `syncState` | [YidingCursor](YidingCursor.md)
 
 ## Example

package/docs/WorkflowDefinitionsApi.md

@@ -408,7 +408,7 @@ example().catch(console.error);
 
 ## listWorkflowDefinitions
 
-> PaginatedResponseWorkflowDefinitionResponse listWorkflowDefinitions(mine, search, sortBy, sortDir, isTemplate, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore, includeTagIds, excludeTagIds)
+> PaginatedResponseWorkflowDefinitionResponse listWorkflowDefinitions(mine, search, sortBy, sortDir, isTemplate, needsApproval, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore, includeTagIds, excludeTagIds)
 
 List Workflow Definitions Handler
 
@@ -442,6 +442,8 @@ async function example() {
     sortDir: ...,
     // boolean (optional)
     isTemplate: true,
+    // boolean | Only definitions with a run awaiting approval. (optional)
+    needsApproval: true,
     // number | Number of items per page (optional)
     limit: 56,
     // number | Number of items to skip (optional)
@@ -482,6 +484,7 @@ example().catch(console.error);
 | **sortBy** | `WorkflowDefinitionOrder` | Field to sort definitions by (default: CREATED_AT) | [Optional] [Defaults to `undefined`] [Enum: CREATED_AT, UPDATED_AT, NAME] |
 | **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
 | **isTemplate** | `boolean` |  | [Optional] [Defaults to `false`] |
+| **needsApproval** | `boolean` | Only definitions with a run awaiting approval. | [Optional] [Defaults to `false`] |
 | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
 | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
 | **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |

package/docs/YidingConfigChange.md

@@ -0,0 +1,36 @@
+
+# YidingConfigChange
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cron` | string
+`password` | string
+
+## Example
+
+```typescript
+import type { YidingConfigChange } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cron": null,
+  "password": null,
+} satisfies YidingConfigChange
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as YidingConfigChange
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "3.3.1",
+  "version": "3.5.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/WorkflowDefinitionsApi.ts

@@ -89,6 +89,7 @@ export interface ListWorkflowDefinitionsRequest {
     sortBy?: WorkflowDefinitionOrder;
     sortDir?: SortDirection;
     isTemplate?: boolean;
+    needsApproval?: boolean;
     limit?: number;
     offset?: number;
     createdAfter?: Date | null;
@@ -262,6 +263,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {WorkflowDefinitionOrder} [sortBy] Field to sort definitions by (default: CREATED_AT)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
      * @param {boolean} [isTemplate] 
+     * @param {boolean} [needsApproval] Only definitions with a run awaiting approval.
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
@@ -283,6 +285,7 @@ export interface WorkflowDefinitionsApiInterface {
      * @param {WorkflowDefinitionOrder} [sortBy] Field to sort definitions by (default: CREATED_AT)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
      * @param {boolean} [isTemplate] 
+     * @param {boolean} [needsApproval] Only definitions with a run awaiting approval.
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
@@ -725,6 +728,10 @@ export class WorkflowDefinitionsApi extends runtime.BaseAPI implements WorkflowD
             queryParameters['is_template'] = requestParameters['isTemplate'];
         }
 
+        if (requestParameters['needsApproval'] != null) {
+            queryParameters['needs_approval'] = requestParameters['needsApproval'];
+        }
+
         if (requestParameters['limit'] != null) {
             queryParameters['limit'] = requestParameters['limit'];
         }

package/src/models/UpdateDataSourceRequest.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { YidingConfig } from './YidingConfig';
+import type { YidingConfigChange } from './YidingConfigChange';
 import {
-    YidingConfigFromJSON,
-    YidingConfigFromJSONTyped,
-    YidingConfigToJSON,
-    YidingConfigToJSONTyped,
-} from './YidingConfig';
+    YidingConfigChangeFromJSON,
+    YidingConfigChangeFromJSONTyped,
+    YidingConfigChangeToJSON,
+    YidingConfigChangeToJSONTyped,
+} from './YidingConfigChange';
 import type { YidingCursor } from './YidingCursor';
 import {
     YidingCursorFromJSON,
@@ -68,11 +68,11 @@ export interface UpdateDataSourceRequest {
      */
     connectionConfig?: ConnectionConfig | null;
     /**
-     * Fresh YIDINGSYNC crawler config to replace the stored one (login, shop, start date, recurrence); rejected on a DIRECT connector. Changing ``cron`` re-arms the schedule. connection_config stays server-managed for YIDINGSYNC.
-     * @type {YidingConfig}
+     * What a YIDINGSYNC connector's crawler config may still change: the panel password and the crawl recurrence, each optional and each merged into the stored config rather than replacing it. Which shop and from when are fixed at creation. Rejected on a DIRECT connector. Changing ``cron`` re-arms the schedule. connection_config stays server-managed for YIDINGSYNC.
+     * @type {YidingConfigChange}
      * @memberof UpdateDataSourceRequest
      */
-    sourceConfig?: YidingConfig | null;
+    sourceConfig?: YidingConfigChange | null;
     /**
      * The crawl cursor, replaced whole. Written by the sync itself (the worker acts as the connector's owner) after each batch, so it records what has already been read. Moving it forward by hand makes the next run skip those days for good — the increment only re-scans what the cursor points at.
      * @type {YidingCursor}
@@ -122,7 +122,7 @@ export function UpdateDataSourceRequestFromJSONTyped(json: any, ignoreDiscrimina
         'name': json['name'] == null ? undefined : json['name'],
         'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
         'connectionConfig': json['connection_config'] == null ? undefined : ConnectionConfigFromJSON(json['connection_config']),
-        'sourceConfig': json['source_config'] == null ? undefined : YidingConfigFromJSON(json['source_config']),
+        'sourceConfig': json['source_config'] == null ? undefined : YidingConfigChangeFromJSON(json['source_config']),
         'syncState': json['sync_state'] == null ? undefined : YidingCursorFromJSON(json['sync_state']),
     };
 }
@@ -141,7 +141,7 @@ export function UpdateDataSourceRequestToJSONTyped(value?: UpdateDataSourceReque
         'name': value['name'],
         'parent_path_part_id': value['parentPathPartId'],
         'connection_config': ConnectionConfigToJSON(value['connectionConfig']),
-        'source_config': YidingConfigToJSON(value['sourceConfig']),
+        'source_config': YidingConfigChangeToJSON(value['sourceConfig']),
         'sync_state': YidingCursorToJSON(value['syncState']),
     };
 }

package/src/models/YidingConfigChange.ts

@@ -0,0 +1,93 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface YidingConfigChange
+ */
+export interface YidingConfigChange {
+    /**
+     * Crawl recurrence, in the tenant's timezone
+     * @type {string}
+     * @memberof YidingConfigChange
+     */
+    cron?: string | null;
+    /**
+     * Write-only: omit it to keep the stored one
+     * @type {string}
+     * @memberof YidingConfigChange
+     */
+    password?: string | null;
+}
+export const YidingConfigChangePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    password: {
+        minLength: 1,
+    },
+}
+
+
+/**
+ * Check if a given object implements the YidingConfigChange interface.
+ */
+export function instanceOfYidingConfigChange(value: object): value is YidingConfigChange {
+    return true;
+}
+
+export function YidingConfigChangeFromJSON(json: any): YidingConfigChange {
+    return YidingConfigChangeFromJSONTyped(json, false);
+}
+
+export function YidingConfigChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): YidingConfigChange {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'cron': json['cron'] == null ? undefined : json['cron'],
+        'password': json['password'] == null ? undefined : json['password'],
+    };
+}
+
+export function YidingConfigChangeToJSON(json: any): YidingConfigChange {
+    return YidingConfigChangeToJSONTyped(json, false);
+}
+
+export function YidingConfigChangeToJSONTyped(value?: YidingConfigChange | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'cron': value['cron'],
+        'password': value['password'],
+    };
+}
+

package/src/models/index.ts

@@ -397,6 +397,7 @@ export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
 export * from './YidingConfig';
+export * from './YidingConfigChange';
 export * from './YidingCursor';
 export * from './ZipFileResult';
 export * from './ZipIngestionStatusResponse';