@knowledge-stack/ksapi 3.2.1 → 3.3.0

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

@@ -9,6 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { SourceType } from './SourceType';
+import type { YidingConfig } from './YidingConfig';
 import type { ConnectionConfig } from './ConnectionConfig';
 import type { DataSourceEngine } from './DataSourceEngine';
 /**
@@ -29,18 +31,30 @@ export interface CreateDataSourceRequest {
      * @memberof CreateDataSourceRequest
      */
     parentPathPartId: string;
+    /**
+     *
+     * @type {SourceType}
+     * @memberof CreateDataSourceRequest
+     */
+    sourceType?: SourceType;
     /**
      *
      * @type {DataSourceEngine}
      * @memberof CreateDataSourceRequest
      */
-    engine: DataSourceEngine;
+    engine?: DataSourceEngine;
     /**
      *
      * @type {ConnectionConfig}
      * @memberof CreateDataSourceRequest
      */
-    connectionConfig: ConnectionConfig;
+    connectionConfig?: ConnectionConfig | null;
+    /**
+     *
+     * @type {YidingConfig}
+     * @memberof CreateDataSourceRequest
+     */
+    sourceConfig?: YidingConfig | null;
 }
 export declare const CreateDataSourceRequestPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/CreateDataSourceRequest.js

@@ -11,6 +11,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { SourceTypeFromJSON, SourceTypeToJSON, } from './SourceType';
+import { YidingConfigFromJSON, YidingConfigToJSON, } from './YidingConfig';
 import { ConnectionConfigFromJSON, ConnectionConfigToJSON, } from './ConnectionConfig';
 import { DataSourceEngineFromJSON, DataSourceEngineToJSON, } from './DataSourceEngine';
 export const CreateDataSourceRequestPropertyValidationAttributesMap = {
@@ -26,10 +28,6 @@ export function instanceOfCreateDataSourceRequest(value) {
         return false;
     if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined)
         return false;
-    if (!('engine' in value) || value['engine'] === undefined)
-        return false;
-    if (!('connectionConfig' in value) || value['connectionConfig'] === undefined)
-        return false;
     return true;
 }
 export function CreateDataSourceRequestFromJSON(json) {
@@ -42,8 +40,10 @@ export function CreateDataSourceRequestFromJSONTyped(json, ignoreDiscriminator)
     return {
         'name': json['name'],
         'parentPathPartId': json['parent_path_part_id'],
-        'engine': DataSourceEngineFromJSON(json['engine']),
-        'connectionConfig': ConnectionConfigFromJSON(json['connection_config']),
+        'sourceType': json['source_type'] == null ? undefined : SourceTypeFromJSON(json['source_type']),
+        'engine': json['engine'] == null ? undefined : DataSourceEngineFromJSON(json['engine']),
+        'connectionConfig': json['connection_config'] == null ? undefined : ConnectionConfigFromJSON(json['connection_config']),
+        'sourceConfig': json['source_config'] == null ? undefined : YidingConfigFromJSON(json['source_config']),
     };
 }
 export function CreateDataSourceRequestToJSON(json) {
@@ -56,7 +56,9 @@ export function CreateDataSourceRequestToJSONTyped(value, ignoreDiscriminator =
     return {
         'name': value['name'],
         'parent_path_part_id': value['parentPathPartId'],
+        'source_type': SourceTypeToJSON(value['sourceType']),
         'engine': DataSourceEngineToJSON(value['engine']),
         'connection_config': ConnectionConfigToJSON(value['connectionConfig']),
+        'source_config': YidingConfigToJSON(value['sourceConfig']),
     };
 }

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

@@ -9,15 +9,21 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ConnectionSummary } from './ConnectionSummary';
 import type { ItemPermissions } from './ItemPermissions';
+import type { SourceType } from './SourceType';
 import type { PathPartApprovalState } from './PathPartApprovalState';
+import type { SourceConfigSummary } from './SourceConfigSummary';
 import type { UserInfo } from './UserInfo';
 import type { DataSourceEngine } from './DataSourceEngine';
 /**
  * Connector response; a discriminated-union variant for folder listings.
  *
- * The ``connection_config`` (host/port/credentials) is intentionally
- * omitted — the password is write-only and never serialized back.
+ * The stored ``connection_config`` is never returned whole: the password is
+ * write-only and never serialized back. What it points at travels in
+ * ``connection_summary`` instead, which a YIDINGSYNC connector needs — the
+ * server generated those credentials, so this is the only place its owner ever
+ * sees which database the sync built.
  * @export
  * @interface DataSourceResponse
  */
@@ -70,6 +76,24 @@ export interface DataSourceResponse {
      * @memberof DataSourceResponse
      */
     engine: DataSourceEngine;
+    /**
+     *
+     * @type {SourceType}
+     * @memberof DataSourceResponse
+     */
+    sourceType: SourceType;
+    /**
+     * Where the connector points, without the password. Null on a YIDINGSYNC connector until provisioning has built its database, so polling this is how the UI learns the sync is ready.
+     * @type {ConnectionSummary}
+     * @memberof DataSourceResponse
+     */
+    connectionSummary?: ConnectionSummary | null;
+    /**
+     * A YIDINGSYNC connector's crawler config without the password: which shop, from when, and the crawl recurrence. Null on DIRECT.
+     * @type {SourceConfigSummary}
+     * @memberof DataSourceResponse
+     */
+    sourceConfig?: SourceConfigSummary | null;
     /**
      *
      * @type {PathPartApprovalState}

package/dist/esm/models/DataSourceResponse.js

@@ -11,8 +11,11 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ConnectionSummaryFromJSON, ConnectionSummaryToJSON, } from './ConnectionSummary';
 import { ItemPermissionsFromJSON, ItemPermissionsToJSON, } from './ItemPermissions';
+import { SourceTypeFromJSON, SourceTypeToJSON, } from './SourceType';
 import { PathPartApprovalStateFromJSON, PathPartApprovalStateToJSON, } from './PathPartApprovalState';
+import { SourceConfigSummaryFromJSON, SourceConfigSummaryToJSON, } from './SourceConfigSummary';
 import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
 import { DataSourceEngineFromJSON, DataSourceEngineToJSON, } from './DataSourceEngine';
 /**
@@ -40,6 +43,8 @@ export function instanceOfDataSourceResponse(value) {
         return false;
     if (!('engine' in value) || value['engine'] === undefined)
         return false;
+    if (!('sourceType' in value) || value['sourceType'] === undefined)
+        return false;
     if (!('approvalState' in value) || value['approvalState'] === undefined)
         return false;
     if (!('permissions' in value) || value['permissions'] === undefined)
@@ -66,6 +71,9 @@ export function DataSourceResponseFromJSONTyped(json, ignoreDiscriminator) {
         'tenantId': json['tenant_id'],
         'name': json['name'],
         'engine': DataSourceEngineFromJSON(json['engine']),
+        'sourceType': SourceTypeFromJSON(json['source_type']),
+        'connectionSummary': json['connection_summary'] == null ? undefined : ConnectionSummaryFromJSON(json['connection_summary']),
+        'sourceConfig': json['source_config'] == null ? undefined : SourceConfigSummaryFromJSON(json['source_config']),
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
         'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
         'permissions': ItemPermissionsFromJSON(json['permissions']),
@@ -89,6 +97,9 @@ export function DataSourceResponseToJSONTyped(value, ignoreDiscriminator = false
         'tenant_id': value['tenantId'],
         'name': value['name'],
         'engine': DataSourceEngineToJSON(value['engine']),
+        'source_type': SourceTypeToJSON(value['sourceType']),
+        'connection_summary': ConnectionSummaryToJSON(value['connectionSummary']),
+        'source_config': SourceConfigSummaryToJSON(value['sourceConfig']),
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
         'owner': UserInfoToJSON(value['owner']),
         'permissions': ItemPermissionsToJSON(value['permissions']),

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

@@ -0,0 +1,71 @@
+/**
+ * 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.
+ */
+/**
+ * A YIDINGSYNC connector's stored config, with the password left out.
+ * @export
+ * @interface SourceConfigSummary
+ */
+export interface SourceConfigSummary {
+    /**
+     * The account the crawler signs in to the panel as
+     * @type {string}
+     * @memberof SourceConfigSummary
+     */
+    username: string;
+    /**
+     * The panel's own id for the shop. Only the customer list is scoped by it — orders follow the logged-in account — but it answers a wrong one with a 500, so an empty value fails the crawl, not just that page.
+     * @type {string}
+     * @memberof SourceConfigSummary
+     */
+    businessId: string;
+    /**
+     * First dining day to sync; earlier orders are not fetched
+     * @type {Date}
+     * @memberof SourceConfigSummary
+     */
+    startDate: Date;
+    /**
+     * Crawl recurrence, in the tenant's timezone
+     * @type {string}
+     * @memberof SourceConfigSummary
+     */
+    cron: string;
+    /**
+     * Root of the YiDing admin panel the crawler signs in to
+     * @type {string}
+     * @memberof SourceConfigSummary
+     */
+    baseUrl?: string;
+}
+export declare const SourceConfigSummaryPropertyValidationAttributesMap: {
+    [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 SourceConfigSummary interface.
+ */
+export declare function instanceOfSourceConfigSummary(value: object): value is SourceConfigSummary;
+export declare function SourceConfigSummaryFromJSON(json: any): SourceConfigSummary;
+export declare function SourceConfigSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SourceConfigSummary;
+export declare function SourceConfigSummaryToJSON(json: any): SourceConfigSummary;
+export declare function SourceConfigSummaryToJSONTyped(value?: SourceConfigSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SourceConfigSummary.js

@@ -0,0 +1,71 @@
+/* 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 SourceConfigSummaryPropertyValidationAttributesMap = {
+    username: {
+        minLength: 1,
+    },
+    businessId: {
+        minLength: 1,
+    },
+    cron: {
+        minLength: 1,
+    },
+    baseUrl: {
+        maxLength: 2048,
+    },
+};
+/**
+ * Check if a given object implements the SourceConfigSummary interface.
+ */
+export function instanceOfSourceConfigSummary(value) {
+    if (!('username' in value) || value['username'] === undefined)
+        return false;
+    if (!('businessId' in value) || value['businessId'] === undefined)
+        return false;
+    if (!('startDate' in value) || value['startDate'] === undefined)
+        return false;
+    if (!('cron' in value) || value['cron'] === undefined)
+        return false;
+    return true;
+}
+export function SourceConfigSummaryFromJSON(json) {
+    return SourceConfigSummaryFromJSONTyped(json, false);
+}
+export function SourceConfigSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'username': json['username'],
+        'businessId': json['business_id'],
+        'startDate': (new Date(json['start_date'])),
+        'cron': json['cron'],
+        'baseUrl': json['base_url'] == null ? undefined : json['base_url'],
+    };
+}
+export function SourceConfigSummaryToJSON(json) {
+    return SourceConfigSummaryToJSONTyped(json, false);
+}
+export function SourceConfigSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'username': value['username'],
+        'business_id': value['businessId'],
+        'start_date': value['startDate'].toISOString().substring(0, 10),
+        'cron': value['cron'],
+        'base_url': value['baseUrl'],
+    };
+}

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

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+/**
+ * Extra connector config for data sync model direct connect or automatic login/copy method.
+ * @export
+ */
+export declare const SourceType: {
+    readonly Direct: 'DIRECT';
+    readonly Yidingsync: 'YIDINGSYNC';
+};
+export type SourceType = typeof SourceType[keyof typeof SourceType];
+export declare function instanceOfSourceType(value: any): boolean;
+export declare function SourceTypeFromJSON(json: any): SourceType;
+export declare function SourceTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SourceType;
+export declare function SourceTypeToJSON(value?: SourceType | null): any;
+export declare function SourceTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SourceType;

package/dist/esm/models/SourceType.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Extra connector config for data sync model direct connect or automatic login/copy method.
+ * @export
+ */
+export const SourceType = {
+    Direct: 'DIRECT',
+    Yidingsync: 'YIDINGSYNC'
+};
+export function instanceOfSourceType(value) {
+    for (const key in SourceType) {
+        if (Object.prototype.hasOwnProperty.call(SourceType, key)) {
+            if (SourceType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function SourceTypeFromJSON(json) {
+    return SourceTypeFromJSONTyped(json, false);
+}
+export function SourceTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function SourceTypeToJSON(value) {
+    return value;
+}
+export function SourceTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -9,6 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { YidingConfig } from './YidingConfig';
+import type { YidingCursor } from './YidingCursor';
 import type { ConnectionConfig } from './ConnectionConfig';
 /**
  * Rename, move, and/or re-credential a connector (PATCH). All optional.
@@ -42,6 +44,18 @@ export interface UpdateDataSourceRequest {
      * @memberof 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}
+     * @memberof UpdateDataSourceRequest
+     */
+    sourceConfig?: YidingConfig | 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}
+     * @memberof UpdateDataSourceRequest
+     */
+    syncState?: YidingCursor | null;
 }
 export declare const UpdateDataSourceRequestPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/UpdateDataSourceRequest.js

@@ -11,6 +11,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { YidingConfigFromJSON, YidingConfigToJSON, } from './YidingConfig';
+import { YidingCursorFromJSON, YidingCursorToJSON, } from './YidingCursor';
 import { ConnectionConfigFromJSON, ConnectionConfigToJSON, } from './ConnectionConfig';
 export const UpdateDataSourceRequestPropertyValidationAttributesMap = {
     name: {
@@ -35,6 +37,8 @@ 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']),
+        'syncState': json['sync_state'] == null ? undefined : YidingCursorFromJSON(json['sync_state']),
     };
 }
 export function UpdateDataSourceRequestToJSON(json) {
@@ -48,5 +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']),
+        'sync_state': YidingCursorToJSON(value['syncState']),
     };
 }

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

@@ -0,0 +1,77 @@
+/**
+ * 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.
+ */
+/**
+ * What a customer supplies for a YiDing sync: the summary plus the secret.
+ * @export
+ * @interface YidingConfig
+ */
+export interface YidingConfig {
+    /**
+     * The account the crawler signs in to the panel as
+     * @type {string}
+     * @memberof YidingConfig
+     */
+    username: string;
+    /**
+     * The panel's own id for the shop. Only the customer list is scoped by it — orders follow the logged-in account — but it answers a wrong one with a 500, so an empty value fails the crawl, not just that page.
+     * @type {string}
+     * @memberof YidingConfig
+     */
+    businessId: string;
+    /**
+     * First dining day to sync; earlier orders are not fetched
+     * @type {Date}
+     * @memberof YidingConfig
+     */
+    startDate: Date;
+    /**
+     * Crawl recurrence, in the tenant's timezone
+     * @type {string}
+     * @memberof YidingConfig
+     */
+    cron: string;
+    /**
+     * Root of the YiDing admin panel the crawler signs in to
+     * @type {string}
+     * @memberof YidingConfig
+     */
+    baseUrl?: string;
+    /**
+     * Write-only: the settings panel never reads it back
+     * @type {string}
+     * @memberof YidingConfig
+     */
+    password: string;
+}
+export declare const YidingConfigPropertyValidationAttributesMap: {
+    [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 YidingConfig interface.
+ */
+export declare function instanceOfYidingConfig(value: object): value is YidingConfig;
+export declare function YidingConfigFromJSON(json: any): YidingConfig;
+export declare function YidingConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): YidingConfig;
+export declare function YidingConfigToJSON(json: any): YidingConfig;
+export declare function YidingConfigToJSONTyped(value?: YidingConfig | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/YidingConfig.js

@@ -0,0 +1,78 @@
+/* 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 YidingConfigPropertyValidationAttributesMap = {
+    username: {
+        minLength: 1,
+    },
+    businessId: {
+        minLength: 1,
+    },
+    cron: {
+        minLength: 1,
+    },
+    baseUrl: {
+        maxLength: 2048,
+    },
+    password: {
+        minLength: 1,
+    },
+};
+/**
+ * Check if a given object implements the YidingConfig interface.
+ */
+export function instanceOfYidingConfig(value) {
+    if (!('username' in value) || value['username'] === undefined)
+        return false;
+    if (!('businessId' in value) || value['businessId'] === undefined)
+        return false;
+    if (!('startDate' in value) || value['startDate'] === undefined)
+        return false;
+    if (!('cron' in value) || value['cron'] === undefined)
+        return false;
+    if (!('password' in value) || value['password'] === undefined)
+        return false;
+    return true;
+}
+export function YidingConfigFromJSON(json) {
+    return YidingConfigFromJSONTyped(json, false);
+}
+export function YidingConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'username': json['username'],
+        'businessId': json['business_id'],
+        'startDate': (new Date(json['start_date'])),
+        'cron': json['cron'],
+        'baseUrl': json['base_url'] == null ? undefined : json['base_url'],
+        'password': json['password'],
+    };
+}
+export function YidingConfigToJSON(json) {
+    return YidingConfigToJSONTyped(json, false);
+}
+export function YidingConfigToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'username': value['username'],
+        'business_id': value['businessId'],
+        'start_date': value['startDate'].toISOString().substring(0, 10),
+        'cron': value['cron'],
+        'base_url': value['baseUrl'],
+        'password': value['password'],
+    };
+}