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

cognite_toolkit/_cdf_tk/client/api/timeseries.py

@@ -0,0 +1,137 @@
+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.identifiers import InternalOrExternalId
+from cognite_toolkit._cdf_tk.client.resource_classes.timeseries import TimeSeriesRequest, TimeSeriesResponse
+
+
+class TimeSeriesAPI(CDFResourceAPI[InternalOrExternalId, TimeSeriesRequest, TimeSeriesResponse]):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/timeseries", item_limit=1000, concurrency_max_workers=1),
+                "retrieve": Endpoint(
+                    method="POST", path="/timeseries/byids", item_limit=1000, concurrency_max_workers=1
+                ),
+                "update": Endpoint(
+                    method="POST", path="/timeseries/update", item_limit=1000, concurrency_max_workers=1
+                ),
+                "delete": Endpoint(
+                    method="POST", path="/timeseries/delete", item_limit=1000, concurrency_max_workers=1
+                ),
+                "list": Endpoint(method="POST", path="/timeseries/list", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[TimeSeriesResponse]:
+        return PagedResponse[TimeSeriesResponse].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[TimeSeriesRequest]) -> list[TimeSeriesResponse]:
+        """Create time series in CDF.
+
+        Args:
+            items: List of TimeSeriesRequest objects to create.
+        Returns:
+            List of created TimeSeriesResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(
+        self, items: Sequence[InternalOrExternalId], ignore_unknown_ids: bool = False
+    ) -> list[TimeSeriesResponse]:
+        """Retrieve time series from CDF.
+
+        Args:
+            items: List of InternalOrExternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        Returns:
+            List of retrieved TimeSeriesResponse objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def update(
+        self, items: Sequence[TimeSeriesRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[TimeSeriesResponse]:
+        """Update time series in CDF.
+
+        Args:
+            items: List of TimeSeriesRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated TimeSeriesResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[InternalOrExternalId], ignore_unknown_ids: bool = False) -> None:
+        """Delete time series from CDF.
+
+        Args:
+            items: List of InternalOrExternalId objects to delete.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        """
+        self._request_no_response(items, "delete", extra_body={"ignoreUnknownIds": ignore_unknown_ids})
+
+    def paginate(
+        self,
+        filter: ClassicFilter | None = None,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[TimeSeriesResponse]:
+        """Iterate over all time series in CDF.
+
+        Args:
+            filter: Filter by data set IDs and/or asset subtree IDs.
+            limit: Maximum number of items to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of TimeSeriesResponse objects.
+        """
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            body={"filter": filter.dump() if filter else None},
+        )
+
+    def iterate(
+        self,
+        filter: ClassicFilter | None = None,
+        limit: int | None = 100,
+    ) -> Iterable[list[TimeSeriesResponse]]:
+        """Iterate over all time series in CDF.
+
+        Args:
+            filter: Filter by data set IDs and/or asset subtree IDs.
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of TimeSeriesResponse objects.
+        """
+        return self._iterate(
+            limit=limit,
+            body={"filter": filter.dump() if filter else None},
+        )
+
+    def list(
+        self,
+        limit: int | None = 100,
+    ) -> list[TimeSeriesResponse]:
+        """List all time series in CDF.
+
+        Returns:
+            List of TimeSeriesResponse objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/token.py

@@ -4,7 +4,7 @@ from cognite.client import CogniteClient
 from cognite.client.data_classes.capabilities import _CAPABILITY_CLASS_BY_NAME, AllScope, Capability
 from cognite.client.data_classes.iam import TokenInspection
 
-from cognite_toolkit._cdf_tk.client.data_classes.capabilities import scope_intersection, scope_union
+from cognite_toolkit._cdf_tk.client.resource_classes.capabilities import scope_intersection, scope_union
 from cognite_toolkit._cdf_tk.utils import humanize_collection
 
 _ACL_CLASS_BY_CLASS_NAME = {cap.__name__: cap for cap in _CAPABILITY_CLASS_BY_NAME.values()}

cognite_toolkit/_cdf_tk/client/api/transformations.py

@@ -0,0 +1,146 @@
+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.request_classes.filters import ClassicFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalOrExternalId
+from cognite_toolkit._cdf_tk.client.resource_classes.transformation import TransformationRequest, TransformationResponse
+
+
+class TransformationsAPI(CDFResourceAPI[InternalOrExternalId, TransformationRequest, TransformationResponse]):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/transformations", item_limit=1000),
+                "retrieve": Endpoint(method="POST", path="/transformations/byids", item_limit=1000),
+                "update": Endpoint(method="POST", path="/transformations/update", item_limit=1000),
+                "delete": Endpoint(method="POST", path="/transformations/delete", item_limit=1000),
+                "list": Endpoint(method="POST", path="/transformations/filter", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[TransformationResponse]:
+        return PagedResponse[TransformationResponse].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[TransformationRequest]) -> list[TransformationResponse]:
+        """Create transformations in CDF.
+
+        Args:
+            items: List of TransformationRequest objects to create.
+        Returns:
+            List of created TransformationResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(
+        self, items: Sequence[InternalOrExternalId], ignore_unknown_ids: bool = False, with_job_details: bool = False
+    ) -> list[TransformationResponse]:
+        """Retrieve transformations from CDF.
+
+        Args:
+            items: List of InternalOrExternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+            with_job_details: Whether the transformations will be returned with running job and last created job details.
+        Returns:
+            List of retrieved TransformationResponse objects.
+        """
+        return self._request_item_response(
+            items,
+            method="retrieve",
+            extra_body={"ignoreUnknownIds": ignore_unknown_ids, "withJobDetails": with_job_details},
+        )
+
+    def update(
+        self, items: Sequence[TransformationRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[TransformationResponse]:
+        """Update transformations in CDF.
+
+        Args:
+            items: List of TransformationRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated TransformationResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[InternalOrExternalId], ignore_unknown_ids: bool = False) -> None:
+        """Delete transformations from CDF.
+
+        Args:
+            items: List of InternalOrExternalId objects to delete.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        """
+        self._request_no_response(items, "delete", extra_body={"ignoreUnknownIds": ignore_unknown_ids})
+
+    def paginate(
+        self,
+        filter: ClassicFilter | None = None,
+        is_public: bool | None = None,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[TransformationResponse]:
+        """Iterate over all transformations in CDF.
+
+        Args:
+            filter: Filter by data set IDs.
+            is_public: Filter by public status.
+            limit: Maximum number of items to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of TransformationResponse objects.
+        """
+        filter_: dict[str, Any] = filter.dump() if filter else {}
+        if is_public is not None:
+            filter_["isPublic"] = is_public
+
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            body={"filter": filter_ or None},
+        )
+
+    def iterate(
+        self,
+        filter: ClassicFilter | None = None,
+        is_public: bool | None = None,
+        limit: int = 100,
+    ) -> Iterable[list[TransformationResponse]]:
+        """Iterate over all transformations in CDF.
+
+        Args:
+            filter: Filter by data set IDs.
+            is_public: Filter by public status.
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of TransformationResponse objects.
+        """
+        filter_: dict[str, Any] = filter.dump() if filter else {}
+        if is_public is not None:
+            filter_["isPublic"] = is_public
+
+        return self._iterate(
+            limit=limit,
+            body={"filter": filter_ or None},
+        )
+
+    def list(
+        self,
+        limit: int | None = 100,
+    ) -> list[TransformationResponse]:
+        """List all transformations in CDF.
+
+        Returns:
+            List of TransformationResponse objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/views.py

@@ -0,0 +1,139 @@
+"""Views API for managing CDF data modeling views.
+
+Based on the API specification at:
+https://api-docs.cognite.com/20230101/tag/Views/operation/ApplyViews
+"""
+
+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 ViewFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.data_modeling import (
+    ViewReference,
+    ViewRequest,
+    ViewResponse,
+)
+
+
+class ViewsAPI(CDFResourceAPI[ViewReference, ViewRequest, ViewResponse]):
+    """API for managing CDF data modeling views.
+
+    Views 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/views", item_limit=100),
+                "retrieve": Endpoint(method="POST", path="/models/views/byids", item_limit=100),
+                "delete": Endpoint(method="POST", path="/models/views/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/models/views", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[ViewResponse]:
+        return PagedResponse[ViewResponse].model_validate_json(response.body)
+
+    def create(self, items: Sequence[ViewRequest]) -> list[ViewResponse]:
+        """Apply (create or update) views in CDF.
+
+        Args:
+            items: List of ViewRequest objects to apply.
+
+        Returns:
+            List of applied ViewResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def update(self, items: Sequence[ViewRequest]) -> list[ViewResponse]:
+        """Apply (create or update) views in CDF.
+
+        Args:
+            items: List of ViewRequest objects to apply.
+        Returns:
+            List of applied ViewResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def retrieve(self, items: Sequence[ViewReference], include_inherited_properties: bool = True) -> list[ViewResponse]:
+        """Retrieve views from CDF.
+
+        Args:
+            items: List of ViewReference objects to retrieve.
+            include_inherited_properties: Whether to include inherited properties.
+
+        Returns:
+            List of retrieved ViewResponse objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"includeInheritedProperties": include_inherited_properties}
+        )
+
+    def delete(self, items: Sequence[ViewReference]) -> None:
+        """Delete views from CDF.
+
+        Args:
+            items: List of ViewReference objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        filter: ViewFilter | None = None,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[ViewResponse]:
+        """Get a page of views from CDF.
+
+        Args:
+            filter: ViewFilter to filter views.
+            limit: Maximum number of views to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of ViewResponse objects.
+        """
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            params=filter.dump() if filter else None,
+        )
+
+    def iterate(
+        self,
+        filter: ViewFilter | None = None,
+        limit: int | None = None,
+    ) -> Iterable[list[ViewResponse]]:
+        """Iterate over all views in CDF.
+
+        Args:
+            filter: ViewFilter to filter views.
+            limit: Maximum total number of views to return.
+
+        Returns:
+            Iterable of lists of ViewResponse objects.
+        """
+        return self._iterate(
+            limit=limit,
+            params=filter.dump() if filter else None,
+        )
+
+    def list(
+        self,
+        filter: ViewFilter | None = None,
+        limit: int | None = None,
+    ) -> list[ViewResponse]:
+        """List all views in CDF.
+
+        Args:
+            filter: ViewFilter to filter views.
+            limit: Maximum total number of views to return.
+
+        Returns:
+            List of ViewResponse objects.
+        """
+        return self._list(limit=limit, params=filter.dump() if filter else None)

cognite_toolkit/_cdf_tk/client/api/workflow_triggers.py

@@ -0,0 +1,128 @@
+from collections.abc import Iterable, Sequence
+from typing import Any
+
+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.identifiers import ExternalId
+from cognite_toolkit._cdf_tk.client.resource_classes.workflow_trigger import (
+    WorkflowTriggerRequest,
+    WorkflowTriggerResponse,
+)
+
+
+class WorkflowTriggersAPI(CDFResourceAPI[ExternalId, WorkflowTriggerRequest, WorkflowTriggerResponse]):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "upsert": Endpoint(method="POST", path="/workflows/triggers", item_limit=1),
+                "delete": Endpoint(method="POST", path="/workflows/triggers/delete", item_limit=1),
+                "list": Endpoint(method="GET", path="/workflows/triggers", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[WorkflowTriggerResponse]:
+        return PagedResponse[WorkflowTriggerResponse].model_validate_json(response.body)
+
+    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[ExternalId]:
+        return ResponseItems[ExternalId].model_validate_json(response.body)
+
+    def create(self, items: Sequence[WorkflowTriggerRequest]) -> list[WorkflowTriggerResponse]:
+        """Create or update workflow triggers in CDF.
+
+        Args:
+            items: List of WorkflowTriggerRequest objects to create or update.
+        Returns:
+            List of created/updated WorkflowTriggerResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    # This is a duplicate of the create method, included to standardize the API interface.
+    def update(self, items: Sequence[WorkflowTriggerRequest]) -> list[WorkflowTriggerResponse]:
+        """Create or update workflow triggers in CDF.
+
+        Args:
+            items: List of WorkflowTriggerRequest objects to create or update.
+        Returns:
+            List of created/updated WorkflowTriggerResponse objects.
+        """
+        return self.create(items)
+
+    def delete(self, items: Sequence[ExternalId]) -> None:
+        """Delete workflow triggers from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        workflow_external_id: str | None = None,
+        workflow_version: str | None = None,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[WorkflowTriggerResponse]:
+        """Iterate over all workflow triggers in CDF.
+
+        Args:
+            workflow_external_id: Filter by workflow external ID.
+            workflow_version: Filter by workflow version.
+            limit: Maximum number of items to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of WorkflowTriggerResponse objects.
+        """
+        params: dict[str, Any] = {}
+        if workflow_external_id:
+            params["workflowExternalId"] = workflow_external_id
+        if workflow_version:
+            params["workflowVersion"] = workflow_version
+
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            params=params,
+        )
+
+    def iterate(
+        self,
+        workflow_external_id: str | None = None,
+        workflow_version: str | None = None,
+        limit: int = 100,
+    ) -> Iterable[list[WorkflowTriggerResponse]]:
+        """Iterate over all workflow triggers in CDF.
+
+        Args:
+            workflow_external_id: Filter by workflow external ID.
+            workflow_version: Filter by workflow version.
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of WorkflowTriggerResponse objects.
+        """
+        params: dict[str, Any] = {}
+        if workflow_external_id:
+            params["workflowExternalId"] = workflow_external_id
+        if workflow_version:
+            params["workflowVersion"] = workflow_version
+
+        return self._iterate(
+            limit=limit,
+            params=params,
+        )
+
+    def list(
+        self,
+        limit: int | None = 100,
+    ) -> list[WorkflowTriggerResponse]:
+        """List all workflow triggers in CDF.
+
+        Returns:
+            List of WorkflowTriggerResponse objects.
+        """
+        return self._list(limit=limit)