cognite-toolkit 0.7.46__py3-none-any.whl → 0.7.48__py3-none-any.whl

cognite_toolkit/_cdf_tk/client/api/robotics_frames.py

@@ -0,0 +1,122 @@
+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.resource_classes.identifiers import ExternalId
+from cognite_toolkit._cdf_tk.client.resource_classes.robotics._frame import RobotFrameRequest, RobotFrameResponse
+
+
+class FramesAPI(CDFResourceAPI[ExternalId, RobotFrameRequest, RobotFrameResponse]):
+    """API for managing Frame resources in CDF."""
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/robotics/frames", item_limit=1000, concurrency_max_workers=1),
+                "retrieve": Endpoint(
+                    method="POST", path="/robotics/frames/byids", item_limit=1000, concurrency_max_workers=1
+                ),
+                "update": Endpoint(
+                    method="POST", path="/robotics/frames/update", item_limit=1000, concurrency_max_workers=1
+                ),
+                "delete": Endpoint(
+                    method="POST", path="/robotics/frames/delete", item_limit=1000, concurrency_max_workers=1
+                ),
+                "list": Endpoint(method="GET", path="/robotics/frames", item_limit=1000),
+            },
+            disable_gzip=True,
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[RobotFrameResponse]:
+        return PagedResponse[RobotFrameResponse].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[RobotFrameRequest]) -> list[RobotFrameResponse]:
+        """Create frames in CDF.
+
+        Args:
+            items: List of RobotFrameRequest objects to create.
+        Returns:
+            List of created RobotFrameResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(self, items: Sequence[ExternalId]) -> list[RobotFrameResponse]:
+        """Retrieve frames from CDF.
+
+        Args:
+            items: List of ExternalId objects to retrieve.
+        Returns:
+            List of retrieved RobotFrameResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve")
+
+    def update(
+        self, items: Sequence[RobotFrameRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[RobotFrameResponse]:
+        """Update frames in CDF.
+
+        Args:
+            items: List of RobotFrameRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated RobotFrameResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[ExternalId]) -> None:
+        """Delete frames from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[RobotFrameResponse]:
+        """Paginate over frames in CDF.
+
+        Args:
+            limit: Maximum number of items per page.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of RobotFrameResponse objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit)
+
+    def iterate(
+        self,
+        limit: int | None = 100,
+    ) -> Iterable[list[RobotFrameResponse]]:
+        """Iterate over all frames in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None returns all.
+
+        Returns:
+            Iterable of lists of RobotFrameResponse objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = 100) -> list[RobotFrameResponse]:
+        """List all frames in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None returns all.
+
+        Returns:
+            List of RobotFrameResponse objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/robotics_locations.py

@@ -0,0 +1,127 @@
+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.resource_classes.identifiers import ExternalId
+from cognite_toolkit._cdf_tk.client.resource_classes.robotics._location import (
+    RobotLocationRequest,
+    RobotLocationResponse,
+)
+
+
+class LocationsAPI(CDFResourceAPI[ExternalId, RobotLocationRequest, RobotLocationResponse]):
+    """API for managing Location resources in CDF."""
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(
+                    method="POST", path="/robotics/locations", item_limit=1000, concurrency_max_workers=1
+                ),
+                "retrieve": Endpoint(
+                    method="POST", path="/robotics/locations/byids", item_limit=1000, concurrency_max_workers=1
+                ),
+                "update": Endpoint(
+                    method="POST", path="/robotics/locations/update", item_limit=1000, concurrency_max_workers=1
+                ),
+                "delete": Endpoint(
+                    method="POST", path="/robotics/locations/delete", item_limit=1000, concurrency_max_workers=1
+                ),
+                "list": Endpoint(method="GET", path="/robotics/locations", item_limit=1000),
+            },
+            disable_gzip=True,
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[RobotLocationResponse]:
+        return PagedResponse[RobotLocationResponse].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[RobotLocationRequest]) -> list[RobotLocationResponse]:
+        """Create locations in CDF.
+
+        Args:
+            items: List of RobotLocationRequest objects to create.
+        Returns:
+            List of created RobotLocationResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(self, items: Sequence[ExternalId]) -> list[RobotLocationResponse]:
+        """Retrieve locations from CDF.
+
+        Args:
+            items: List of ExternalId objects to retrieve.
+        Returns:
+            List of retrieved RobotLocationResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve")
+
+    def update(
+        self, items: Sequence[RobotLocationRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[RobotLocationResponse]:
+        """Update locations in CDF.
+
+        Args:
+            items: List of RobotLocationRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated RobotLocationResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[ExternalId]) -> None:
+        """Delete locations from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[RobotLocationResponse]:
+        """Paginate over locations in CDF.
+
+        Args:
+            limit: Maximum number of items per page.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of RobotLocationResponse objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit)
+
+    def iterate(
+        self,
+        limit: int | None = 100,
+    ) -> Iterable[list[RobotLocationResponse]]:
+        """Iterate over all locations in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None returns all.
+
+        Returns:
+            Iterable of lists of RobotLocationResponse objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = 100) -> list[RobotLocationResponse]:
+        """List all locations in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None returns all.
+
+        Returns:
+            List of RobotLocationResponse objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/robotics_maps.py

@@ -0,0 +1,122 @@
+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.resource_classes.identifiers import ExternalId
+from cognite_toolkit._cdf_tk.client.resource_classes.robotics._map import RobotMapRequest, RobotMapResponse
+
+
+class MapsAPI(CDFResourceAPI[ExternalId, RobotMapRequest, RobotMapResponse]):
+    """API for managing Map resources in CDF."""
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/robotics/maps", item_limit=1000, concurrency_max_workers=1),
+                "retrieve": Endpoint(
+                    method="POST", path="/robotics/maps/byids", item_limit=1000, concurrency_max_workers=1
+                ),
+                "update": Endpoint(
+                    method="POST", path="/robotics/maps/update", item_limit=1000, concurrency_max_workers=1
+                ),
+                "delete": Endpoint(
+                    method="POST", path="/robotics/maps/delete", item_limit=1000, concurrency_max_workers=1
+                ),
+                "list": Endpoint(method="GET", path="/robotics/maps", item_limit=1000),
+            },
+            disable_gzip=True,
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[RobotMapResponse]:
+        return PagedResponse[RobotMapResponse].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[RobotMapRequest]) -> list[RobotMapResponse]:
+        """Create maps in CDF.
+
+        Args:
+            items: List of RobotMapRequest objects to create.
+        Returns:
+            List of created RobotMapResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(self, items: Sequence[ExternalId]) -> list[RobotMapResponse]:
+        """Retrieve maps from CDF.
+
+        Args:
+            items: List of ExternalId objects to retrieve.
+        Returns:
+            List of retrieved RobotMapResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve")
+
+    def update(
+        self, items: Sequence[RobotMapRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[RobotMapResponse]:
+        """Update maps in CDF.
+
+        Args:
+            items: List of RobotMapRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated RobotMapResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[ExternalId]) -> None:
+        """Delete maps from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[RobotMapResponse]:
+        """Paginate over maps in CDF.
+
+        Args:
+            limit: Maximum number of items per page.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of RobotMapResponse objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit)
+
+    def iterate(
+        self,
+        limit: int | None = 100,
+    ) -> Iterable[list[RobotMapResponse]]:
+        """Iterate over all maps in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None returns all.
+
+        Returns:
+            Iterable of lists of RobotMapResponse objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = 100) -> list[RobotMapResponse]:
+        """List all maps in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None returns all.
+
+        Returns:
+            List of RobotMapResponse objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/robotics_robots.py

@@ -0,0 +1,122 @@
+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.resource_classes.identifiers import DataSetId
+from cognite_toolkit._cdf_tk.client.resource_classes.robotics._robot import RobotRequest, RobotResponse
+
+
+class RobotsAPI(CDFResourceAPI[DataSetId, RobotRequest, RobotResponse]):
+    """API for managing Robot resources in CDF."""
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/robotics/robots", item_limit=1000, concurrency_max_workers=1),
+                "retrieve": Endpoint(
+                    method="POST", path="/robotics/robots/byids", item_limit=1000, concurrency_max_workers=1
+                ),
+                "update": Endpoint(
+                    method="POST", path="/robotics/robots/update", item_limit=1000, concurrency_max_workers=1
+                ),
+                "delete": Endpoint(
+                    method="POST", path="/robotics/robots/delete", item_limit=1000, concurrency_max_workers=1
+                ),
+                "list": Endpoint(method="GET", path="/robotics/robots", item_limit=1000),
+            },
+            disable_gzip=True,
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[RobotResponse]:
+        return PagedResponse[RobotResponse].model_validate_json(response.body)
+
+    def _reference_response(self, response: SuccessResponse2) -> ResponseItems[DataSetId]:
+        return ResponseItems[DataSetId].model_validate_json(response.body)
+
+    def create(self, items: Sequence[RobotRequest]) -> list[RobotResponse]:
+        """Create robots in CDF.
+
+        Args:
+            items: List of RobotRequest objects to create.
+        Returns:
+            List of created RobotResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(self, items: Sequence[DataSetId]) -> list[RobotResponse]:
+        """Retrieve robots from CDF.
+
+        Args:
+            items: List of DataSetId objects to retrieve.
+        Returns:
+            List of retrieved RobotResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve")
+
+    def update(
+        self, items: Sequence[RobotRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[RobotResponse]:
+        """Update robots in CDF.
+
+        Args:
+            items: List of RobotRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated RobotResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[DataSetId]) -> None:
+        """Delete robots from CDF.
+
+        Args:
+            items: List of DataSetId objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[RobotResponse]:
+        """Paginate over robots in CDF.
+
+        Args:
+            limit: Maximum number of items per page.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of RobotResponse objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit)
+
+    def iterate(
+        self,
+        limit: int | None = 100,
+    ) -> Iterable[list[RobotResponse]]:
+        """Iterate over all robots in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None returns all.
+
+        Returns:
+            Iterable of lists of RobotResponse objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = 100) -> list[RobotResponse]:
+        """List all robots in CDF.
+
+        Args:
+            limit: Maximum number of items to return. None returns all.
+
+        Returns:
+            List of RobotResponse objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit/_cdf_tk/client/api/search_config.py

@@ -0,0 +1,101 @@
+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.search_config import (
+    SearchConfigRequest,
+    SearchConfigResponse,
+    SearchConfigViewId,
+)
+
+
+class SearchConfigurationsAPI(CDFResourceAPI[SearchConfigViewId, SearchConfigRequest, SearchConfigResponse]):
+    """API for managing Search Configurations using the CDFResourceAPI pattern.
+
+    This API manages search view configurations at:
+    /apps/v1/projects/{project}/storage/config/apps/search/views
+    """
+
+    BASE_PATH = "/storage/config/apps/search/views"
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "upsert": Endpoint(method="POST", path=f"{self.BASE_PATH}/upsert", item_limit=1),
+                "list": Endpoint(method="POST", path=f"{self.BASE_PATH}/list", item_limit=1000),
+            },
+        )
+
+    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 _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[SearchConfigResponse]:
+        return PagedResponse[SearchConfigResponse].model_validate_json(response.body)
+
+    def create(self, items: Sequence[SearchConfigRequest]) -> list[SearchConfigResponse]:
+        """Create or update a search configurations.
+
+        Args:
+            items: The search configuration to create or update.
+
+        Returns:
+            The created or updated search configurations.
+        """
+        endpoint = self._method_endpoint_map["upsert"]
+        results: list[SearchConfigResponse] = []
+        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(SearchConfigResponse.model_validate_json(response.body))
+        return results
+
+    def update(self, items: Sequence[SearchConfigRequest]) -> list[SearchConfigResponse]:
+        """Update a search configurations.
+
+        Args:
+            items: The search configuration to update.
+
+        Returns:
+            The updated search configurations.
+        """
+        return self.create(items)
+
+    def paginate(self) -> PagedResponse[SearchConfigResponse]:
+        """Get a single page of search configurations.
+
+        Returns:
+            PagedResponse of SearchConfigResponse objects.
+        """
+        return self._paginate(cursor=None, limit=100)
+
+    def iterate(self) -> Iterable[list[SearchConfigResponse]]:
+        """Iterate over all search configurations.
+
+        Returns:
+            Iterable of lists of SearchConfigResponse objects.
+        """
+        return self._iterate(limit=None)
+
+    def list(self) -> list[SearchConfigResponse]:
+        """List all search configurations.
+
+
+        Returns:
+            List of SearchConfigResponse objects.
+        """
+        return self._list(limit=None)