cognite-toolkit 0.7.45__py3-none-any.whl → 0.7.47__py3-none-any.whl

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)

cognite_toolkit/_cdf_tk/client/api/events.py

@@ -1,11 +1,12 @@
-from collections.abc import Sequence
-from typing import Any, Literal
+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.data_classes.event import EventRequest, EventResponse
-from cognite_toolkit._cdf_tk.client.data_classes.identifiers import InternalOrExternalId
 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.event import EventRequest, EventResponse
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalOrExternalId
 
 
 class EventsAPI(CDFResourceAPI[InternalOrExternalId, EventRequest, EventResponse]):
@@ -21,7 +22,9 @@ class EventsAPI(CDFResourceAPI[InternalOrExternalId, EventRequest, EventResponse
             },
         )
 
-    def _page_response(self, response: SuccessResponse2 | ItemsSuccessResponse2) -> PagedResponse[EventResponse]:
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[EventResponse]:
         return PagedResponse[EventResponse].model_validate_json(response.body)
 
     def _reference_response(self, response: SuccessResponse2) -> ResponseItems[InternalOrExternalId]:
@@ -73,34 +76,45 @@ class EventsAPI(CDFResourceAPI[InternalOrExternalId, EventRequest, EventResponse
         """
         self._request_no_response(items, "delete", extra_body={"ignoreUnknownIds": ignore_unknown_ids})
 
-    def iterate(
+    def paginate(
         self,
-        data_set_external_ids: list[str] | None = None,
-        asset_subtree_external_ids: list[str] | None = None,
+        filter: ClassicFilter | None = None,
         limit: int = 100,
         cursor: str | None = None,
     ) -> PagedResponse[EventResponse]:
         """Iterate over all events in CDF.
 
         Args:
-            data_set_external_ids: Filter by data set external IDs.
-            asset_subtree_external_ids: Filter by asset subtree external IDs.
+            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 EventResponse objects.
         """
-        filter_: dict[str, Any] = {}
-        if asset_subtree_external_ids:
-            filter_["assetSubtreeIds"] = [{"externalId": ext_id} for ext_id in asset_subtree_external_ids]
-        if data_set_external_ids:
-            filter_["dataSetIds"] = [{"externalId": ds_id} for ds_id in data_set_external_ids]
+        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[EventResponse]]:
+        """Iterate over all events 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 EventResponse objects.
+        """
         return self._iterate(
-            cursor=cursor,
             limit=limit,
-            body={"filter": filter_ or None},
+            body={"filter": filter.dump() if filter else None},
         )
 
     def list(

cognite_toolkit/_cdf_tk/client/api/extraction_pipelines.py

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

cognite_toolkit/_cdf_tk/client/api/filemetadata.py

@@ -1,16 +1,17 @@
-from collections.abc import Sequence
+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.data_classes.filemetadata import FileMetadataRequest, FileMetadataResponse
-from cognite_toolkit._cdf_tk.client.data_classes.identifiers import InternalOrExternalId
 from cognite_toolkit._cdf_tk.client.http_client import (
     HTTPClient,
     ItemsSuccessResponse2,
     RequestMessage2,
     SuccessResponse2,
 )
+from cognite_toolkit._cdf_tk.client.request_classes.filters import ClassicFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.filemetadata import FileMetadataRequest, FileMetadataResponse
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalOrExternalId
 
 
 class FileMetadataAPI(CDFResourceAPI[InternalOrExternalId, FileMetadataRequest, FileMetadataResponse]):
@@ -26,7 +27,9 @@ class FileMetadataAPI(CDFResourceAPI[InternalOrExternalId, FileMetadataRequest,
             },
         )
 
-    def _page_response(self, response: SuccessResponse2 | ItemsSuccessResponse2) -> PagedResponse[FileMetadataResponse]:
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[FileMetadataResponse]:
         return PagedResponse[FileMetadataResponse].model_validate_json(response.body)
 
     def _reference_response(self, response: SuccessResponse2) -> ResponseItems[InternalOrExternalId]:
@@ -56,7 +59,7 @@ class FileMetadataAPI(CDFResourceAPI[InternalOrExternalId, FileMetadataRequest,
             )
             response = self._http_client.request_single_retries(request)
             result = response.get_success_or_raise()
-            results.extend(self._page_response(result).items)
+            results.append(FileMetadataResponse.model_validate_json(result.body))
         return results
 
     def retrieve(
@@ -97,10 +100,9 @@ class FileMetadataAPI(CDFResourceAPI[InternalOrExternalId, FileMetadataRequest,
         """
         self._request_no_response(items, "delete", extra_body={"ignoreUnknownIds": ignore_unknown_ids})
 
-    def iterate(
+    def paginate(
         self,
-        data_set_external_ids: list[str] | None = None,
-        asset_subtree_external_ids: list[str] | None = None,
+        filter: ClassicFilter | None = None,
         directory_prefix: str | None = None,
         uploaded: bool | None = None,
         limit: int = 100,
@@ -109,8 +111,7 @@ class FileMetadataAPI(CDFResourceAPI[InternalOrExternalId, FileMetadataRequest,
         """Iterate over file metadata in CDF.
 
         Args:
-            data_set_external_ids: Filter by data set external IDs.
-            asset_subtree_external_ids: Filter by asset subtree external IDs.
+            filter: Filter by data set IDs and/or asset subtree IDs.
             directory_prefix: Filter by directory prefix.
             uploaded: Filter by upload status.
             limit: Maximum number of items to return per page.
@@ -119,22 +120,47 @@ class FileMetadataAPI(CDFResourceAPI[InternalOrExternalId, FileMetadataRequest,
         Returns:
             PagedResponse of FileMetadataResponse objects.
         """
-        filter_: dict[str, Any] = {}
-        if asset_subtree_external_ids:
-            filter_["assetSubtreeIds"] = [{"externalId": ext_id} for ext_id in asset_subtree_external_ids]
-        if data_set_external_ids:
-            filter_["dataSetIds"] = [{"externalId": ds_id} for ds_id in data_set_external_ids]
+        filter_: dict[str, Any] = filter.dump() if filter else {}
         if directory_prefix is not None:
             filter_["directoryPrefix"] = directory_prefix
         if uploaded is not None:
             filter_["uploaded"] = uploaded
 
-        return self._iterate(
+        return self._paginate(
             cursor=cursor,
             limit=limit,
             body={"filter": filter_ or None},
         )
 
+    def iterate(
+        self,
+        filter: ClassicFilter | None = None,
+        directory_prefix: str | None = None,
+        uploaded: bool | None = None,
+        limit: int | None = 100,
+    ) -> Iterable[list[FileMetadataResponse]]:
+        """Iterate over file metadata in CDF.
+
+        Args:
+            filter: Filter by data set IDs and/or asset subtree IDs.
+            directory_prefix: Filter by directory prefix.
+            uploaded: Filter by upload status.
+            limit: Maximum number of items to return per page.
+
+        Returns:
+            Iterable of lists of FileMetadataResponse objects.
+        """
+        filter_: dict[str, Any] = filter.dump() if filter else {}
+        if directory_prefix is not None:
+            filter_["directoryPrefix"] = directory_prefix
+        if uploaded is not None:
+            filter_["uploaded"] = uploaded
+
+        return self._iterate(
+            limit=limit,
+            body={"filter": filter_ or None},
+        )
+
     def list(
         self,
         limit: int | None = 100,

cognite_toolkit/_cdf_tk/client/api/function_schedules.py

@@ -0,0 +1,115 @@
+"""Function Schedules API for managing CDF function schedules.
+
+Based on the API specification at:
+https://api-docs.cognite.com/20230101/tag/Function-schedules/operation/postFunctionSchedules
+"""
+
+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.resource_classes.function_schedule import (
+    FunctionScheduleRequest,
+    FunctionScheduleResponse,
+)
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalId
+
+
+class FunctionSchedulesAPI(CDFResourceAPI[InternalId, FunctionScheduleRequest, FunctionScheduleResponse]):
+    """API for managing CDF function schedules.
+
+    Note: Function schedules do not support update operations.
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/functions/schedules", item_limit=1),
+                "retrieve": Endpoint(method="POST", path="/functions/schedules/byids", item_limit=10_000),
+                "delete": Endpoint(method="POST", path="/functions/schedules/delete", item_limit=10_000),
+                "list": Endpoint(method="POST", path="/functions/schedules/list", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[FunctionScheduleResponse]:
+        return PagedResponse[FunctionScheduleResponse].model_validate_json(response.body)
+
+    def create(self, items: Sequence[FunctionScheduleRequest]) -> list[FunctionScheduleResponse]:
+        """Create function schedules in CDF.
+
+        Args:
+            items: List of FunctionScheduleRequest objects to create.
+
+        Returns:
+            List of created FunctionScheduleResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(self, items: Sequence[InternalId], ignore_unknown_ids: bool = False) -> list[FunctionScheduleResponse]:
+        """Retrieve function schedules from CDF by ID.
+
+        Args:
+            items: List of InternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+
+        Returns:
+            List of retrieved FunctionScheduleResponse objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def delete(self, items: Sequence[InternalId]) -> None:
+        """Delete function schedules from CDF.
+
+        Args:
+            items: List of InternalId objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[FunctionScheduleResponse]:
+        """Get a page of function schedules from CDF.
+
+        Args:
+            limit: Maximum number of function schedules to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of FunctionScheduleResponse objects.
+        """
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+        )
+
+    def iterate(
+        self,
+        limit: int | None = None,
+    ) -> Iterable[list[FunctionScheduleResponse]]:
+        """Iterate over all function schedules in CDF.
+
+        Args:
+            limit: Maximum total number of function schedules to return.
+
+        Returns:
+            Iterable of lists of FunctionScheduleResponse objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = None) -> list[FunctionScheduleResponse]:
+        """List all function schedules in CDF.
+
+        Args:
+            limit: Maximum total number of function schedules to return.
+
+        Returns:
+            List of FunctionScheduleResponse objects.
+        """
+        return self._list(limit=limit)