cognite-toolkit 0.7.39__py3-none-any.whl → 0.7.51__py3-none-any.whl

cognite_toolkit/_cdf_tk/client/api/annotations.py

@@ -0,0 +1,129 @@
+"""Annotations API for managing CDF annotations.
+
+Based on the API specification at:
+https://api-docs.cognite.com/20230101/tag/Annotations/operation/annotationsCreate
+"""
+
+from collections.abc import Iterable, Sequence
+from typing import Literal
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, Endpoint, PagedResponse
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.request_classes.filters import AnnotationFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.annotation import AnnotationRequest, AnnotationResponse
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalId
+
+
+class AnnotationsAPI(CDFResourceAPI[InternalId, AnnotationRequest, AnnotationResponse]):
+    """API for managing CDF annotations."""
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/annotations", item_limit=1000),
+                "retrieve": Endpoint(method="POST", path="/annotations/byids", item_limit=1000),
+                "update": Endpoint(method="POST", path="/annotations/update", item_limit=1000),
+                "delete": Endpoint(method="POST", path="/annotations/delete", item_limit=1000),
+                "list": Endpoint(method="POST", path="/annotations/list", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[AnnotationResponse]:
+        return PagedResponse[AnnotationResponse].model_validate_json(response.body)
+
+    def create(self, items: Sequence[AnnotationRequest]) -> list[AnnotationResponse]:
+        """Create annotations in CDF.
+
+        Args:
+            items: List of AnnotationRequest objects to create.
+
+        Returns:
+            List of created AnnotationResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(self, items: Sequence[InternalId]) -> list[AnnotationResponse]:
+        """Retrieve annotations from CDF by ID.
+
+        Args:
+            items: List of InternalId objects to retrieve.
+
+        Returns:
+            List of retrieved AnnotationResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve")
+
+    def update(
+        self, items: Sequence[AnnotationRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[AnnotationResponse]:
+        """Update annotations in CDF.
+
+        Args:
+            items: List of AnnotationRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated AnnotationResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[InternalId]) -> None:
+        """Delete annotations from CDF.
+
+        Args:
+            items: List of InternalId objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        filter: AnnotationFilter,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[AnnotationResponse]:
+        """Get a page of annotations from CDF.
+
+        Args:
+            filter: AnnotationFilter to filter annotations.
+            limit: Maximum number of annotations to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of AnnotationResponse objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit, body=filter.dump())
+
+    def iterate(
+        self,
+        filter: AnnotationFilter,
+        limit: int | None = None,
+    ) -> Iterable[list[AnnotationResponse]]:
+        """Iterate over all annotations in CDF.
+
+        Args:
+            filter: AnnotationFilter to filter annotations.
+            limit: Maximum total number of annotations to return.
+
+        Returns:
+            Iterable of lists of AnnotationResponse objects.
+        """
+        return self._iterate(limit=limit, body=filter.dump())
+
+    def list(
+        self,
+        filter: AnnotationFilter,
+        limit: int | None = None,
+    ) -> list[AnnotationResponse]:
+        """List all annotations in CDF.
+
+        Args:
+            filter: AnnotationFilter to filter annotations.
+            limit: Maximum total number of annotations to return.
+
+        Returns:
+            List of AnnotationResponse objects.
+        """
+        return self._list(limit=limit, body=filter.dump())

cognite_toolkit/_cdf_tk/client/api/assets.py

@@ -0,0 +1,130 @@
+from collections.abc import Iterable, Sequence
+from typing import Literal
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse, ResponseItems
+from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.request_classes.filters import ClassicFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.asset import AssetRequest, AssetResponse
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalOrExternalId
+
+
+class AssetsAPI(CDFResourceAPI[InternalOrExternalId, AssetRequest, AssetResponse]):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/assets", item_limit=1000, concurrency_max_workers=1),
+                "retrieve": Endpoint(method="POST", path="/assets/byids", item_limit=1000, concurrency_max_workers=1),
+                "update": Endpoint(method="POST", path="/assets/update", item_limit=1000, concurrency_max_workers=1),
+                "delete": Endpoint(method="POST", path="/assets/delete", item_limit=1000, concurrency_max_workers=1),
+                "list": Endpoint(method="POST", path="/assets/list", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[AssetResponse]:
+        return PagedResponse[AssetResponse].model_validate_json(response.body)
+
+    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[InternalOrExternalId]:
+        return ResponseItems[InternalOrExternalId].model_validate_json(response.body)
+
+    def create(self, items: Sequence[AssetRequest]) -> list[AssetResponse]:
+        """Create assets in CDF.
+
+        Args:
+            items: List of AssetRequest objects to create.
+        Returns:
+            List of created AssetResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(self, items: Sequence[InternalOrExternalId], ignore_unknown_ids: bool = False) -> list[AssetResponse]:
+        """Retrieve assets from CDF.
+
+        Args:
+            items: List of InternalOrExternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        Returns:
+            List of retrieved AssetResponse objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def update(
+        self, items: Sequence[AssetRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[AssetResponse]:
+        """Update assets in CDF.
+
+        Args:
+            items: List of AssetRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated AssetResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(
+        self, items: Sequence[InternalOrExternalId], recursive: bool = False, ignore_unknown_ids: bool = False
+    ) -> None:
+        """Delete assets from CDF.
+
+        Args:
+            items: List of InternalOrExternalId objects to delete.
+            recursive: Whether to delete assets recursively.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        """
+        self._request_no_response(
+            items, "delete", extra_body={"recursive": recursive, "ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def paginate(
+        self,
+        aggregated_properties: bool = False,
+        filter: ClassicFilter | None = None,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[AssetResponse]:
+        """Iterate over all assets in CDF.
+
+        Returns:
+            PagedResponse of AssetResponse objects.
+        """
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            body={
+                "aggregatedProperties": ["childCount", "path", "depth"] if aggregated_properties else [],
+                "filter": filter.dump() if filter else None,
+            },
+        )
+
+    def iterate(
+        self,
+        aggregated_properties: bool = False,
+        filter: ClassicFilter | None = None,
+        limit: int | None = 100,
+    ) -> Iterable[list[AssetResponse]]:
+        """Iterate over all assets in CDF.
+
+        Returns:
+            Sequence of AssetResponse objects.
+        """
+        return self._iterate(
+            limit=limit,
+            body={
+                "aggregatedProperties": ["childCount", "path", "depth"] if aggregated_properties else [],
+                "filter": filter.dump() if filter else None,
+            },
+        )
+
+    def list(self, limit: int | None = 100) -> list[AssetResponse]:
+        """List all asset references in CDF.
+
+        Returns:
+            ResponseItems of T_Identifier objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/containers.py

@@ -0,0 +1,132 @@
+"""Containers API for managing CDF data modeling containers.
+
+Based on the API specification at:
+https://api-docs.cognite.com/20230101/tag/Containers/operation/ApplyContainers
+"""
+
+from collections.abc import Iterable, Sequence
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, Endpoint, PagedResponse
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.request_classes.filters import ContainerFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.data_modeling import (
+    ContainerReference,
+    ContainerRequest,
+    ContainerResponse,
+)
+
+
+class ContainersAPI(CDFResourceAPI[ContainerReference, ContainerRequest, ContainerResponse]):
+    """API for managing CDF data modeling containers.
+
+    Containers use an apply/upsert pattern for create and update operations.
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "upsert": Endpoint(method="POST", path="/models/containers", item_limit=100),
+                "retrieve": Endpoint(method="POST", path="/models/containers/byids", item_limit=100),
+                "delete": Endpoint(method="POST", path="/models/containers/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/models/containers", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[ContainerResponse]:
+        return PagedResponse[ContainerResponse].model_validate_json(response.body)
+
+    def create(self, items: Sequence[ContainerRequest]) -> list[ContainerResponse]:
+        """Create (create or update) containers in CDF.
+
+        Args:
+            items: List of ContainerRequest objects to apply.
+
+        Returns:
+            List of applied ContainerResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def update(self, items: Sequence[ContainerRequest]) -> list[ContainerResponse]:
+        """Update (create or update) containers in CDF.
+
+        Args:
+            items: List of ContainerRequest objects to apply.
+        Returns:
+            List of applied ContainerResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def retrieve(self, items: Sequence[ContainerReference]) -> list[ContainerResponse]:
+        """Retrieve containers from CDF.
+
+        Args:
+            items: List of ContainerReference objects to retrieve.
+
+        Returns:
+            List of retrieved ContainerResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve")
+
+    def delete(self, items: Sequence[ContainerReference]) -> None:
+        """Delete containers from CDF.
+
+        Args:
+            items: List of ContainerReference objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        filter: ContainerFilter | None = None,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[ContainerResponse]:
+        """Get a page of containers from CDF.
+
+        Args:
+            filter: ContainerFilter to filter containers.
+            limit: Maximum number of containers to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of ContainerResponse objects.
+        """
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            params=filter.dump() if filter else None,
+        )
+
+    def iterate(
+        self,
+        filter: ContainerFilter | None = None,
+        limit: int | None = None,
+    ) -> Iterable[list[ContainerResponse]]:
+        """Iterate over all containers in CDF.
+
+        Args:
+            filter: ContainerFilter to filter containers.
+            limit: Maximum total number of containers to return.
+
+        Returns:
+            Iterable of lists of ContainerResponse objects.
+        """
+        return self._iterate(
+            limit=limit,
+            params=filter.dump() if filter else None,
+        )
+
+    def list(self, filter: ContainerFilter | None = None, limit: int | None = None) -> list[ContainerResponse]:
+        """List all containers in CDF.
+
+        Args:
+            filter: ContainerFilter to filter containers.
+            limit: Maximum total number of containers to return.
+
+        Returns:
+            List of ContainerResponse objects.
+        """
+        return self._list(limit=limit, params=filter.dump() if filter else None)

cognite_toolkit/_cdf_tk/client/api/data_models.py

@@ -0,0 +1,137 @@
+"""Data Models API for managing CDF data models.
+
+Based on the API specification at:
+https://api-docs.cognite.com/20230101/tag/Data-models/operation/createDataModels
+"""
+
+from collections.abc import Iterable, Sequence
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, Endpoint, PagedResponse
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.request_classes.filters import DataModelFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.data_modeling import (
+    DataModelReference,
+    DataModelRequest,
+    DataModelResponse,
+)
+
+
+class DataModelsAPI(CDFResourceAPI[DataModelReference, DataModelRequest, DataModelResponse]):
+    """API for managing CDF data models.
+
+    Data models use an apply/upsert pattern for create and update operations.
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "upsert": Endpoint(method="POST", path="/models/datamodels", item_limit=100),
+                "retrieve": Endpoint(method="POST", path="/models/datamodels/byids", item_limit=100),
+                "delete": Endpoint(method="POST", path="/models/datamodels/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/models/datamodels", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[DataModelResponse]:
+        return PagedResponse[DataModelResponse].model_validate_json(response.body)
+
+    def create(self, items: Sequence[DataModelRequest]) -> list[DataModelResponse]:
+        """Apply (create or update) data models in CDF.
+
+        Args:
+            items: List of DataModelRequest objects to apply.
+
+        Returns:
+            List of applied DataModelResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def update(self, items: Sequence[DataModelRequest]) -> list[DataModelResponse]:
+        """Apply (create or update) data models in CDF.
+
+        Args:
+            items: List of DataModelRequest objects to apply.
+        Returns:
+            List of applied DataModelResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def retrieve(self, items: Sequence[DataModelReference], inline_views: bool = False) -> list[DataModelResponse]:
+        """Retrieve data models from CDF.
+
+        Args:
+            items: List of DataModelReference objects to retrieve.
+            inline_views: Whether to include full view definitions in the response.
+
+        Returns:
+            List of retrieved DataModelResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve", extra_body={"inlineViews": inline_views})
+
+    def delete(self, items: Sequence[DataModelReference]) -> None:
+        """Delete data models from CDF.
+
+        Args:
+            items: List of DataModelReference objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        filter: DataModelFilter | None = None,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[DataModelResponse]:
+        """Get a page of data models from CDF.
+
+        Args:
+            filter: DataModelFilter to filter data models.
+            limit: Maximum number of data models to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of DataModelResponse objects.
+        """
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            params=filter.dump() if filter else None,
+        )
+
+    def iterate(
+        self,
+        filter: DataModelFilter | None = None,
+        limit: int | None = None,
+    ) -> Iterable[list[DataModelResponse]]:
+        """Iterate over all data models in CDF.
+
+        Args:
+            filter: DataModelFilter to filter data models.
+            limit: Maximum total number of data models to return.
+
+        Returns:
+            Iterable of lists of DataModelResponse objects.
+        """
+        return self._iterate(
+            limit=limit,
+            params=filter.dump() if filter else None,
+        )
+
+    def list(
+        self,
+        filter: DataModelFilter | None = None,
+        limit: int | None = None,
+    ) -> list[DataModelResponse]:
+        """List all data models in CDF.
+
+        Args:
+            filter: DataModelFilter to filter data models.
+            limit: Maximum total number of data models to return.
+
+        Returns:
+            List of DataModelResponse objects.
+        """
+        return self._list(limit=limit, params=filter.dump() if filter else None)

cognite_toolkit/_cdf_tk/client/api/datasets.py

@@ -0,0 +1,141 @@
+from collections.abc import Iterable, Sequence
+from typing import Any, Literal
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse, ResponseItems
+from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.resource_classes.dataset import DataSetRequest, DataSetResponse
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalOrExternalId
+
+
+class DataSetsAPI(CDFResourceAPI[InternalOrExternalId, DataSetRequest, DataSetResponse]):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/datasets", item_limit=10, concurrency_max_workers=1),
+                "retrieve": Endpoint(method="POST", path="/datasets/byids", item_limit=1000, concurrency_max_workers=1),
+                "update": Endpoint(method="POST", path="/datasets/update", item_limit=1000, concurrency_max_workers=1),
+                "list": Endpoint(method="POST", path="/datasets/list", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[DataSetResponse]:
+        return PagedResponse[DataSetResponse].model_validate_json(response.body)
+
+    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[InternalOrExternalId]:
+        return ResponseItems[InternalOrExternalId].model_validate_json(response.body)
+
+    def create(self, items: Sequence[DataSetRequest]) -> list[DataSetResponse]:
+        """Create data sets in CDF.
+
+        Args:
+            items: List of DataSetRequest objects to create.
+        Returns:
+            List of created DataSetResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(
+        self, items: Sequence[InternalOrExternalId], ignore_unknown_ids: bool = False
+    ) -> list[DataSetResponse]:
+        """Retrieve data sets from CDF.
+
+        Args:
+            items: List of InternalOrExternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        Returns:
+            List of retrieved DataSetResponse objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def update(
+        self, items: Sequence[DataSetRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[DataSetResponse]:
+        """Update data sets in CDF.
+
+        Args:
+            items: List of DataSetRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated DataSetResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def paginate(
+        self,
+        metadata: dict[str, str] | None = None,
+        external_id_prefix: str | None = None,
+        write_protected: bool | None = None,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[DataSetResponse]:
+        """Iterate over all data sets in CDF.
+
+        Args:
+            metadata: Filter by metadata.
+            external_id_prefix: Filter by external ID prefix.
+            write_protected: Filter by write protection status.
+            limit: Maximum number of items to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of DataSetResponse objects.
+        """
+        filter_body: dict[str, Any] = {}
+        if metadata is not None:
+            filter_body["metadata"] = metadata
+        if external_id_prefix is not None:
+            filter_body["externalIdPrefix"] = external_id_prefix
+        if write_protected is not None:
+            filter_body["writeProtected"] = write_protected
+
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            body={"filter": filter_body} if filter_body else {},
+        )
+
+    def iterate(
+        self,
+        metadata: dict[str, str] | None = None,
+        external_id_prefix: str | None = None,
+        write_protected: bool | None = None,
+        limit: int = 100,
+    ) -> Iterable[list[DataSetResponse]]:
+        """Iterate over all data sets in CDF.
+
+        Args:
+            metadata: Filter by metadata.
+            external_id_prefix: Filter by external ID prefix.
+            write_protected: Filter by write protection status.
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of DataSetResponse objects.
+        """
+        filter_body: dict[str, Any] = {}
+        if metadata is not None:
+            filter_body["metadata"] = metadata
+        if external_id_prefix is not None:
+            filter_body["externalIdPrefix"] = external_id_prefix
+        if write_protected is not None:
+            filter_body["writeProtected"] = write_protected
+
+        return self._iterate(
+            limit=limit,
+            body={"filter": filter_body} if filter_body else {},
+        )
+
+    def list(self, limit: int | None = 100) -> list[DataSetResponse]:
+        """List all data sets in CDF.
+
+        Returns:
+            List of DataSetResponse objects.
+        """
+        return self._list(limit=limit)