@knowledge-stack/ksapi 3.2.1 → 3.3.0

package/dist/esm/models/YidingCursor.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.
+ */
+/**
+ * How far a crawl has read; a missing mark means "never", not "day zero".
+ * @export
+ * @interface YidingCursor
+ */
+export interface YidingCursor {
+    /**
+     * Seating time of the last order read
+     * @type {Date}
+     * @memberof YidingCursor
+     */
+    lastSyncedOrderTs?: Date | null;
+    /**
+     * When the customer list was last refreshed
+     * @type {Date}
+     * @memberof YidingCursor
+     */
+    lastSyncedUserTs?: Date | null;
+}
+export declare const YidingCursorPropertyValidationAttributesMap: {
+    [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 YidingCursor interface.
+ */
+export declare function instanceOfYidingCursor(value: object): value is YidingCursor;
+export declare function YidingCursorFromJSON(json: any): YidingCursor;
+export declare function YidingCursorFromJSONTyped(json: any, ignoreDiscriminator: boolean): YidingCursor;
+export declare function YidingCursorToJSON(json: any): YidingCursor;
+export declare function YidingCursorToJSONTyped(value?: YidingCursor | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/YidingCursor.js

@@ -0,0 +1,44 @@
+/* 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 YidingCursorPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the YidingCursor interface.
+ */
+export function instanceOfYidingCursor(value) {
+    return true;
+}
+export function YidingCursorFromJSON(json) {
+    return YidingCursorFromJSONTyped(json, false);
+}
+export function YidingCursorFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'lastSyncedOrderTs': json['last_synced_order_ts'] == null ? undefined : (new Date(json['last_synced_order_ts'])),
+        'lastSyncedUserTs': json['last_synced_user_ts'] == null ? undefined : (new Date(json['last_synced_user_ts'])),
+    };
+}
+export function YidingCursorToJSON(json) {
+    return YidingCursorToJSONTyped(json, false);
+}
+export function YidingCursorToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'last_synced_order_ts': value['lastSyncedOrderTs'] == null ? value['lastSyncedOrderTs'] : value['lastSyncedOrderTs'].toISOString(),
+        'last_synced_user_ts': value['lastSyncedUserTs'] == null ? value['lastSyncedUserTs'] : value['lastSyncedUserTs'].toISOString(),
+    };
+}

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

@@ -66,6 +66,7 @@ export * from './ColumnReference';
 export * from './CommonFileExclusionReason';
 export * from './CompleteUploadRequest';
 export * from './ConnectionConfig';
+export * from './ConnectionSummary';
 export * from './ContentsSortOrder';
 export * from './CreateApiConnectionRequest';
 export * from './CreateApiKeyRequest';
@@ -289,6 +290,8 @@ export * from './SkillResponse';
 export * from './SkillSearchResult';
 export * from './SkillVersionResponse';
 export * from './SortDirection';
+export * from './SourceConfigSummary';
+export * from './SourceType';
 export * from './StartWorkflowRunRequest';
 export * from './Step';
 export * from './StepKind';
@@ -391,6 +394,8 @@ export * from './XlsxCellAnchorInput';
 export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
+export * from './YidingConfig';
+export * from './YidingCursor';
 export * from './ZipFileResult';
 export * from './ZipIngestionStatusResponse';
 export * from './ZipMemberStatusResponse';

package/dist/esm/models/index.js

@@ -68,6 +68,7 @@ export * from './ColumnReference';
 export * from './CommonFileExclusionReason';
 export * from './CompleteUploadRequest';
 export * from './ConnectionConfig';
+export * from './ConnectionSummary';
 export * from './ContentsSortOrder';
 export * from './CreateApiConnectionRequest';
 export * from './CreateApiKeyRequest';
@@ -291,6 +292,8 @@ export * from './SkillResponse';
 export * from './SkillSearchResult';
 export * from './SkillVersionResponse';
 export * from './SortDirection';
+export * from './SourceConfigSummary';
+export * from './SourceType';
 export * from './StartWorkflowRunRequest';
 export * from './Step';
 export * from './StepKind';
@@ -393,6 +396,8 @@ export * from './XlsxCellAnchorInput';
 export * from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
 export * from './XlsxCellAnchorOutput';
 export * from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
+export * from './YidingConfig';
+export * from './YidingCursor';
 export * from './ZipFileResult';
 export * from './ZipIngestionStatusResponse';
 export * from './ZipMemberStatusResponse';

package/dist/models/ConnectionSummary.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+/**
+ * Where a connector points, with the password left out.
+ * @export
+ * @interface ConnectionSummary
+ */
+export interface ConnectionSummary {
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionSummary
+     */
+    host: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConnectionSummary
+     */
+    port?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionSummary
+     */
+    database: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionSummary
+     */
+    username: string;
+}
+export declare const ConnectionSummaryPropertyValidationAttributesMap: {
+    [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 ConnectionSummary interface.
+ */
+export declare function instanceOfConnectionSummary(value: object): value is ConnectionSummary;
+export declare function ConnectionSummaryFromJSON(json: any): ConnectionSummary;
+export declare function ConnectionSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectionSummary;
+export declare function ConnectionSummaryToJSON(json: any): ConnectionSummary;
+export declare function ConnectionSummaryToJSONTyped(value?: ConnectionSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ConnectionSummary.js

@@ -0,0 +1,62 @@
+"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.ConnectionSummaryPropertyValidationAttributesMap = void 0;
+exports.instanceOfConnectionSummary = instanceOfConnectionSummary;
+exports.ConnectionSummaryFromJSON = ConnectionSummaryFromJSON;
+exports.ConnectionSummaryFromJSONTyped = ConnectionSummaryFromJSONTyped;
+exports.ConnectionSummaryToJSON = ConnectionSummaryToJSON;
+exports.ConnectionSummaryToJSONTyped = ConnectionSummaryToJSONTyped;
+exports.ConnectionSummaryPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ConnectionSummary interface.
+ */
+function instanceOfConnectionSummary(value) {
+    if (!('host' in value) || value['host'] === undefined)
+        return false;
+    if (!('database' in value) || value['database'] === undefined)
+        return false;
+    if (!('username' in value) || value['username'] === undefined)
+        return false;
+    return true;
+}
+function ConnectionSummaryFromJSON(json) {
+    return ConnectionSummaryFromJSONTyped(json, false);
+}
+function ConnectionSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'host': json['host'],
+        'port': json['port'] == null ? undefined : json['port'],
+        'database': json['database'],
+        'username': json['username'],
+    };
+}
+function ConnectionSummaryToJSON(json) {
+    return ConnectionSummaryToJSONTyped(json, false);
+}
+function ConnectionSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'host': value['host'],
+        'port': value['port'],
+        'database': value['database'],
+        'username': value['username'],
+    };
+}

package/dist/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/models/CreateDataSourceRequest.js

@@ -19,6 +19,8 @@ exports.CreateDataSourceRequestFromJSON = CreateDataSourceRequestFromJSON;
 exports.CreateDataSourceRequestFromJSONTyped = CreateDataSourceRequestFromJSONTyped;
 exports.CreateDataSourceRequestToJSON = CreateDataSourceRequestToJSON;
 exports.CreateDataSourceRequestToJSONTyped = CreateDataSourceRequestToJSONTyped;
+const SourceType_1 = require("./SourceType");
+const YidingConfig_1 = require("./YidingConfig");
 const ConnectionConfig_1 = require("./ConnectionConfig");
 const DataSourceEngine_1 = require("./DataSourceEngine");
 exports.CreateDataSourceRequestPropertyValidationAttributesMap = {
@@ -34,10 +36,6 @@ 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;
 }
 function CreateDataSourceRequestFromJSON(json) {
@@ -50,8 +48,10 @@ function CreateDataSourceRequestFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'name': json['name'],
         'parentPathPartId': json['parent_path_part_id'],
-        'engine': (0, DataSourceEngine_1.DataSourceEngineFromJSON)(json['engine']),
-        'connectionConfig': (0, ConnectionConfig_1.ConnectionConfigFromJSON)(json['connection_config']),
+        'sourceType': json['source_type'] == null ? undefined : (0, SourceType_1.SourceTypeFromJSON)(json['source_type']),
+        'engine': json['engine'] == null ? undefined : (0, DataSourceEngine_1.DataSourceEngineFromJSON)(json['engine']),
+        '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']),
     };
 }
 function CreateDataSourceRequestToJSON(json) {
@@ -64,7 +64,9 @@ function CreateDataSourceRequestToJSONTyped(value, ignoreDiscriminator = false)
     return {
         'name': value['name'],
         'parent_path_part_id': value['parentPathPartId'],
+        'source_type': (0, SourceType_1.SourceTypeToJSON)(value['sourceType']),
         'engine': (0, DataSourceEngine_1.DataSourceEngineToJSON)(value['engine']),
         'connection_config': (0, ConnectionConfig_1.ConnectionConfigToJSON)(value['connectionConfig']),
+        'source_config': (0, YidingConfig_1.YidingConfigToJSON)(value['sourceConfig']),
     };
 }

package/dist/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/models/DataSourceResponse.js

@@ -19,8 +19,11 @@ exports.DataSourceResponseFromJSON = DataSourceResponseFromJSON;
 exports.DataSourceResponseFromJSONTyped = DataSourceResponseFromJSONTyped;
 exports.DataSourceResponseToJSON = DataSourceResponseToJSON;
 exports.DataSourceResponseToJSONTyped = DataSourceResponseToJSONTyped;
+const ConnectionSummary_1 = require("./ConnectionSummary");
 const ItemPermissions_1 = require("./ItemPermissions");
+const SourceType_1 = require("./SourceType");
 const PathPartApprovalState_1 = require("./PathPartApprovalState");
+const SourceConfigSummary_1 = require("./SourceConfigSummary");
 const UserInfo_1 = require("./UserInfo");
 const DataSourceEngine_1 = require("./DataSourceEngine");
 /**
@@ -48,6 +51,8 @@ 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)
@@ -74,6 +79,9 @@ function DataSourceResponseFromJSONTyped(json, ignoreDiscriminator) {
         'tenantId': json['tenant_id'],
         'name': json['name'],
         'engine': (0, DataSourceEngine_1.DataSourceEngineFromJSON)(json['engine']),
+        'sourceType': (0, SourceType_1.SourceTypeFromJSON)(json['source_type']),
+        'connectionSummary': json['connection_summary'] == null ? undefined : (0, ConnectionSummary_1.ConnectionSummaryFromJSON)(json['connection_summary']),
+        'sourceConfig': json['source_config'] == null ? undefined : (0, SourceConfigSummary_1.SourceConfigSummaryFromJSON)(json['source_config']),
         'approvalState': (0, PathPartApprovalState_1.PathPartApprovalStateFromJSON)(json['approval_state']),
         'owner': json['owner'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['owner']),
         'permissions': (0, ItemPermissions_1.ItemPermissionsFromJSON)(json['permissions']),
@@ -97,6 +105,9 @@ function DataSourceResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'tenant_id': value['tenantId'],
         'name': value['name'],
         'engine': (0, DataSourceEngine_1.DataSourceEngineToJSON)(value['engine']),
+        'source_type': (0, SourceType_1.SourceTypeToJSON)(value['sourceType']),
+        'connection_summary': (0, ConnectionSummary_1.ConnectionSummaryToJSON)(value['connectionSummary']),
+        'source_config': (0, SourceConfigSummary_1.SourceConfigSummaryToJSON)(value['sourceConfig']),
         'approval_state': (0, PathPartApprovalState_1.PathPartApprovalStateToJSON)(value['approvalState']),
         'owner': (0, UserInfo_1.UserInfoToJSON)(value['owner']),
         'permissions': (0, ItemPermissions_1.ItemPermissionsToJSON)(value['permissions']),

package/dist/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/models/SourceConfigSummary.js

@@ -0,0 +1,79 @@
+"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.SourceConfigSummaryPropertyValidationAttributesMap = void 0;
+exports.instanceOfSourceConfigSummary = instanceOfSourceConfigSummary;
+exports.SourceConfigSummaryFromJSON = SourceConfigSummaryFromJSON;
+exports.SourceConfigSummaryFromJSONTyped = SourceConfigSummaryFromJSONTyped;
+exports.SourceConfigSummaryToJSON = SourceConfigSummaryToJSON;
+exports.SourceConfigSummaryToJSONTyped = SourceConfigSummaryToJSONTyped;
+exports.SourceConfigSummaryPropertyValidationAttributesMap = {
+    username: {
+        minLength: 1,
+    },
+    businessId: {
+        minLength: 1,
+    },
+    cron: {
+        minLength: 1,
+    },
+    baseUrl: {
+        maxLength: 2048,
+    },
+};
+/**
+ * Check if a given object implements the SourceConfigSummary interface.
+ */
+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;
+}
+function SourceConfigSummaryFromJSON(json) {
+    return SourceConfigSummaryFromJSONTyped(json, false);
+}
+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'],
+    };
+}
+function SourceConfigSummaryToJSON(json) {
+    return SourceConfigSummaryToJSONTyped(json, false);
+}
+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/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;