@knowledge-stack/ksapi 3.2.1 → 3.3.1

package/dist/models/SourceType.js

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

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

@@ -19,6 +19,8 @@ exports.UpdateDataSourceRequestFromJSON = UpdateDataSourceRequestFromJSON;
 exports.UpdateDataSourceRequestFromJSONTyped = UpdateDataSourceRequestFromJSONTyped;
 exports.UpdateDataSourceRequestToJSON = UpdateDataSourceRequestToJSON;
 exports.UpdateDataSourceRequestToJSONTyped = UpdateDataSourceRequestToJSONTyped;
+const YidingConfig_1 = require("./YidingConfig");
+const YidingCursor_1 = require("./YidingCursor");
 const ConnectionConfig_1 = require("./ConnectionConfig");
 exports.UpdateDataSourceRequestPropertyValidationAttributesMap = {
     name: {
@@ -43,6 +45,8 @@ 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']),
+        'syncState': json['sync_state'] == null ? undefined : (0, YidingCursor_1.YidingCursorFromJSON)(json['sync_state']),
     };
 }
 function UpdateDataSourceRequestToJSON(json) {
@@ -56,5 +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']),
+        'sync_state': (0, YidingCursor_1.YidingCursorToJSON)(value['syncState']),
     };
 }

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

@@ -0,0 +1,86 @@
+"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.YidingConfigPropertyValidationAttributesMap = void 0;
+exports.instanceOfYidingConfig = instanceOfYidingConfig;
+exports.YidingConfigFromJSON = YidingConfigFromJSON;
+exports.YidingConfigFromJSONTyped = YidingConfigFromJSONTyped;
+exports.YidingConfigToJSON = YidingConfigToJSON;
+exports.YidingConfigToJSONTyped = YidingConfigToJSONTyped;
+exports.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.
+ */
+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;
+}
+function YidingConfigFromJSON(json) {
+    return YidingConfigFromJSONTyped(json, false);
+}
+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'],
+    };
+}
+function YidingConfigToJSON(json) {
+    return YidingConfigToJSONTyped(json, false);
+}
+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'],
+    };
+}

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

@@ -0,0 +1,52 @@
+"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.YidingCursorPropertyValidationAttributesMap = void 0;
+exports.instanceOfYidingCursor = instanceOfYidingCursor;
+exports.YidingCursorFromJSON = YidingCursorFromJSON;
+exports.YidingCursorFromJSONTyped = YidingCursorFromJSONTyped;
+exports.YidingCursorToJSON = YidingCursorToJSON;
+exports.YidingCursorToJSONTyped = YidingCursorToJSONTyped;
+exports.YidingCursorPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the YidingCursor interface.
+ */
+function instanceOfYidingCursor(value) {
+    return true;
+}
+function YidingCursorFromJSON(json) {
+    return YidingCursorFromJSONTyped(json, false);
+}
+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'])),
+    };
+}
+function YidingCursorToJSON(json) {
+    return YidingCursorToJSONTyped(json, false);
+}
+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/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/models/index.js

@@ -84,6 +84,7 @@ __exportStar(require("./ColumnReference"), exports);
 __exportStar(require("./CommonFileExclusionReason"), exports);
 __exportStar(require("./CompleteUploadRequest"), exports);
 __exportStar(require("./ConnectionConfig"), exports);
+__exportStar(require("./ConnectionSummary"), exports);
 __exportStar(require("./ContentsSortOrder"), exports);
 __exportStar(require("./CreateApiConnectionRequest"), exports);
 __exportStar(require("./CreateApiKeyRequest"), exports);
@@ -307,6 +308,8 @@ __exportStar(require("./SkillResponse"), exports);
 __exportStar(require("./SkillSearchResult"), exports);
 __exportStar(require("./SkillVersionResponse"), exports);
 __exportStar(require("./SortDirection"), exports);
+__exportStar(require("./SourceConfigSummary"), exports);
+__exportStar(require("./SourceType"), exports);
 __exportStar(require("./StartWorkflowRunRequest"), exports);
 __exportStar(require("./Step"), exports);
 __exportStar(require("./StepKind"), exports);
@@ -409,6 +412,8 @@ __exportStar(require("./XlsxCellAnchorInput"), exports);
 __exportStar(require("./XlsxCellAnchorInputOrDocxParagraphAnchorInput"), exports);
 __exportStar(require("./XlsxCellAnchorOutput"), exports);
 __exportStar(require("./XlsxCellAnchorOutputOrDocxParagraphAnchorOutput"), exports);
+__exportStar(require("./YidingConfig"), exports);
+__exportStar(require("./YidingCursor"), exports);
 __exportStar(require("./ZipFileResult"), exports);
 __exportStar(require("./ZipIngestionStatusResponse"), exports);
 __exportStar(require("./ZipMemberStatusResponse"), exports);

package/docs/ConnectionSummary.md

@@ -0,0 +1,41 @@
+
+# ConnectionSummary
+
+Where a connector points, with the password left out.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`host` | string
+`port` | number
+`database` | string
+`username` | string
+
+## Example
+
+```typescript
+import type { ConnectionSummary } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "host": null,
+  "port": null,
+  "database": null,
+  "username": null,
+} satisfies ConnectionSummary
+
+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 ConnectionSummary
+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/docs/CreateDataSourceRequest.md

@@ -9,8 +9,10 @@ Name | Type
 ------------ | -------------
 `name` | string
 `parentPathPartId` | string
+`sourceType` | [SourceType](SourceType.md)
 `engine` | [DataSourceEngine](DataSourceEngine.md)
 `connectionConfig` | [ConnectionConfig](ConnectionConfig.md)
+`sourceConfig` | [YidingConfig](YidingConfig.md)
 
 ## Example
 
@@ -21,8 +23,10 @@ import type { CreateDataSourceRequest } from '@knowledge-stack/ksapi'
 const example = {
   "name": null,
   "parentPathPartId": null,
+  "sourceType": null,
   "engine": null,
   "connectionConfig": null,
+  "sourceConfig": null,
 } satisfies CreateDataSourceRequest
 
 console.log(example)

package/docs/DataSourceResponse.md

@@ -1,7 +1,7 @@
 
 # DataSourceResponse
 
-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.
+Connector response; a discriminated-union variant for folder listings.  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.
 
 ## Properties
 
@@ -15,6 +15,9 @@ Name | Type
 `tenantId` | string
 `name` | string
 `engine` | [DataSourceEngine](DataSourceEngine.md)
+`sourceType` | [SourceType](SourceType.md)
+`connectionSummary` | [ConnectionSummary](ConnectionSummary.md)
+`sourceConfig` | [SourceConfigSummary](SourceConfigSummary.md)
 `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
 `owner` | [UserInfo](UserInfo.md)
 `permissions` | [ItemPermissions](ItemPermissions.md)
@@ -36,6 +39,9 @@ const example = {
   "tenantId": null,
   "name": null,
   "engine": null,
+  "sourceType": null,
+  "connectionSummary": null,
+  "sourceConfig": null,
   "approvalState": null,
   "owner": null,
   "permissions": null,

package/docs/DataSourcesApi.md

@@ -105,7 +105,7 @@ example().catch(console.error);
 
 Delete Data Source Handler
 
-Move a connector and its schemas/tables to trash.  Soft-delete via the path_part subtree (schemas + tables are children, so they trash with it). Each modeled table\'s summary Qdrant point carries that table\'s path_part, so the set-trashed workflow flips it to trashed too — keeping trashed tables out of the agent\'s table search (best-effort, mirrors the document delete path).
+Move a connector and its schemas/tables to trash.  Soft-delete via the path_part subtree (schemas + tables are children, so they trash with it). Each modeled table\'s summary Qdrant point carries that table\'s path_part, so the set-trashed workflow flips it to trashed too — keeping trashed tables out of the agent\'s table search (best-effort, mirrors the document delete path).  A YIDINGSYNC connector also owns a daily crawl schedule, which is removed here: left behind, it would fire every night at a connector that is gone. The check is not redundant — unlike the best-effort trash sync above, ``delete_connector_schedule`` re-raises anything that is not NOT_FOUND, so calling it for a DIRECT connector would put a Temporal outage in the way of a delete that never needed Temporal at all.
 
 ### Example
 
@@ -948,7 +948,7 @@ example().catch(console.error);
 
 Sync Data Source Handler
 
-Reconcile modeled tables against the live external catalog.  Requires ``can_write``. Re-introspects each modeled schema and, per table: a schema change (columns added/removed/retyped) refreshes ``column_config`` (preserving the admin\'s ``exposed``/``comment`` field-modeling) and re-summarizes + re-embeds; an unchanged table is a no-op; a table dropped from the source is soft-deleted (keeping the \"was modeled, now gone\" record) and its embedding purged. It never models tables that were not imported.
+Reconcile modeled tables against the live external catalog.  Requires ``can_write``. Re-introspects each modeled schema and, per table: a schema change (columns added/removed/retyped) refreshes ``column_config`` (preserving the admin\'s ``exposed``/``comment`` field-modeling) and re-summarizes + re-embeds; an unchanged table is a no-op; a table dropped from the source is soft-deleted (keeping the \"was modeled, now gone\" record) and its embedding purged. It never models tables that were not imported.  A crawler-fed connector has no catalog to reconcile against, so it starts a crawl instead and returns 202.
 
 ### Example
 
@@ -1011,6 +1011,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
+| **202** | Crawl accepted; it runs in the background |  -  |
 | **422** | Validation Error |  -  |
 | **0** | Error response. |  -  |
 
@@ -1173,7 +1174,7 @@ example().catch(console.error);
 
 Update Data Source Handler
 
-Rename, move, and/or re-credential a connector.  Requires ``can_write`` on the connector (and on the destination folder for a move); supplying ``connection_config`` additionally requires OWNER/ADMIN. Fresh ``connection_config`` is re-validated against the DB before persisting (bad creds → 400, consistent with create); creds are never echoed back. ``engine`` is immutable.
+Rename, move, and/or re-credential a connector.  Requires ``can_write`` on the connector (and on the destination folder for a move); supplying ``connection_config`` additionally requires OWNER/ADMIN. Fresh ``connection_config`` is re-validated against the DB before persisting (bad creds → 400, consistent with create); creds are never echoed back. ``engine`` is immutable. A fresh ``source_config`` re-arms the crawl schedule, so changing ``cron`` takes effect immediately rather than at the next provisioning.
 
 ### Example
 

package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.md

@@ -56,6 +56,9 @@ Name | Type
 `excludedCommonFiles` | [Array<ExcludedCommonFile>](ExcludedCommonFile.md)
 `runThreadId` | string
 `engine` | [DataSourceEngine](DataSourceEngine.md)
+`sourceType` | [SourceType](SourceType.md)
+`connectionSummary` | [ConnectionSummary](ConnectionSummary.md)
+`sourceConfig` | [SourceConfigSummary](SourceConfigSummary.md)
 `dataSourceId` | string
 `schemaName` | string
 `isDefault` | boolean
@@ -131,6 +134,9 @@ const example = {
   "excludedCommonFiles": null,
   "runThreadId": null,
   "engine": null,
+  "sourceType": null,
+  "connectionSummary": null,
+  "sourceConfig": null,
   "dataSourceId": null,
   "schemaName": null,
   "isDefault": null,

package/docs/SourceConfigSummary.md

@@ -0,0 +1,43 @@
+
+# SourceConfigSummary
+
+A YIDINGSYNC connector\'s stored config, with the password left out.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`businessId` | string
+`startDate` | Date
+`cron` | string
+`baseUrl` | string
+
+## Example
+
+```typescript
+import type { SourceConfigSummary } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "businessId": null,
+  "startDate": null,
+  "cron": null,
+  "baseUrl": null,
+} satisfies SourceConfigSummary
+
+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 SourceConfigSummary
+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)
+
+