ksapi 3.3.1__tar.gz → 3.5.0__tar.gz

{ksapi-3.3.1 → ksapi-3.5.0}/PKG-INFO

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

{ksapi-3.3.1 → ksapi-3.5.0}/ksapi/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "3.3.1"
+__version__ = "3.5.0"
 
 # Define package exports
 __all__ = [
@@ -466,6 +466,7 @@ __all__ = [
     "XlsxCellAnchorOutput",
     "XlsxCellAnchorOutputOrDocxParagraphAnchorOutput",
     "YidingConfig",
+    "YidingConfigChange",
     "YidingCursor",
     "ZipFileResult",
     "ZipIngestionStatusResponse",
@@ -925,6 +926,7 @@ from ksapi.models.xlsx_cell_anchor_input_or_docx_paragraph_anchor_input import X
 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_config_change import YidingConfigChange as YidingConfigChange
 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

{ksapi-3.3.1 → ksapi-3.5.0}/ksapi/api/workflow_definitions_api.py

@@ -1530,6 +1530,7 @@ class WorkflowDefinitionsApi:
         sort_by: Annotated[Optional[WorkflowDefinitionOrder], Field(description="Field to sort definitions by (default: CREATED_AT)")] = None,
         sort_dir: Annotated[Optional[SortDirection], Field(description="Sort direction; overrides the field's natural default")] = None,
         is_template: Optional[StrictBool] = None,
+        needs_approval: Annotated[Optional[StrictBool], Field(description="Only definitions with a run awaiting approval.")] = None,
         limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Number of items per page")] = None,
         offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of items to skip")] = None,
         created_after: Annotated[Optional[datetime], Field(description="Only items created at or after this timestamp (inclusive)")] = None,
@@ -1564,6 +1565,8 @@ class WorkflowDefinitionsApi:
         :type sort_dir: SortDirection
         :param is_template:
         :type is_template: bool
+        :param needs_approval: Only definitions with a run awaiting approval.
+        :type needs_approval: bool
         :param limit: Number of items per page
         :type limit: int
         :param offset: Number of items to skip
@@ -1608,6 +1611,7 @@ class WorkflowDefinitionsApi:
             sort_by=sort_by,
             sort_dir=sort_dir,
             is_template=is_template,
+            needs_approval=needs_approval,
             limit=limit,
             offset=offset,
             created_after=created_after,
@@ -1645,6 +1649,7 @@ class WorkflowDefinitionsApi:
         sort_by: Annotated[Optional[WorkflowDefinitionOrder], Field(description="Field to sort definitions by (default: CREATED_AT)")] = None,
         sort_dir: Annotated[Optional[SortDirection], Field(description="Sort direction; overrides the field's natural default")] = None,
         is_template: Optional[StrictBool] = None,
+        needs_approval: Annotated[Optional[StrictBool], Field(description="Only definitions with a run awaiting approval.")] = None,
         limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Number of items per page")] = None,
         offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of items to skip")] = None,
         created_after: Annotated[Optional[datetime], Field(description="Only items created at or after this timestamp (inclusive)")] = None,
@@ -1679,6 +1684,8 @@ class WorkflowDefinitionsApi:
         :type sort_dir: SortDirection
         :param is_template:
         :type is_template: bool
+        :param needs_approval: Only definitions with a run awaiting approval.
+        :type needs_approval: bool
         :param limit: Number of items per page
         :type limit: int
         :param offset: Number of items to skip
@@ -1723,6 +1730,7 @@ class WorkflowDefinitionsApi:
             sort_by=sort_by,
             sort_dir=sort_dir,
             is_template=is_template,
+            needs_approval=needs_approval,
             limit=limit,
             offset=offset,
             created_after=created_after,
@@ -1760,6 +1768,7 @@ class WorkflowDefinitionsApi:
         sort_by: Annotated[Optional[WorkflowDefinitionOrder], Field(description="Field to sort definitions by (default: CREATED_AT)")] = None,
         sort_dir: Annotated[Optional[SortDirection], Field(description="Sort direction; overrides the field's natural default")] = None,
         is_template: Optional[StrictBool] = None,
+        needs_approval: Annotated[Optional[StrictBool], Field(description="Only definitions with a run awaiting approval.")] = None,
         limit: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Number of items per page")] = None,
         offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Number of items to skip")] = None,
         created_after: Annotated[Optional[datetime], Field(description="Only items created at or after this timestamp (inclusive)")] = None,
@@ -1794,6 +1803,8 @@ class WorkflowDefinitionsApi:
         :type sort_dir: SortDirection
         :param is_template:
         :type is_template: bool
+        :param needs_approval: Only definitions with a run awaiting approval.
+        :type needs_approval: bool
         :param limit: Number of items per page
         :type limit: int
         :param offset: Number of items to skip
@@ -1838,6 +1849,7 @@ class WorkflowDefinitionsApi:
             sort_by=sort_by,
             sort_dir=sort_dir,
             is_template=is_template,
+            needs_approval=needs_approval,
             limit=limit,
             offset=offset,
             created_after=created_after,
@@ -1870,6 +1882,7 @@ class WorkflowDefinitionsApi:
         sort_by,
         sort_dir,
         is_template,
+        needs_approval,
         limit,
         offset,
         created_after,
@@ -1922,6 +1935,10 @@ class WorkflowDefinitionsApi:
             
             _query_params.append(('is_template', is_template))
             
+        if needs_approval is not None:
+            
+            _query_params.append(('needs_approval', needs_approval))
+            
         if limit is not None:
             
             _query_params.append(('limit', limit))

{ksapi-3.3.1 → ksapi-3.5.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.3.1/python'
+        self.user_agent = 'OpenAPI-Generator/3.5.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{ksapi-3.3.1 → ksapi-3.5.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.3.1".\
+               "SDK Package Version: 3.5.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{ksapi-3.3.1 → ksapi-3.5.0}/ksapi/models/__init__.py

@@ -410,6 +410,7 @@ from ksapi.models.xlsx_cell_anchor_input_or_docx_paragraph_anchor_input import X
 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_config_change import YidingConfigChange
 from ksapi.models.yiding_cursor import YidingCursor
 from ksapi.models.zip_file_result import ZipFileResult
 from ksapi.models.zip_ingestion_status_response import ZipIngestionStatusResponse

{ksapi-3.3.1 → ksapi-3.5.0}/ksapi/models/update_data_source_request.py

@@ -22,7 +22,7 @@ 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.yiding_config import YidingConfig
+from ksapi.models.yiding_config_change import YidingConfigChange
 from ksapi.models.yiding_cursor import YidingCursor
 from typing import Optional, Set
 from typing_extensions import Self
@@ -35,7 +35,7 @@ class UpdateDataSourceRequest(BaseModel):
     name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=255)]] = None
     parent_path_part_id: Optional[UUID] = Field(default=None, description="New parent FOLDER path_part to move the connector under.")
     connection_config: Optional[ConnectionConfig] = Field(default=None, description="Fresh, whole-object credentials to replace the stored ones.")
-    source_config: Optional[YidingConfig] = Field(default=None, description="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.")
+    source_config: Optional[YidingConfigChange] = Field(default=None, description="What a YIDINGSYNC connector's crawler config may still change: the panel password and the crawl recurrence, each optional and each merged into the stored config rather than replacing it. Which shop and from when are fixed at creation. Rejected on a DIRECT connector. Changing ``cron`` re-arms the schedule. connection_config stays server-managed for YIDINGSYNC.")
     sync_state: Optional[YidingCursor] = Field(default=None, description="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.")
     __properties: ClassVar[List[str]] = ["name", "parent_path_part_id", "connection_config", "source_config", "sync_state"]
 
@@ -127,7 +127,7 @@ class UpdateDataSourceRequest(BaseModel):
             "name": obj.get("name"),
             "parent_path_part_id": obj.get("parent_path_part_id"),
             "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,
+            "source_config": YidingConfigChange.from_dict(obj["source_config"]) if obj.get("source_config") is not None else None,
             "sync_state": YidingCursor.from_dict(obj["sync_state"]) if obj.get("sync_state") is not None else None
         })
         return _obj

ksapi-3.5.0/ksapi/models/yiding_config_change.py

@@ -0,0 +1,101 @@
+# 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, Field, StrictStr
+from typing import Any, ClassVar, Dict, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class YidingConfigChange(BaseModel):
+    """
+    YidingConfigChange
+    """ # noqa: E501
+    cron: Optional[StrictStr] = Field(default=None, description="Crawl recurrence, in the tenant's timezone")
+    password: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, description="Write-only: omit it to keep the stored one")
+    __properties: ClassVar[List[str]] = ["cron", "password"]
+
+    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 YidingConfigChange 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if cron (nullable) is None
+        # and model_fields_set contains the field
+        if self.cron is None and "cron" in self.model_fields_set:
+            _dict['cron'] = None
+
+        # set to None if password (nullable) is None
+        # and model_fields_set contains the field
+        if self.password is None and "password" in self.model_fields_set:
+            _dict['password'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of YidingConfigChange from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "cron": obj.get("cron"),
+            "password": obj.get("password")
+        })
+        return _obj
+
+

{ksapi-3.3.1 → ksapi-3.5.0}/ksapi.egg-info/PKG-INFO

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

{ksapi-3.3.1 → ksapi-3.5.0}/ksapi.egg-info/SOURCES.txt

@@ -455,6 +455,7 @@ ksapi/models/xlsx_cell_anchor_input_or_docx_paragraph_anchor_input.py
 ksapi/models/xlsx_cell_anchor_output.py
 ksapi/models/xlsx_cell_anchor_output_or_docx_paragraph_anchor_output.py
 ksapi/models/yiding_config.py
+ksapi/models/yiding_config_change.py
 ksapi/models/yiding_cursor.py
 ksapi/models/zip_file_result.py
 ksapi/models/zip_ingestion_status_response.py
@@ -898,6 +899,7 @@ test/test_xlsx_cell_anchor_input_or_docx_paragraph_anchor_input.py
 test/test_xlsx_cell_anchor_output.py
 test/test_xlsx_cell_anchor_output_or_docx_paragraph_anchor_output.py
 test/test_yiding_config.py
+test/test_yiding_config_change.py
 test/test_yiding_cursor.py
 test/test_zip_file_result.py
 test/test_zip_ingestion_status_response.py

{ksapi-3.3.1 → ksapi-3.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ksapi"
-version = "3.3.1"
+version = "3.5.0"
 description = "Knowledge Stack API"
 authors = [
   {name = "OpenAPI Generator Community",email = "team@openapitools.org"},

{ksapi-3.3.1 → ksapi-3.5.0}/setup.py

@@ -19,7 +19,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "ksapi"
-VERSION = "3.3.1"
+VERSION = "3.5.0"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

{ksapi-3.3.1 → ksapi-3.5.0}/test/test_update_data_source_request.py

@@ -44,12 +44,8 @@ class TestUpdateDataSourceRequest(unittest.TestCase):
                     username = '', 
                     password = '', 
                     ssl = True, ),
-                source_config = ksapi.models.yiding_config.YidingConfig(
-                    username = '0', 
-                    business_id = '0', 
-                    start_date = datetime.datetime.strptime('1975-12-30', '%Y-%m-%d').date(), 
-                    cron = '0', 
-                    base_url = 'https://admin.zhidianfan.com/seller_resv_sys', 
+                source_config = ksapi.models.yiding_config_change.YidingConfigChange(
+                    cron = '', 
                     password = '0', ),
                 sync_state = ksapi.models.yiding_cursor.YidingCursor(
                     last_synced_order_ts = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 

ksapi-3.5.0/test/test_yiding_config_change.py

@@ -0,0 +1,52 @@
+# 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
+
+
+import unittest
+
+from ksapi.models.yiding_config_change import YidingConfigChange
+
+class TestYidingConfigChange(unittest.TestCase):
+    """YidingConfigChange unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> YidingConfigChange:
+        """Test YidingConfigChange
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `YidingConfigChange`
+        """
+        model = YidingConfigChange()
+        if include_optional:
+            return YidingConfigChange(
+                cron = '',
+                password = '0'
+            )
+        else:
+            return YidingConfigChange(
+        )
+        """
+
+    def testYidingConfigChange(self):
+        """Test YidingConfigChange"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()