ksapi 1.162.0__tar.gz → 2.4.2__tar.gz

{ksapi-1.162.0 → ksapi-2.4.2}/PKG-INFO

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

{ksapi-1.162.0 → ksapi-2.4.2}/ksapi/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.162.0"
+__version__ = "2.4.2"
 
 # Define package exports
 __all__ = [
@@ -33,6 +33,7 @@ __all__ = [
     "ApiKeysApi",
     "AuditEventsApi",
     "AuthApi",
+    "BillingApi",
     "BulkDeleteApi",
     "BulkDownloadApi",
     "BulkMoveApi",
@@ -83,6 +84,9 @@ __all__ = [
     "Args",
     "AskRequest",
     "AskResponse",
+    "BillingInterval",
+    "BillingPaymentResponse",
+    "BillingSystem",
     "BlockChangeType",
     "BlockKind",
     "BrandingLogoType",
@@ -110,6 +114,8 @@ __all__ = [
     "ChangeClass",
     "ChangePhoneNumberRequest",
     "ChangeSubscriptionRequest",
+    "CheckoutAction",
+    "CheckoutResponse",
     "CheckpointDetails",
     "ChunkBulkResponse",
     "ChunkContentItem",
@@ -263,6 +269,7 @@ __all__ = [
     "OnboardingProfileRequest",
     "PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat",
     "PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator",
+    "PaginatedResponseBillingPaymentResponse",
     "PaginatedResponseDocumentResponse",
     "PaginatedResponseDocumentVersionResponse",
     "PaginatedResponseEventResponse",
@@ -322,6 +329,7 @@ __all__ = [
     "RunFolderRef",
     "RunTimeseriesResponse",
     "SSOInitiateResponse",
+    "ScheduleCadence",
     "ScoredChunkResponse",
     "SearchSkillsRequest",
     "SearchSkillsResponse",
@@ -354,7 +362,6 @@ __all__ = [
     "StructuredChangeType",
     "StructuredDiff",
     "SubmitFeedbackRequest",
-    "SubmitSubscriptionResponse",
     "SubscriptionPlanResponse",
     "SubtreeChunkGroup",
     "SubtreeChunksResponse",
@@ -371,6 +378,7 @@ __all__ = [
     "TenantResponse",
     "TenantSettingsResponse",
     "TenantSettingsUpdate",
+    "TenantSubscriptionResponse",
     "TenantUserEditRequest",
     "TenantUserOrder",
     "TenantUserResponse",
@@ -392,6 +400,7 @@ __all__ = [
     "ToolStatus",
     "TransferOwnerRequest",
     "TransferOwnerResponse",
+    "TrashItemDetailResponse",
     "TrashItemResponse",
     "UpdateApiConnectionRequest",
     "UpdateChunkContentRequest",
@@ -468,6 +477,7 @@ from ksapi.api.api_connections_api import ApiConnectionsApi as ApiConnectionsApi
 from ksapi.api.api_keys_api import ApiKeysApi as ApiKeysApi
 from ksapi.api.audit_events_api import AuditEventsApi as AuditEventsApi
 from ksapi.api.auth_api import AuthApi as AuthApi
+from ksapi.api.billing_api import BillingApi as BillingApi
 from ksapi.api.bulk_delete_api import BulkDeleteApi as BulkDeleteApi
 from ksapi.api.bulk_download_api import BulkDownloadApi as BulkDownloadApi
 from ksapi.api.bulk_move_api import BulkMoveApi as BulkMoveApi
@@ -522,6 +532,9 @@ from ksapi.models.append_memory_chunk_request import AppendMemoryChunkRequest as
 from ksapi.models.args import Args as Args
 from ksapi.models.ask_request import AskRequest as AskRequest
 from ksapi.models.ask_response import AskResponse as AskResponse
+from ksapi.models.billing_interval import BillingInterval as BillingInterval
+from ksapi.models.billing_payment_response import BillingPaymentResponse as BillingPaymentResponse
+from ksapi.models.billing_system import BillingSystem as BillingSystem
 from ksapi.models.block_change_type import BlockChangeType as BlockChangeType
 from ksapi.models.block_kind import BlockKind as BlockKind
 from ksapi.models.branding_logo_type import BrandingLogoType as BrandingLogoType
@@ -549,6 +562,8 @@ from ksapi.models.cell_diff import CellDiff as CellDiff
 from ksapi.models.change_class import ChangeClass as ChangeClass
 from ksapi.models.change_phone_number_request import ChangePhoneNumberRequest as ChangePhoneNumberRequest
 from ksapi.models.change_subscription_request import ChangeSubscriptionRequest as ChangeSubscriptionRequest
+from ksapi.models.checkout_action import CheckoutAction as CheckoutAction
+from ksapi.models.checkout_response import CheckoutResponse as CheckoutResponse
 from ksapi.models.checkpoint_details import CheckpointDetails as CheckpointDetails
 from ksapi.models.chunk_bulk_response import ChunkBulkResponse as ChunkBulkResponse
 from ksapi.models.chunk_content_item import ChunkContentItem as ChunkContentItem
@@ -702,6 +717,7 @@ from ksapi.models.onboarding_company_request import OnboardingCompanyRequest as
 from ksapi.models.onboarding_profile_request import OnboardingProfileRequest as OnboardingProfileRequest
 from ksapi.models.paginated_response_annotated_union_folder_response_document_response_workflow_definition_response_workflow_run_response_dat import PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat
 from ksapi.models.paginated_response_annotated_union_section_content_item_chunk_content_item_discriminator import PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator as PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator
+from ksapi.models.paginated_response_billing_payment_response import PaginatedResponseBillingPaymentResponse as PaginatedResponseBillingPaymentResponse
 from ksapi.models.paginated_response_document_response import PaginatedResponseDocumentResponse as PaginatedResponseDocumentResponse
 from ksapi.models.paginated_response_document_version_response import PaginatedResponseDocumentVersionResponse as PaginatedResponseDocumentVersionResponse
 from ksapi.models.paginated_response_event_response import PaginatedResponseEventResponse as PaginatedResponseEventResponse
@@ -761,6 +777,7 @@ from ksapi.models.run_folder import RunFolder as RunFolder
 from ksapi.models.run_folder_ref import RunFolderRef as RunFolderRef
 from ksapi.models.run_timeseries_response import RunTimeseriesResponse as RunTimeseriesResponse
 from ksapi.models.sso_initiate_response import SSOInitiateResponse as SSOInitiateResponse
+from ksapi.models.schedule_cadence import ScheduleCadence as ScheduleCadence
 from ksapi.models.scored_chunk_response import ScoredChunkResponse as ScoredChunkResponse
 from ksapi.models.search_skills_request import SearchSkillsRequest as SearchSkillsRequest
 from ksapi.models.search_skills_response import SearchSkillsResponse as SearchSkillsResponse
@@ -793,7 +810,6 @@ from ksapi.models.structured_change import StructuredChange as StructuredChange
 from ksapi.models.structured_change_type import StructuredChangeType as StructuredChangeType
 from ksapi.models.structured_diff import StructuredDiff as StructuredDiff
 from ksapi.models.submit_feedback_request import SubmitFeedbackRequest as SubmitFeedbackRequest
-from ksapi.models.submit_subscription_response import SubmitSubscriptionResponse as SubmitSubscriptionResponse
 from ksapi.models.subscription_plan_response import SubscriptionPlanResponse as SubscriptionPlanResponse
 from ksapi.models.subtree_chunk_group import SubtreeChunkGroup as SubtreeChunkGroup
 from ksapi.models.subtree_chunks_response import SubtreeChunksResponse as SubtreeChunksResponse
@@ -810,6 +826,7 @@ from ksapi.models.tenant_quota_state_response import TenantQuotaStateResponse as
 from ksapi.models.tenant_response import TenantResponse as TenantResponse
 from ksapi.models.tenant_settings_response import TenantSettingsResponse as TenantSettingsResponse
 from ksapi.models.tenant_settings_update import TenantSettingsUpdate as TenantSettingsUpdate
+from ksapi.models.tenant_subscription_response import TenantSubscriptionResponse as TenantSubscriptionResponse
 from ksapi.models.tenant_user_edit_request import TenantUserEditRequest as TenantUserEditRequest
 from ksapi.models.tenant_user_order import TenantUserOrder as TenantUserOrder
 from ksapi.models.tenant_user_response import TenantUserResponse as TenantUserResponse
@@ -831,6 +848,7 @@ from ksapi.models.tool_part import ToolPart as ToolPart
 from ksapi.models.tool_status import ToolStatus as ToolStatus
 from ksapi.models.transfer_owner_request import TransferOwnerRequest as TransferOwnerRequest
 from ksapi.models.transfer_owner_response import TransferOwnerResponse as TransferOwnerResponse
+from ksapi.models.trash_item_detail_response import TrashItemDetailResponse as TrashItemDetailResponse
 from ksapi.models.trash_item_response import TrashItemResponse as TrashItemResponse
 from ksapi.models.update_api_connection_request import UpdateApiConnectionRequest as UpdateApiConnectionRequest
 from ksapi.models.update_chunk_content_request import UpdateChunkContentRequest as UpdateChunkContentRequest

{ksapi-1.162.0 → ksapi-2.4.2}/ksapi/api/__init__.py

@@ -16,6 +16,7 @@ from ksapi.api.api_connections_api import ApiConnectionsApi
 from ksapi.api.api_keys_api import ApiKeysApi
 from ksapi.api.audit_events_api import AuditEventsApi
 from ksapi.api.auth_api import AuthApi
+from ksapi.api.billing_api import BillingApi
 from ksapi.api.bulk_delete_api import BulkDeleteApi
 from ksapi.api.bulk_download_api import BulkDownloadApi
 from ksapi.api.bulk_move_api import BulkMoveApi

ksapi-2.4.2/ksapi/api/billing_api.py

@@ -0,0 +1,338 @@
+"""
+    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 warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field
+from typing import Optional
+from typing_extensions import Annotated
+from uuid import UUID
+from ksapi.models.paginated_response_billing_payment_response import PaginatedResponseBillingPaymentResponse
+
+from ksapi.api_client import ApiClient, RequestSerialized
+from ksapi.api_response import ApiResponse
+from ksapi.rest import RESTResponseType
+
+
+class BillingApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def list_billing_payments(
+        self,
+        tenant_id: UUID,
+        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,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PaginatedResponseBillingPaymentResponse:
+        """List Billing Payments Handler
+
+        Newest-first payment history for the tenant (OWNER/ADMIN only).  Backs the billing page's receipts list. ``invoice_url`` links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.
+
+        :param tenant_id: (required)
+        :type tenant_id: UUID
+        :param limit: Number of items per page
+        :type limit: int
+        :param offset: Number of items to skip
+        :type offset: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_billing_payments_serialize(
+            tenant_id=tenant_id,
+            limit=limit,
+            offset=offset,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaginatedResponseBillingPaymentResponse",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def list_billing_payments_with_http_info(
+        self,
+        tenant_id: UUID,
+        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,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PaginatedResponseBillingPaymentResponse]:
+        """List Billing Payments Handler
+
+        Newest-first payment history for the tenant (OWNER/ADMIN only).  Backs the billing page's receipts list. ``invoice_url`` links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.
+
+        :param tenant_id: (required)
+        :type tenant_id: UUID
+        :param limit: Number of items per page
+        :type limit: int
+        :param offset: Number of items to skip
+        :type offset: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_billing_payments_serialize(
+            tenant_id=tenant_id,
+            limit=limit,
+            offset=offset,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaginatedResponseBillingPaymentResponse",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def list_billing_payments_without_preload_content(
+        self,
+        tenant_id: UUID,
+        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,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """List Billing Payments Handler
+
+        Newest-first payment history for the tenant (OWNER/ADMIN only).  Backs the billing page's receipts list. ``invoice_url`` links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.
+
+        :param tenant_id: (required)
+        :type tenant_id: UUID
+        :param limit: Number of items per page
+        :type limit: int
+        :param offset: Number of items to skip
+        :type offset: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_billing_payments_serialize(
+            tenant_id=tenant_id,
+            limit=limit,
+            offset=offset,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PaginatedResponseBillingPaymentResponse",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _list_billing_payments_serialize(
+        self,
+        tenant_id,
+        limit,
+        offset,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if tenant_id is not None:
+            _path_params['tenant_id'] = tenant_id
+        # process the query parameters
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if offset is not None:
+            
+            _query_params.append(('offset', offset))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'cookieAuth', 
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/v1/tenants/{tenant_id}/billing/payments',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

{ksapi-1.162.0 → ksapi-2.4.2}/ksapi/api/document_versions_api.py

@@ -629,7 +629,7 @@ class DocumentVersionsApi:
     ) -> DocumentVersionResponse:
         """Create Document Version Handler
 
-        Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+        Create a new version for a document.  Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  The version number is automatically incremented from the highest existing version.
 
         :param document_id: Document ID (required)
         :type document_id: UUID
@@ -697,7 +697,7 @@ class DocumentVersionsApi:
     ) -> ApiResponse[DocumentVersionResponse]:
         """Create Document Version Handler
 
-        Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+        Create a new version for a document.  Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  The version number is automatically incremented from the highest existing version.
 
         :param document_id: Document ID (required)
         :type document_id: UUID
@@ -765,7 +765,7 @@ class DocumentVersionsApi:
     ) -> RESTResponseType:
         """Create Document Version Handler
 
-        Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+        Create a new version for a document.  Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  The version number is automatically incremented from the highest existing version.
 
         :param document_id: Document ID (required)
         :type document_id: UUID
@@ -894,7 +894,7 @@ class DocumentVersionsApi:
     ) -> None:
         """Delete Document Version Handler
 
-        Delete a document version by its ID.  Cannot delete the active version of a document.
+        Delete a document version by its ID.  Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  Cannot delete the active version of a document.
 
         :param version_id: DocumentVersion ID (required)
         :type version_id: UUID
@@ -962,7 +962,7 @@ class DocumentVersionsApi:
     ) -> ApiResponse[None]:
         """Delete Document Version Handler
 
-        Delete a document version by its ID.  Cannot delete the active version of a document.
+        Delete a document version by its ID.  Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  Cannot delete the active version of a document.
 
         :param version_id: DocumentVersion ID (required)
         :type version_id: UUID
@@ -1030,7 +1030,7 @@ class DocumentVersionsApi:
     ) -> RESTResponseType:
         """Delete Document Version Handler
 
-        Delete a document version by its ID.  Cannot delete the active version of a document.
+        Delete a document version by its ID.  Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  Cannot delete the active version of a document.
 
         :param version_id: DocumentVersion ID (required)
         :type version_id: UUID

{ksapi-1.162.0 → ksapi-2.4.2}/ksapi/api/documents_api.py

@@ -2703,7 +2703,7 @@ class DocumentsApi:
     ) -> IngestDocumentResponse:
         """Ingest Document Version Handler
 
-        Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document's active_version) and the old version's Qdrant points are deactivated.  Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
+        Upload a new file for an existing document, creating a new version and triggering ingestion.  Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document's active_version) and the old version's Qdrant points are deactivated.  Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
 
         :param document_id: Document ID (required)
         :type document_id: UUID
@@ -2799,7 +2799,7 @@ class DocumentsApi:
     ) -> ApiResponse[IngestDocumentResponse]:
         """Ingest Document Version Handler
 
-        Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document's active_version) and the old version's Qdrant points are deactivated.  Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
+        Upload a new file for an existing document, creating a new version and triggering ingestion.  Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document's active_version) and the old version's Qdrant points are deactivated.  Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
 
         :param document_id: Document ID (required)
         :type document_id: UUID
@@ -2895,7 +2895,7 @@ class DocumentsApi:
     ) -> RESTResponseType:
         """Ingest Document Version Handler
 
-        Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document's active_version) and the old version's Qdrant points are deactivated.  Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
+        Upload a new file for an existing document, creating a new version and triggering ingestion.  Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document's active_version) and the old version's Qdrant points are deactivated.  Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
 
         :param document_id: Document ID (required)
         :type document_id: UUID