ksapi 3.2.0__tar.gz → 3.3.0__tar.gz

{ksapi-3.2.0 → ksapi-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ksapi
-Version: 3.2.0
+Version: 3.3.0
 Summary: Knowledge Stack API
 Home-page: 
 Author: OpenAPI Generator community

{ksapi-3.2.0 → ksapi-3.3.0}/ksapi/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "3.2.0"
+__version__ = "3.3.0"
 
 # Define package exports
 __all__ = [
@@ -137,6 +137,7 @@ __all__ = [
     "CommonFileExclusionReason",
     "CompleteUploadRequest",
     "ConnectionConfig",
+    "ConnectionSummary",
     "ContentsSortOrder",
     "CreateApiConnectionRequest",
     "CreateApiKeyRequest",
@@ -360,6 +361,8 @@ __all__ = [
     "SkillSearchResult",
     "SkillVersionResponse",
     "SortDirection",
+    "SourceConfigSummary",
+    "SourceType",
     "StartWorkflowRunRequest",
     "Step",
     "StepKind",
@@ -462,6 +465,8 @@ __all__ = [
     "XlsxCellAnchorInputOrDocxParagraphAnchorInput",
     "XlsxCellAnchorOutput",
     "XlsxCellAnchorOutputOrDocxParagraphAnchorOutput",
+    "YidingConfig",
+    "YidingCursor",
     "ZipFileResult",
     "ZipIngestionStatusResponse",
     "ZipMemberStatusResponse",
@@ -591,6 +596,7 @@ from ksapi.models.column_reference import ColumnReference as ColumnReference
 from ksapi.models.common_file_exclusion_reason import CommonFileExclusionReason as CommonFileExclusionReason
 from ksapi.models.complete_upload_request import CompleteUploadRequest as CompleteUploadRequest
 from ksapi.models.connection_config import ConnectionConfig as ConnectionConfig
+from ksapi.models.connection_summary import ConnectionSummary as ConnectionSummary
 from ksapi.models.contents_sort_order import ContentsSortOrder as ContentsSortOrder
 from ksapi.models.create_api_connection_request import CreateApiConnectionRequest as CreateApiConnectionRequest
 from ksapi.models.create_api_key_request import CreateApiKeyRequest as CreateApiKeyRequest
@@ -814,6 +820,8 @@ from ksapi.models.skill_response import SkillResponse as SkillResponse
 from ksapi.models.skill_search_result import SkillSearchResult as SkillSearchResult
 from ksapi.models.skill_version_response import SkillVersionResponse as SkillVersionResponse
 from ksapi.models.sort_direction import SortDirection as SortDirection
+from ksapi.models.source_config_summary import SourceConfigSummary as SourceConfigSummary
+from ksapi.models.source_type import SourceType as SourceType
 from ksapi.models.start_workflow_run_request import StartWorkflowRunRequest as StartWorkflowRunRequest
 from ksapi.models.step import Step as Step
 from ksapi.models.step_kind import StepKind as StepKind
@@ -916,6 +924,8 @@ from ksapi.models.xlsx_cell_anchor_input import XlsxCellAnchorInput as XlsxCellA
 from ksapi.models.xlsx_cell_anchor_input_or_docx_paragraph_anchor_input import XlsxCellAnchorInputOrDocxParagraphAnchorInput as XlsxCellAnchorInputOrDocxParagraphAnchorInput
 from ksapi.models.xlsx_cell_anchor_output import XlsxCellAnchorOutput as XlsxCellAnchorOutput
 from ksapi.models.xlsx_cell_anchor_output_or_docx_paragraph_anchor_output import XlsxCellAnchorOutputOrDocxParagraphAnchorOutput as XlsxCellAnchorOutputOrDocxParagraphAnchorOutput
+from ksapi.models.yiding_config import YidingConfig as YidingConfig
+from ksapi.models.yiding_cursor import YidingCursor as YidingCursor
 from ksapi.models.zip_file_result import ZipFileResult as ZipFileResult
 from ksapi.models.zip_ingestion_status_response import ZipIngestionStatusResponse as ZipIngestionStatusResponse
 from ksapi.models.zip_member_status_response import ZipMemberStatusResponse as ZipMemberStatusResponse

{ksapi-3.2.0 → ksapi-3.3.0}/ksapi/api/data_sources_api.py

@@ -354,7 +354,7 @@ class DataSourcesApi:
     ) -> None:
         """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.
 
         :param data_source_id: (required)
         :type data_source_id: UUID
@@ -422,7 +422,7 @@ class DataSourcesApi:
     ) -> ApiResponse[None]:
         """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.
 
         :param data_source_id: (required)
         :type data_source_id: UUID
@@ -490,7 +490,7 @@ class DataSourcesApi:
     ) -> RESTResponseType:
         """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.
 
         :param data_source_id: (required)
         :type data_source_id: UUID
@@ -3413,7 +3413,7 @@ class DataSourcesApi:
     ) -> DataSourceSyncResponse:
         """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.
 
         :param data_source_id: (required)
         :type data_source_id: UUID
@@ -3449,6 +3449,7 @@ class DataSourcesApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "DataSourceSyncResponse",
+            '202': None,
             '422': "HTTPValidationError",
         }
         response_data = self.api_client.call_api(
@@ -3481,7 +3482,7 @@ class DataSourcesApi:
     ) -> ApiResponse[DataSourceSyncResponse]:
         """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.
 
         :param data_source_id: (required)
         :type data_source_id: UUID
@@ -3517,6 +3518,7 @@ class DataSourcesApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "DataSourceSyncResponse",
+            '202': None,
             '422': "HTTPValidationError",
         }
         response_data = self.api_client.call_api(
@@ -3549,7 +3551,7 @@ class DataSourcesApi:
     ) -> RESTResponseType:
         """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.
 
         :param data_source_id: (required)
         :type data_source_id: UUID
@@ -3585,6 +3587,7 @@ class DataSourcesApi:
 
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "DataSourceSyncResponse",
+            '202': None,
             '422': "HTTPValidationError",
         }
         response_data = self.api_client.call_api(
@@ -4222,7 +4225,7 @@ class DataSourcesApi:
     ) -> DataSourceResponse:
         """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.
 
         :param data_source_id: (required)
         :type data_source_id: UUID
@@ -4294,7 +4297,7 @@ class DataSourcesApi:
     ) -> ApiResponse[DataSourceResponse]:
         """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.
 
         :param data_source_id: (required)
         :type data_source_id: UUID
@@ -4366,7 +4369,7 @@ class DataSourcesApi:
     ) -> RESTResponseType:
         """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.
 
         :param data_source_id: (required)
         :type data_source_id: UUID

{ksapi-3.2.0 → ksapi-3.3.0}/ksapi/api_client.py

@@ -91,7 +91,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/3.2.0/python'
+        self.user_agent = 'OpenAPI-Generator/3.3.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{ksapi-3.2.0 → ksapi-3.3.0}/ksapi/configuration.py

@@ -562,7 +562,7 @@ conf = ksapi.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.1.0\n"\
-               "SDK Package Version: 3.2.0".\
+               "SDK Package Version: 3.3.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{ksapi-3.2.0 → ksapi-3.3.0}/ksapi/models/__init__.py

@@ -81,6 +81,7 @@ from ksapi.models.column_reference import ColumnReference
 from ksapi.models.common_file_exclusion_reason import CommonFileExclusionReason
 from ksapi.models.complete_upload_request import CompleteUploadRequest
 from ksapi.models.connection_config import ConnectionConfig
+from ksapi.models.connection_summary import ConnectionSummary
 from ksapi.models.contents_sort_order import ContentsSortOrder
 from ksapi.models.create_api_connection_request import CreateApiConnectionRequest
 from ksapi.models.create_api_key_request import CreateApiKeyRequest
@@ -304,6 +305,8 @@ from ksapi.models.skill_response import SkillResponse
 from ksapi.models.skill_search_result import SkillSearchResult
 from ksapi.models.skill_version_response import SkillVersionResponse
 from ksapi.models.sort_direction import SortDirection
+from ksapi.models.source_config_summary import SourceConfigSummary
+from ksapi.models.source_type import SourceType
 from ksapi.models.start_workflow_run_request import StartWorkflowRunRequest
 from ksapi.models.step import Step
 from ksapi.models.step_kind import StepKind
@@ -406,6 +409,8 @@ from ksapi.models.xlsx_cell_anchor_input import XlsxCellAnchorInput
 from ksapi.models.xlsx_cell_anchor_input_or_docx_paragraph_anchor_input import XlsxCellAnchorInputOrDocxParagraphAnchorInput
 from ksapi.models.xlsx_cell_anchor_output import XlsxCellAnchorOutput
 from ksapi.models.xlsx_cell_anchor_output_or_docx_paragraph_anchor_output import XlsxCellAnchorOutputOrDocxParagraphAnchorOutput
+from ksapi.models.yiding_config import YidingConfig
+from ksapi.models.yiding_cursor import YidingCursor
 from ksapi.models.zip_file_result import ZipFileResult
 from ksapi.models.zip_ingestion_status_response import ZipIngestionStatusResponse
 from ksapi.models.zip_member_status_response import ZipMemberStatusResponse

ksapi-3.3.0/ksapi/models/connection_summary.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    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
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ConnectionSummary(BaseModel):
+    """
+    Where a connector points, with the password left out.
+    """ # noqa: E501
+    host: StrictStr
+    port: Optional[StrictInt] = None
+    database: StrictStr
+    username: StrictStr
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["host", "port", "database", "username"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ConnectionSummary from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if port (nullable) is None
+        # and model_fields_set contains the field
+        if self.port is None and "port" in self.model_fields_set:
+            _dict['port'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConnectionSummary from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "host": obj.get("host"),
+            "port": obj.get("port"),
+            "database": obj.get("database"),
+            "username": obj.get("username")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

{ksapi-3.2.0 → ksapi-3.3.0}/ksapi/models/create_data_source_request.py

@@ -18,11 +18,13 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field
-from typing import Any, ClassVar, Dict
+from typing import Any, ClassVar, Dict, Optional
 from typing_extensions import Annotated
 from uuid import UUID
 from ksapi.models.connection_config import ConnectionConfig
 from ksapi.models.data_source_engine import DataSourceEngine
+from ksapi.models.source_type import SourceType
+from ksapi.models.yiding_config import YidingConfig
 from typing import Optional, Set
 from typing_extensions import Self
 from pydantic_core import to_jsonable_python
@@ -33,9 +35,11 @@ class CreateDataSourceRequest(BaseModel):
     """ # noqa: E501
     name: Annotated[str, Field(strict=True, max_length=255)]
     parent_path_part_id: UUID
-    engine: DataSourceEngine
-    connection_config: ConnectionConfig
-    __properties: ClassVar[List[str]] = ["name", "parent_path_part_id", "engine", "connection_config"]
+    source_type: Optional[SourceType] = None
+    engine: Optional[DataSourceEngine] = None
+    connection_config: Optional[ConnectionConfig] = None
+    source_config: Optional[YidingConfig] = None
+    __properties: ClassVar[List[str]] = ["name", "parent_path_part_id", "source_type", "engine", "connection_config", "source_config"]
 
     model_config = ConfigDict(
         validate_by_name=True,
@@ -79,6 +83,19 @@ class CreateDataSourceRequest(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of connection_config
         if self.connection_config:
             _dict['connection_config'] = self.connection_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of source_config
+        if self.source_config:
+            _dict['source_config'] = self.source_config.to_dict()
+        # set to None if connection_config (nullable) is None
+        # and model_fields_set contains the field
+        if self.connection_config is None and "connection_config" in self.model_fields_set:
+            _dict['connection_config'] = None
+
+        # set to None if source_config (nullable) is None
+        # and model_fields_set contains the field
+        if self.source_config is None and "source_config" in self.model_fields_set:
+            _dict['source_config'] = None
+
         return _dict
 
     @classmethod
@@ -93,8 +110,10 @@ class CreateDataSourceRequest(BaseModel):
         _obj = cls.model_validate({
             "name": obj.get("name"),
             "parent_path_part_id": obj.get("parent_path_part_id"),
+            "source_type": obj.get("source_type"),
             "engine": obj.get("engine"),
-            "connection_config": ConnectionConfig.from_dict(obj["connection_config"]) if obj.get("connection_config") is not None else None
+            "connection_config": ConnectionConfig.from_dict(obj["connection_config"]) if obj.get("connection_config") is not None else None,
+            "source_config": YidingConfig.from_dict(obj["source_config"]) if obj.get("source_config") is not None else None
         })
         return _obj
 

{ksapi-3.2.0 → ksapi-3.3.0}/ksapi/models/data_source_response.py

@@ -21,9 +21,12 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, Optional
 from uuid import UUID
+from ksapi.models.connection_summary import ConnectionSummary
 from ksapi.models.data_source_engine import DataSourceEngine
 from ksapi.models.item_permissions import ItemPermissions
 from ksapi.models.path_part_approval_state import PathPartApprovalState
+from ksapi.models.source_config_summary import SourceConfigSummary
+from ksapi.models.source_type import SourceType
 from ksapi.models.user_info import UserInfo
 from typing import Optional, Set
 from typing_extensions import Self
@@ -31,7 +34,7 @@ from pydantic_core import to_jsonable_python
 
 class DataSourceResponse(BaseModel):
     """
-    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.
     """ # noqa: E501
     part_type: Optional[StrictStr] = Field(default='DATA_SOURCE', description="Path part type")
     id: UUID
@@ -41,12 +44,15 @@ class DataSourceResponse(BaseModel):
     tenant_id: UUID
     name: StrictStr
     engine: DataSourceEngine
+    source_type: SourceType
+    connection_summary: Optional[ConnectionSummary] = Field(default=None, description="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.")
+    source_config: Optional[SourceConfigSummary] = Field(default=None, description="A YIDINGSYNC connector's crawler config without the password: which shop, from when, and the crawl recurrence. Null on DIRECT.")
     approval_state: PathPartApprovalState
     owner: Optional[UserInfo] = Field(default=None, description="Current owner (creator) of the connector, or null if unowned.")
     permissions: ItemPermissions
     created_at: datetime
     updated_at: datetime
-    __properties: ClassVar[List[str]] = ["part_type", "id", "path_part_id", "parent_path_part_id", "materialized_path", "tenant_id", "name", "engine", "approval_state", "owner", "permissions", "created_at", "updated_at"]
+    __properties: ClassVar[List[str]] = ["part_type", "id", "path_part_id", "parent_path_part_id", "materialized_path", "tenant_id", "name", "engine", "source_type", "connection_summary", "source_config", "approval_state", "owner", "permissions", "created_at", "updated_at"]
 
     @field_validator('part_type')
     def part_type_validate_enum(cls, value):
@@ -97,6 +103,12 @@ class DataSourceResponse(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of connection_summary
+        if self.connection_summary:
+            _dict['connection_summary'] = self.connection_summary.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of source_config
+        if self.source_config:
+            _dict['source_config'] = self.source_config.to_dict()
         # override the default output from pydantic by calling `to_dict()` of owner
         if self.owner:
             _dict['owner'] = self.owner.to_dict()
@@ -108,6 +120,16 @@ class DataSourceResponse(BaseModel):
         if self.parent_path_part_id is None and "parent_path_part_id" in self.model_fields_set:
             _dict['parent_path_part_id'] = None
 
+        # set to None if connection_summary (nullable) is None
+        # and model_fields_set contains the field
+        if self.connection_summary is None and "connection_summary" in self.model_fields_set:
+            _dict['connection_summary'] = None
+
+        # set to None if source_config (nullable) is None
+        # and model_fields_set contains the field
+        if self.source_config is None and "source_config" in self.model_fields_set:
+            _dict['source_config'] = None
+
         # set to None if owner (nullable) is None
         # and model_fields_set contains the field
         if self.owner is None and "owner" in self.model_fields_set:
@@ -133,6 +155,9 @@ class DataSourceResponse(BaseModel):
             "tenant_id": obj.get("tenant_id"),
             "name": obj.get("name"),
             "engine": obj.get("engine"),
+            "source_type": obj.get("source_type"),
+            "connection_summary": ConnectionSummary.from_dict(obj["connection_summary"]) if obj.get("connection_summary") is not None else None,
+            "source_config": SourceConfigSummary.from_dict(obj["source_config"]) if obj.get("source_config") is not None else None,
             "approval_state": obj.get("approval_state"),
             "owner": UserInfo.from_dict(obj["owner"]) if obj.get("owner") is not None else None,
             "permissions": ItemPermissions.from_dict(obj["permissions"]) if obj.get("permissions") is not None else None,

ksapi-3.3.0/ksapi/models/source_config_summary.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    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
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import date
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class SourceConfigSummary(BaseModel):
+    """
+    A YIDINGSYNC connector's stored config, with the password left out.
+    """ # noqa: E501
+    username: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The account the crawler signs in to the panel as")
+    business_id: Annotated[str, Field(min_length=1, strict=True)] = Field(description="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.")
+    start_date: date = Field(description="First dining day to sync; earlier orders are not fetched")
+    cron: Annotated[str, Field(min_length=1, strict=True)] = Field(description="Crawl recurrence, in the tenant's timezone")
+    base_url: Optional[Annotated[str, Field(strict=True, max_length=2048)]] = Field(default='https://admin.zhidianfan.com/seller_resv_sys', description="Root of the YiDing admin panel the crawler signs in to")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["username", "business_id", "start_date", "cron", "base_url"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SourceConfigSummary from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SourceConfigSummary from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "username": obj.get("username"),
+            "business_id": obj.get("business_id"),
+            "start_date": obj.get("start_date"),
+            "cron": obj.get("cron"),
+            "base_url": obj.get("base_url") if obj.get("base_url") is not None else 'https://admin.zhidianfan.com/seller_resv_sys'
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

ksapi-3.3.0/ksapi/models/source_type.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    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
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class SourceType(str, Enum):
+    """
+    Extra connector config for data sync model direct connect or automatic login/copy method.
+    """
+
+    """
+    allowed enum values
+    """
+    DIRECT = 'DIRECT'
+    YIDINGSYNC = 'YIDINGSYNC'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SourceType from a JSON string"""
+        return cls(json.loads(json_str))
+
+