@knowledge-stack/ksapi 3.2.1 → 3.3.0

package/docs/SourceType.md

@@ -0,0 +1,33 @@
+
+# SourceType
+
+Extra connector config for data sync model direct connect or automatic login/copy method.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { SourceType } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies SourceType
+
+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 SourceType
+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/UpdateDataSourceRequest.md

@@ -10,6 +10,8 @@ Name | Type
 `name` | string
 `parentPathPartId` | string
 `connectionConfig` | [ConnectionConfig](ConnectionConfig.md)
+`sourceConfig` | [YidingConfig](YidingConfig.md)
+`syncState` | [YidingCursor](YidingCursor.md)
 
 ## Example
 
@@ -21,6 +23,8 @@ const example = {
   "name": null,
   "parentPathPartId": null,
   "connectionConfig": null,
+  "sourceConfig": null,
+  "syncState": null,
 } satisfies UpdateDataSourceRequest
 
 console.log(example)

package/docs/YidingConfig.md

@@ -0,0 +1,45 @@
+
+# YidingConfig
+
+What a customer supplies for a YiDing sync: the summary plus the secret.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`businessId` | string
+`startDate` | Date
+`cron` | string
+`baseUrl` | string
+`password` | string
+
+## Example
+
+```typescript
+import type { YidingConfig } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "businessId": null,
+  "startDate": null,
+  "cron": null,
+  "baseUrl": null,
+  "password": null,
+} satisfies YidingConfig
+
+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 YidingConfig
+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/YidingCursor.md

@@ -0,0 +1,37 @@
+
+# YidingCursor
+
+How far a crawl has read; a missing mark means \"never\", not \"day zero\".
+
+## Properties
+
+Name | Type
+------------ | -------------
+`lastSyncedOrderTs` | Date
+`lastSyncedUserTs` | Date
+
+## Example
+
+```typescript
+import type { YidingCursor } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "lastSyncedOrderTs": null,
+  "lastSyncedUserTs": null,
+} satisfies YidingCursor
+
+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 YidingCursor
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

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

package/src/apis/DataSourcesApi.ts

@@ -199,7 +199,7 @@ export interface DataSourcesApiInterface {
     deleteDataSourceRequestOpts(requestParameters: DeleteDataSourceRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * 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.
      * @summary Delete Data Source Handler
      * @param {string} dataSourceId 
      * @param {*} [options] Override http request option.
@@ -209,7 +209,7 @@ export interface DataSourcesApiInterface {
     deleteDataSourceRaw(requestParameters: DeleteDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
 
     /**
-     * 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.
      * Delete Data Source Handler
      */
     deleteDataSource(requestParameters: DeleteDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -475,7 +475,7 @@ export interface DataSourcesApiInterface {
     syncDataSourceRequestOpts(requestParameters: SyncDataSourceRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * 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.
      * @summary Sync Data Source Handler
      * @param {string} dataSourceId 
      * @param {*} [options] Override http request option.
@@ -485,10 +485,10 @@ export interface DataSourcesApiInterface {
     syncDataSourceRaw(requestParameters: SyncDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceSyncResponse>>;
 
     /**
-     * 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.
      * Sync Data Source Handler
      */
-    syncDataSource(requestParameters: SyncDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceSyncResponse>;
+    syncDataSource(requestParameters: SyncDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceSyncResponse | null | undefined >;
 
     /**
      * Creates request options for testDataSourceConnection without sending the request
@@ -548,7 +548,7 @@ export interface DataSourcesApiInterface {
     updateDataSourceRequestOpts(requestParameters: UpdateDataSourceOperationRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * 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.
      * @summary Update Data Source Handler
      * @param {string} dataSourceId 
      * @param {UpdateDataSourceRequest} updateDataSourceRequest 
@@ -559,7 +559,7 @@ export interface DataSourcesApiInterface {
     updateDataSourceRaw(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceResponse>>;
 
     /**
-     * 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.
      * Update Data Source Handler
      */
     updateDataSource(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceResponse>;
@@ -692,7 +692,7 @@ export class DataSourcesApi extends runtime.BaseAPI implements DataSourcesApiInt
     }
 
     /**
-     * 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.
      * Delete Data Source Handler
      */
     async deleteDataSourceRaw(requestParameters: DeleteDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -703,7 +703,7 @@ export class DataSourcesApi extends runtime.BaseAPI implements DataSourcesApiInt
     }
 
     /**
-     * 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.
      * Delete Data Source Handler
      */
     async deleteDataSource(requestParameters: DeleteDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -1346,7 +1346,7 @@ export class DataSourcesApi extends runtime.BaseAPI implements DataSourcesApiInt
     }
 
     /**
-     * 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.
      * Sync Data Source Handler
      */
     async syncDataSourceRaw(requestParameters: SyncDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceSyncResponse>> {
@@ -1357,12 +1357,19 @@ export class DataSourcesApi extends runtime.BaseAPI implements DataSourcesApiInt
     }
 
     /**
-     * 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.
      * Sync Data Source Handler
      */
-    async syncDataSource(requestParameters: SyncDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceSyncResponse> {
+    async syncDataSource(requestParameters: SyncDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceSyncResponse | null | undefined > {
         const response = await this.syncDataSourceRaw(requestParameters, initOverrides);
-        return await response.value();
+        switch (response.raw.status) {
+            case 200:
+                return await response.value();
+            case 202:
+                return null;
+            default:
+                return await response.value();
+        }
     }
 
     /**
@@ -1522,7 +1529,7 @@ export class DataSourcesApi extends runtime.BaseAPI implements DataSourcesApiInt
     }
 
     /**
-     * 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.
      * Update Data Source Handler
      */
     async updateDataSourceRaw(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceResponse>> {
@@ -1533,7 +1540,7 @@ export class DataSourcesApi extends runtime.BaseAPI implements DataSourcesApiInt
     }
 
     /**
-     * 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.
      * Update Data Source Handler
      */
     async updateDataSource(requestParameters: UpdateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceResponse> {

package/src/models/ConnectionSummary.ts

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

package/src/models/CreateDataSourceRequest.ts

@@ -13,6 +13,20 @@
  */
 
 import { mapValues } from '../runtime';
+import type { SourceType } from './SourceType';
+import {
+    SourceTypeFromJSON,
+    SourceTypeFromJSONTyped,
+    SourceTypeToJSON,
+    SourceTypeToJSONTyped,
+} from './SourceType';
+import type { YidingConfig } from './YidingConfig';
+import {
+    YidingConfigFromJSON,
+    YidingConfigFromJSONTyped,
+    YidingConfigToJSON,
+    YidingConfigToJSONTyped,
+} from './YidingConfig';
 import type { ConnectionConfig } from './ConnectionConfig';
 import {
     ConnectionConfigFromJSON,
@@ -46,18 +60,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;
 }
 
 
@@ -88,8 +114,6 @@ export const CreateDataSourceRequestPropertyValidationAttributesMap: {
 export function instanceOfCreateDataSourceRequest(value: object): value is CreateDataSourceRequest {
     if (!('name' in value) || value['name'] === undefined) 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;
 }
 
@@ -105,8 +129,10 @@ export function CreateDataSourceRequestFromJSONTyped(json: any, ignoreDiscrimina
         
         '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']),
     };
 }
 
@@ -123,8 +149,10 @@ export function CreateDataSourceRequestToJSONTyped(value?: CreateDataSourceReque
         
         '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/src/models/DataSourceResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ConnectionSummary } from './ConnectionSummary';
+import {
+    ConnectionSummaryFromJSON,
+    ConnectionSummaryFromJSONTyped,
+    ConnectionSummaryToJSON,
+    ConnectionSummaryToJSONTyped,
+} from './ConnectionSummary';
 import type { ItemPermissions } from './ItemPermissions';
 import {
     ItemPermissionsFromJSON,
@@ -20,6 +27,13 @@ import {
     ItemPermissionsToJSON,
     ItemPermissionsToJSONTyped,
 } from './ItemPermissions';
+import type { SourceType } from './SourceType';
+import {
+    SourceTypeFromJSON,
+    SourceTypeFromJSONTyped,
+    SourceTypeToJSON,
+    SourceTypeToJSONTyped,
+} from './SourceType';
 import type { PathPartApprovalState } from './PathPartApprovalState';
 import {
     PathPartApprovalStateFromJSON,
@@ -27,6 +41,13 @@ import {
     PathPartApprovalStateToJSON,
     PathPartApprovalStateToJSONTyped,
 } from './PathPartApprovalState';
+import type { SourceConfigSummary } from './SourceConfigSummary';
+import {
+    SourceConfigSummaryFromJSON,
+    SourceConfigSummaryFromJSONTyped,
+    SourceConfigSummaryToJSON,
+    SourceConfigSummaryToJSONTyped,
+} from './SourceConfigSummary';
 import type { UserInfo } from './UserInfo';
 import {
     UserInfoFromJSON,
@@ -45,8 +66,11 @@ import {
 /**
  * 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
  */
@@ -99,6 +123,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}
@@ -169,6 +211,7 @@ export function instanceOfDataSourceResponse(value: object): value is DataSource
     if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) 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) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
@@ -194,6 +237,9 @@ export function DataSourceResponseFromJSONTyped(json: any, 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']),
@@ -221,6 +267,9 @@ export function DataSourceResponseToJSONTyped(value?: DataSourceResponse | null,
         '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']),