@knowledge-stack/ksapi 3.2.1 → 3.3.1

package/src/models/SourceConfigSummary.ts

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

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

package/src/models/UpdateDataSourceRequest.ts

@@ -13,6 +13,20 @@
  */
 
 import { mapValues } from '../runtime';
+import type { YidingConfig } from './YidingConfig';
+import {
+    YidingConfigFromJSON,
+    YidingConfigFromJSONTyped,
+    YidingConfigToJSON,
+    YidingConfigToJSONTyped,
+} from './YidingConfig';
+import type { YidingCursor } from './YidingCursor';
+import {
+    YidingCursorFromJSON,
+    YidingCursorFromJSONTyped,
+    YidingCursorToJSON,
+    YidingCursorToJSONTyped,
+} from './YidingCursor';
 import type { ConnectionConfig } from './ConnectionConfig';
 import {
     ConnectionConfigFromJSON,
@@ -53,6 +67,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 const UpdateDataSourceRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -96,6 +122,8 @@ export function UpdateDataSourceRequestFromJSONTyped(json: any, ignoreDiscrimina
         'name': json['name'] == null ? undefined : json['name'],
         'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
         'connectionConfig': json['connection_config'] == null ? undefined : ConnectionConfigFromJSON(json['connection_config']),
+        'sourceConfig': json['source_config'] == null ? undefined : YidingConfigFromJSON(json['source_config']),
+        'syncState': json['sync_state'] == null ? undefined : YidingCursorFromJSON(json['sync_state']),
     };
 }
 
@@ -113,6 +141,8 @@ export function UpdateDataSourceRequestToJSONTyped(value?: UpdateDataSourceReque
         'name': value['name'],
         'parent_path_part_id': value['parentPathPartId'],
         'connection_config': ConnectionConfigToJSON(value['connectionConfig']),
+        'source_config': YidingConfigToJSON(value['sourceConfig']),
+        'sync_state': YidingCursorToJSON(value['syncState']),
     };
 }
 

package/src/models/YidingConfig.ts

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

@@ -0,0 +1,90 @@
+/* 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';
+/**
+ * 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 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 function instanceOfYidingCursor(value: object): value is YidingCursor {
+    return true;
+}
+
+export function YidingCursorFromJSON(json: any): YidingCursor {
+    return YidingCursorFromJSONTyped(json, false);
+}
+
+export function YidingCursorFromJSONTyped(json: any, ignoreDiscriminator: boolean): YidingCursor {
+    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: any): YidingCursor {
+    return YidingCursorToJSONTyped(json, false);
+}
+
+export function YidingCursorToJSONTyped(value?: YidingCursor | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/index.ts

@@ -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';