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

cognite_toolkit/_cdf_tk/client/api/legacy/location_filters.py

@@ -0,0 +1,112 @@
+from collections.abc import Iterator, Sequence
+from typing import overload
+
+from cognite.client import CogniteClient
+from cognite.client._api_client import APIClient
+from cognite.client.config import ClientConfig
+from cognite.client.utils._identifier import IdentifierSequence
+
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.location_filters import (
+    LocationFilter,
+    LocationFilterList,
+    LocationFilterWrite,
+)
+
+
+class LocationFiltersAPI(APIClient):
+    def __init__(self, config: ClientConfig, api_version: str | None, cognite_client: CogniteClient) -> None:
+        super().__init__(config, api_version, cognite_client)
+        # this is hopefully a very temporary fix to avoid the client concatinating the _RESOURCE_PATH with the ordinary /api/ path.
+        self._api_version = None
+        self._RESOURCE_PATH = f"/apps/v1/projects/{self._cognite_client.config.project}/storage/config/locationfilters"
+
+    @overload
+    def __call__(self) -> Iterator[LocationFilter]: ...
+
+    @overload
+    def __call__(self, chunk_size: int) -> Iterator[LocationFilterList]: ...
+
+    def __call__(self, chunk_size: int | None = None) -> Iterator[LocationFilter] | Iterator[LocationFilterList]:
+        """Iterate over locationfilters.
+
+        Args:
+            chunk_size: The number of locationfilters to return in each chunk. None will return all locationfilters.
+
+        Yields:
+            LocationFilter or LocationFilterList
+
+        """
+        return iter(self.list())
+
+    def __iter__(self) -> Iterator[LocationFilter]:
+        return self.__call__()
+
+    def create(self, location_filter: LocationFilterWrite) -> LocationFilter:
+        """Create a new LocationFilter.
+
+        Args:
+            location_filter: LocationFilterWrite
+
+
+        Returns:
+            LocationFilter
+
+        """
+
+        res = self._post(url_path=self._RESOURCE_PATH, json=location_filter.dump())
+        return LocationFilter._load(res.json(), cognite_client=self._cognite_client)
+
+    def retrieve(self, id: int) -> LocationFilter:
+        """Retrieve a single LocationFilter.
+
+        Args:
+            id: The ID of the LocationFilter
+
+        Returns:
+            LocationFilter
+        """
+
+        res = self._get(url_path=f"{self._RESOURCE_PATH}/{id}")
+        return LocationFilter._load(res.json(), cognite_client=self._cognite_client)
+
+    def update(self, id: int, location_filter_update: LocationFilterWrite) -> LocationFilter:
+        """Update a new LocationFilter.
+
+        Args:
+            id: The ID of the LocationFilter
+            location_filter_content: The content of the LocationFilter to update
+
+        Returns:
+            LocationFilter
+
+        """
+
+        res = self._put(
+            url_path=f"{self._RESOURCE_PATH}/{id}",
+            json=location_filter_update.dump(),
+        )
+        return LocationFilter._load(res.json(), cognite_client=self._cognite_client)
+
+    def delete(self, id: int) -> None:
+        self._delete(url_path=f"{self._RESOURCE_PATH}/{id}")
+
+    def list(self) -> LocationFilterList:
+        res = self._post(url_path=self._RESOURCE_PATH + "/list", json={"flat": True})
+        return LocationFilterList._load(res.json()["items"], cognite_client=self._cognite_client)
+
+    def retrieve_multiple(self, ids: Sequence[int]) -> LocationFilterList:
+        """Retrieve multiple LocationFilters using their IDs.
+
+        Args:
+            ids: The IDs of the LocationFilters
+
+        Returns:
+            LocationFilterList
+        """
+        identifiers = IdentifierSequence.load(ids=ids)
+        return self._retrieve_multiple(
+            identifiers=identifiers,
+            resource_cls=LocationFilter,
+            list_cls=LocationFilterList,
+            resource_path=self._RESOURCE_PATH,
+        )

cognite_toolkit/_cdf_tk/client/api/legacy/robotics/__init__.py

@@ -0,0 +1,8 @@
+from .api import RoboticsAPI
+from .capabilities import CapabilitiesAPI
+from .data_postprocessing import DataPostProcessingAPI
+from .frames import FramesAPI
+from .locations import LocationsAPI
+from .maps import MapsAPI
+
+__all__ = ["CapabilitiesAPI", "DataPostProcessingAPI", "FramesAPI", "LocationsAPI", "MapsAPI", "RoboticsAPI"]

cognite_toolkit/_cdf_tk/client/api/{robotics → legacy/robotics}/capabilities.py

@@ -5,7 +5,7 @@ from cognite.client._api_client import APIClient
 from cognite.client.utils._identifier import IdentifierSequence
 from cognite.client.utils.useful_types import SequenceNotStr
 
-from cognite_toolkit._cdf_tk.client.data_classes.robotics import (
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.robotics import (
     RobotCapability,
     RobotCapabilityList,
     RobotCapabilityWrite,

cognite_toolkit/_cdf_tk/client/api/{robotics → legacy/robotics}/data_postprocessing.py

@@ -5,7 +5,7 @@ from cognite.client._api_client import APIClient
 from cognite.client.utils._identifier import IdentifierSequence
 from cognite.client.utils.useful_types import SequenceNotStr
 
-from cognite_toolkit._cdf_tk.client.data_classes.robotics import (
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.robotics import (
     DataPostProcessing,
     DataPostProcessingList,
     DataPostProcessingWrite,

cognite_toolkit/_cdf_tk/client/api/{robotics → legacy/robotics}/frames.py

@@ -5,7 +5,7 @@ from cognite.client._api_client import APIClient
 from cognite.client.utils._identifier import IdentifierSequence
 from cognite.client.utils.useful_types import SequenceNotStr
 
-from cognite_toolkit._cdf_tk.client.data_classes.robotics import (
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.robotics import (
     Frame,
     FrameList,
     FrameWrite,

cognite_toolkit/_cdf_tk/client/api/{robotics → legacy/robotics}/locations.py

@@ -5,7 +5,7 @@ from cognite.client._api_client import APIClient
 from cognite.client.utils._identifier import IdentifierSequence
 from cognite.client.utils.useful_types import SequenceNotStr
 
-from cognite_toolkit._cdf_tk.client.data_classes.robotics import (
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.robotics import (
     Location,
     LocationList,
     LocationWrite,

cognite_toolkit/_cdf_tk/client/api/{robotics → legacy/robotics}/maps.py

@@ -5,7 +5,7 @@ from cognite.client._api_client import APIClient
 from cognite.client.utils._identifier import IdentifierSequence
 from cognite.client.utils.useful_types import SequenceNotStr
 
-from cognite_toolkit._cdf_tk.client.data_classes.robotics import (
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.robotics import (
     Map,
     MapList,
     MapWrite,

cognite_toolkit/_cdf_tk/client/api/{robotics → legacy/robotics}/robots.py

@@ -3,8 +3,8 @@ from typing import overload
 
 from cognite.client._api_client import APIClient
 
-from cognite_toolkit._cdf_tk.client.api.robotics.utlis import tmp_disable_gzip
-from cognite_toolkit._cdf_tk.client.data_classes.robotics import Robot, RobotList, RobotWrite, _RobotUpdate
+from cognite_toolkit._cdf_tk.client.api.legacy.robotics.utlis import tmp_disable_gzip
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.robotics import Robot, RobotList, RobotWrite, _RobotUpdate
 
 
 class RobotsAPI(APIClient):

cognite_toolkit/_cdf_tk/client/api/legacy/search_config.py

@@ -0,0 +1,53 @@
+from urllib.parse import urljoin
+
+from cognite.client import CogniteClient
+from cognite.client._api_client import APIClient
+from cognite.client.config import ClientConfig
+
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.search_config import (
+    SearchConfig,
+    SearchConfigList,
+    SearchConfigWrite,
+)
+
+
+class SearchConfigurationsAPI(APIClient):
+    def __init__(self, config: ClientConfig, api_version: str | None, cognite_client: CogniteClient) -> None:
+        super().__init__(config, api_version, cognite_client)
+
+    def _get_base_url_with_base_path(self) -> str:
+        """
+        This method is overridden to provide the correct base path for the Search Configurations API.
+        This method in base class APIClient appends /api/{api_version}/ to the base URL,
+        but for Search Configurations API, we need a different path structure.
+        """
+        base_path = ""
+        if self._api_version:
+            base_path = f"/apps/{self._api_version}/projects/{self._config.project}/storage/config/apps/search/views"
+        return urljoin(self._config.base_url, base_path)
+
+    def upsert(self, configuration_update: SearchConfigWrite) -> SearchConfig:
+        """Update/Create a Configuration.
+
+        Args:
+            configuration_update: The content of the configuration to update
+
+        Returns:
+            SearchConfig
+
+        """
+        res = self._post(
+            url_path="/upsert",
+            json=configuration_update.dump(),
+        )
+        return SearchConfig._load(res.json(), cognite_client=self._cognite_client)
+
+    def list(self) -> SearchConfigList:
+        """List all Configuration.
+
+        Returns:
+            SearchConfigList
+
+        """
+        res = self._post(url_path="/list")
+        return SearchConfigList._load(res.json()["items"], cognite_client=self._cognite_client)

cognite_toolkit/_cdf_tk/client/api/location_filters.py

@@ -1,112 +1,177 @@
-from collections.abc import Iterator, Sequence
-from typing import overload
-
-from cognite.client import CogniteClient
-from cognite.client._api_client import APIClient
-from cognite.client.config import ClientConfig
-from cognite.client.utils._identifier import IdentifierSequence
-
-from cognite_toolkit._cdf_tk.client.data_classes.location_filters import (
-    LocationFilter,
-    LocationFilterList,
-    LocationFilterWrite,
+from collections.abc import Iterable, Sequence
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse
+from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
+from cognite_toolkit._cdf_tk.client.http_client import (
+    HTTPClient,
+    ItemsSuccessResponse2,
+    RequestMessage2,
+    SuccessResponse2,
 )
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalId
+from cognite_toolkit._cdf_tk.client.resource_classes.location_filter import (
+    LocationFilterRequest,
+    LocationFilterResponse,
+)
+from cognite_toolkit._cdf_tk.utils.collection import chunker_sequence
 
 
-class LocationFiltersAPI(APIClient):
-    def __init__(self, config: ClientConfig, api_version: str | None, cognite_client: CogniteClient) -> None:
-        super().__init__(config, api_version, cognite_client)
-        # this is hopefully a very temporary fix to avoid the client concatinating the _RESOURCE_PATH with the ordinary /api/ path.
-        self._api_version = None
-        self._RESOURCE_PATH = f"/apps/v1/projects/{self._cognite_client.config.project}/storage/config/locationfilters"
-
-    @overload
-    def __call__(self) -> Iterator[LocationFilter]: ...
+class LocationFiltersAPI(CDFResourceAPI[InternalId, LocationFilterRequest, LocationFilterResponse]):
+    """API for managing Location Filters using the CDFResourceAPI pattern.
 
-    @overload
-    def __call__(self, chunk_size: int) -> Iterator[LocationFilterList]: ...
+    This API manages location filter configurations at:
+    /apps/v1/projects/{project}/storage/config/locationfilters
+    """
 
-    def __call__(self, chunk_size: int | None = None) -> Iterator[LocationFilter] | Iterator[LocationFilterList]:
-        """Iterate over locationfilters.
+    BASE_PATH = "/storage/config/locationfilters"
 
-        Args:
-            chunk_size: The number of locationfilters to return in each chunk. None will return all locationfilters.
-
-        Yields:
-            LocationFilter or LocationFilterList
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path=self.BASE_PATH, item_limit=1),
+                "retrieve": Endpoint(method="POST", path=f"{self.BASE_PATH}/byids", item_limit=1000),
+                "update": Endpoint(method="PUT", path=f"{self.BASE_PATH}/{{id}}", item_limit=1),
+                "delete": Endpoint(method="DELETE", path=f"{self.BASE_PATH}/{{id}}", item_limit=1),
+                "list": Endpoint(method="POST", path=f"{self.BASE_PATH}/list", item_limit=1000),
+            },
+        )
 
-        """
-        return iter(self.list())
+    def _make_url(self, path: str = "") -> str:
+        """Create the full URL for this resource endpoint using the apps URL format."""
+        return self._http_client.config.create_app_url(path)
 
-    def __iter__(self) -> Iterator[LocationFilter]:
-        return self.__call__()
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[LocationFilterResponse]:
+        return PagedResponse[LocationFilterResponse].model_validate_json(response.body)
 
-    def create(self, location_filter: LocationFilterWrite) -> LocationFilter:
-        """Create a new LocationFilter.
+    def create(self, items: Sequence[LocationFilterRequest]) -> list[LocationFilterResponse]:
+        """Create a new location filter.
 
         Args:
-            location_filter: LocationFilterWrite
-
+            items: The location filter to create.
 
         Returns:
-            LocationFilter
-
+            The created location filter.
         """
+        endpoint = self._method_endpoint_map["create"]
+        results: list[LocationFilterResponse] = []
+        for item in items:
+            request = RequestMessage2(
+                endpoint_url=self._make_url(endpoint.path),
+                method=endpoint.method,
+                body_content=item.model_dump(mode="json", by_alias=True),
+            )
+            result = self._http_client.request_single_retries(request)
+            response = result.get_success_or_raise()
+            results.append(LocationFilterResponse.model_validate_json(response.body))
+        return results
+
+    def retrieve(self, items: Sequence[InternalId]) -> list[LocationFilterResponse]:
+        """Retrieve a single location filter by ID.
 
-        res = self._post(url_path=self._RESOURCE_PATH, json=location_filter.dump())
-        return LocationFilter._load(res.json(), cognite_client=self._cognite_client)
+        Args:
+            items: The ID of the location filter to retrieve.
 
-    def retrieve(self, id: int) -> LocationFilter:
-        """Retrieve a single LocationFilter.
+        Returns:
+            The retrieved location filter.
+        """
+        endpoint = self._method_endpoint_map["retrieve"]
+        results: list[LocationFilterResponse] = []
+        for chunk in chunker_sequence(items, endpoint.item_limit):
+            request = RequestMessage2(
+                endpoint_url=self._make_url(endpoint.path),
+                method=endpoint.method,
+                body_content={"ids": [item.id for item in chunk]},
+            )
+            result = self._http_client.request_single_retries(request)
+            response = result.get_success_or_raise()
+            results.extend(self._validate_page_response(response).items)
+        return results
+
+    def update(self, items: Sequence[LocationFilterRequest]) -> list[LocationFilterResponse]:
+        """Update an existing location filter.
 
         Args:
-            id: The ID of the LocationFilter
+            items: The updated location filter data.
 
         Returns:
-            LocationFilter
+            The updated location filter.
         """
+        endpoint = self._method_endpoint_map["update"]
+        results: list[LocationFilterResponse] = []
+        for item in items:
+            if item.id is None:
+                raise ValueError("Item must have an ID for update operation.")
+            request = RequestMessage2(
+                endpoint_url=self._make_url(endpoint.path.format(id=item.id)),
+                method=endpoint.method,
+                body_content=item.model_dump(mode="json", by_alias=True),
+            )
+            result = self._http_client.request_single_retries(request)
+            response = result.get_success_or_raise()
+            parsed = LocationFilterResponse.model_validate_json(response.body)
+            parsed.id = item.id
+            results.append(parsed)
+        return results
+
+    def delete(self, items: Sequence[InternalId]) -> list[LocationFilterResponse]:
+        """Delete a location filter.
 
-        res = self._get(url_path=f"{self._RESOURCE_PATH}/{id}")
-        return LocationFilter._load(res.json(), cognite_client=self._cognite_client)
+        Args:
+            items: The ID of the location filter to delete.
 
-    def update(self, id: int, location_filter_update: LocationFilterWrite) -> LocationFilter:
-        """Update a new LocationFilter.
+        Returns:
+            list[LocationFilterResponse]: The deleted location filters.
+        """
+        endpoint = self._method_endpoint_map["delete"]
+        results: list[LocationFilterResponse] = []
+        for item in items:
+            request = RequestMessage2(
+                endpoint_url=self._make_url(endpoint.path.format(id=item.id)),
+                method=endpoint.method,
+            )
+            result = self._http_client.request_single_retries(request)
+            response = result.get_success_or_raise()
+            results.append(LocationFilterResponse.model_validate_json(response.body))
+        return results
+
+    def paginate(
+        self,
+        flat: bool = True,
+    ) -> PagedResponse[LocationFilterResponse]:
+        """Get a single page of location filters.
 
         Args:
-            id: The ID of the LocationFilter
-            location_filter_content: The content of the LocationFilter to update
+            flat: Whether to return a flat list (default True).
 
         Returns:
-            LocationFilter
-
+            PagedResponse of LocationFilterResponse objects.
         """
+        return self._paginate(cursor=None, limit=100, body={"flat": flat})
 
-        res = self._put(
-            url_path=f"{self._RESOURCE_PATH}/{id}",
-            json=location_filter_update.dump(),
-        )
-        return LocationFilter._load(res.json(), cognite_client=self._cognite_client)
+    def iterate(
+        self,
+        flat: bool = True,
+    ) -> Iterable[list[LocationFilterResponse]]:
+        """Iterate over all location filters.
 
-    def delete(self, id: int) -> None:
-        self._delete(url_path=f"{self._RESOURCE_PATH}/{id}")
+        Args:
+            flat: Whether to return a flat list (default True).
 
-    def list(self) -> LocationFilterList:
-        res = self._post(url_path=self._RESOURCE_PATH + "/list", json={"flat": True})
-        return LocationFilterList._load(res.json()["items"], cognite_client=self._cognite_client)
+        Returns:
+            Iterable of lists of LocationFilterResponse objects.
+        """
+        return self._iterate(limit=None, body={"flat": flat})
 
-    def retrieve_multiple(self, ids: Sequence[int]) -> LocationFilterList:
-        """Retrieve multiple LocationFilters using their IDs.
+    def list(self, flat: bool = True) -> list[LocationFilterResponse]:
+        """List all location filters.
 
         Args:
-            ids: The IDs of the LocationFilters
+            flat: Whether to return a flat list (default True).
 
         Returns:
-            LocationFilterList
+            List of LocationFilterResponse objects.
         """
-        identifiers = IdentifierSequence.load(ids=ids)
-        return self._retrieve_multiple(
-            identifiers=identifiers,
-            resource_cls=LocationFilter,
-            list_cls=LocationFilterList,
-            resource_path=self._RESOURCE_PATH,
-        )
+        return self._list(limit=None, body={"flat": flat})

cognite_toolkit/_cdf_tk/client/api/migration.py

@@ -16,7 +16,8 @@ from cognite.client.data_classes.data_modeling import (
 )
 from cognite.client.utils.useful_types import SequenceNotStr
 
-from cognite_toolkit._cdf_tk.client.data_classes.migration import (
+from cognite_toolkit._cdf_tk.client.api.legacy.extended_data_modeling import ExtendedInstancesAPI
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.migration import (
     AssetCentricId,
     CreatedSourceSystem,
     InstanceSource,
@@ -29,8 +30,6 @@ from cognite_toolkit._cdf_tk.tk_warnings import HighSeverityWarning
 from cognite_toolkit._cdf_tk.utils.collection import chunker_sequence
 from cognite_toolkit._cdf_tk.utils.useful_types import AssetCentricType
 
-from .extended_data_modeling import ExtendedInstancesAPI
-
 
 class InstanceSourceAPI:
     def __init__(self, instance_api: ExtendedInstancesAPI) -> None:

cognite_toolkit/_cdf_tk/client/api/project.py

@@ -1,8 +1,8 @@
 from cognite.client import CogniteClient
 
 from cognite_toolkit._cdf_tk.client.config import ToolkitClientConfig
-from cognite_toolkit._cdf_tk.client.data_classes.project import ProjectStatusList
-from cognite_toolkit._cdf_tk.utils.http_client import HTTPClient, ParamRequest
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, RequestMessage2
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.project import ProjectStatusList
 
 
 class ProjectAPI:
@@ -13,11 +13,12 @@ class ProjectAPI:
 
     def status(self) -> ProjectStatusList:
         """Retrieve information about the current project."""
-        response = self._http_client.request_with_retries(
-            ParamRequest(
-                endpoint_url=f"{self._config.base_url}/api/v1/projects?withDataModelingStatus=true", method="GET"
+        response = self._http_client.request_single_retries(
+            RequestMessage2(
+                endpoint_url=f"{self._config.base_url}/api/v1/projects",
+                method="GET",
+                parameters={"withDataModelingStatus": True},
             )
         )
-        response.raise_for_status()
-        body = response.get_first_body()
-        return ProjectStatusList._load(body["items"], cognite_client=self._cognite_client)  # type: ignore[arg-type]
+        success = response.get_success_or_raise()
+        return ProjectStatusList._load(success.body_json["items"], cognite_client=self._cognite_client)