cognite-toolkit 0.7.35__py3-none-any.whl → 0.7.37__py3-none-any.whl

cognite_toolkit/_cdf_tk/apps/_migrate_app.py

@@ -19,11 +19,13 @@ from cognite_toolkit._cdf_tk.commands._migrate.data_mapper import (
     AssetCentricMapper,
     CanvasMapper,
     ChartMapper,
+    ThreeDAssetMapper,
     ThreeDMapper,
 )
 from cognite_toolkit._cdf_tk.commands._migrate.migration_io import (
     AnnotationMigrationIO,
     AssetCentricMigrationIO,
+    ThreeDAssetMappingMigrationIO,
     ThreeDMigrationIO,
 )
 from cognite_toolkit._cdf_tk.commands._migrate.selectors import (
@@ -68,6 +70,7 @@ class MigrateApp(typer.Typer):
         self.command("canvas")(self.canvas)
         self.command("charts")(self.charts)
         self.command("3d")(self.three_d)
+        self.command("3d-mappings")(self.three_d_asset_mapping)
         # Uncomment when infield v2 config migration is ready
         # self.command("infield-configs")(self.infield_configs)
 
@@ -1054,6 +1057,104 @@ class MigrateApp(typer.Typer):
             )
         )
 
+    @staticmethod
+    def three_d_asset_mapping(
+        ctx: typer.Context,
+        model_id: Annotated[
+            list[int] | None,
+            typer.Argument(
+                help="The IDs of the 3D model to migrate asset mappings for. If not provided, an interactive selection will be "
+                "performed to select the."
+            ),
+        ] = None,
+        object_3D_space: Annotated[
+            str | None,
+            typer.Option(
+                "--object-3d-space",
+                "-o",
+                help="The instance space to ceate the 3D object nodes in.",
+            ),
+        ] = None,
+        cad_node_space: Annotated[
+            str | None,
+            typer.Option(
+                "--cad-node-space",
+                "-c",
+                help="The instance space to create the CAD node nodes in.",
+            ),
+        ] = None,
+        log_dir: Annotated[
+            Path,
+            typer.Option(
+                "--log-dir",
+                "-l",
+                help="Path to the directory where migration logs will be stored.",
+            ),
+        ] = Path(f"migration_logs_{TODAY}"),
+        dry_run: Annotated[
+            bool,
+            typer.Option(
+                "--dry-run",
+                "-d",
+                help="If set, the migration will not be executed, but only a report of what would be done is printed.",
+            ),
+        ] = False,
+        verbose: Annotated[
+            bool,
+            typer.Option(
+                "--verbose",
+                "-v",
+                help="Turn on to get more verbose output when running the command",
+            ),
+        ] = False,
+    ) -> None:
+        """Migrate 3D Model Asset Mappings from Asset-Centric to data modeling in CDF.
+
+        This command expects that the selected 3D model has already been migrated to data modeling.
+        """
+        client = EnvironmentVariables.create_from_environment().get_client()
+        selected_ids: list[int]
+        if model_id is not None:
+            selected_ids = model_id
+        else:
+            # Interactive selection
+            selected_models = ThreeDInteractiveSelect(client, "migrate").select_three_d_models("dm")
+            selected_ids = [model.id for model in selected_models]
+            space_selector = DataModelingSelect(client, "migrate")
+            object_3D_space = space_selector.select_instance_space(
+                multiselect=False,
+                message="In which instance space do you want to create the 3D Object nodes?",
+                include_empty=False,
+            )
+            cad_node_space = space_selector.select_instance_space(
+                multiselect=False,
+                message="In which instance space do you want to create the CAD Node nodes?",
+                include_empty=False,
+            )
+            dry_run = questionary.confirm("Do you want to perform a dry run?", default=dry_run).ask()
+            verbose = questionary.confirm("Do you want verbose output?", default=verbose).ask()
+            if any(res is None for res in [dry_run, verbose]):
+                raise typer.Abort()
+
+        if object_3D_space is None or cad_node_space is None:
+            raise typer.BadParameter(
+                "--object-3d-space and --cad-node-space are required when specifying IDs directly."
+            )
+
+        cmd = MigrationCommand()
+        cmd.run(
+            lambda: cmd.migrate(
+                selected=ThreeDModelIdSelector(ids=tuple(selected_ids)),
+                data=ThreeDAssetMappingMigrationIO(
+                    client, object_3D_space=object_3D_space, cad_node_space=cad_node_space
+                ),
+                mapper=ThreeDAssetMapper(client),
+                log_dir=log_dir,
+                dry_run=dry_run,
+                verbose=verbose,
+            )
+        )
+
     @staticmethod
     def infield_configs(
         ctx: typer.Context,

cognite_toolkit/_cdf_tk/client/api/infield.py

@@ -4,7 +4,7 @@ from typing import Any, cast
 from pydantic import TypeAdapter
 from rich.console import Console
 
-from cognite_toolkit._cdf_tk.client.data_classes.api_classes import PagedResponse, QueryResponse
+from cognite_toolkit._cdf_tk.client.data_classes.api_classes import QueryResponse
 from cognite_toolkit._cdf_tk.client.data_classes.infield import (
     DataExplorationConfig,
     InFieldCDMLocationConfig,
@@ -13,12 +13,11 @@ from cognite_toolkit._cdf_tk.client.data_classes.infield import (
 from cognite_toolkit._cdf_tk.client.data_classes.instance_api import (
     InstanceResponseItem,
     InstanceResult,
-    NodeIdentifier,
+    TypedNodeIdentifier,
 )
 from cognite_toolkit._cdf_tk.tk_warnings import HighSeverityWarning
 from cognite_toolkit._cdf_tk.utils.http_client import (
     HTTPClient,
-    ItemsRequest,
     ItemsRequest2,
     RequestMessage2,
 )
@@ -56,7 +55,7 @@ class InfieldConfigAPI:
         responses.raise_for_status()
         return TypeAdapter(list[InstanceResult]).validate_python(responses.get_items())
 
-    def retrieve(self, items: Sequence[NodeIdentifier]) -> list[InfieldLocationConfig]:
+    def retrieve(self, items: Sequence[TypedNodeIdentifier]) -> list[InfieldLocationConfig]:
         if len(items) > 100:
             raise ValueError("Cannot retrieve more than 100 InfieldLocationConfig items at once.")
         if not items:
@@ -73,7 +72,7 @@ class InfieldConfigAPI:
         parsed_response = QueryResponse[InstanceResponseItem].model_validate(success.body_json)
         return self._parse_retrieve_response(parsed_response)
 
-    def delete(self, items: Sequence[InfieldLocationConfig]) -> list[NodeIdentifier]:
+    def delete(self, items: Sequence[InfieldLocationConfig]) -> list[TypedNodeIdentifier]:
         if len(items) > 500:
             raise ValueError("Cannot delete more than 500 InfieldLocationConfig items at once.")
 
@@ -83,18 +82,18 @@ class InfieldConfigAPI:
             else [item.as_id(), item.data_exploration_config.as_id()]
             for item in items
         )
-        responses = self._http_client.request_with_retries(
-            ItemsRequest(
+        responses = self._http_client.request_items_retries(
+            ItemsRequest2(
                 endpoint_url=self._config.create_api_url(f"{self.ENDPOINT}/delete"),
                 method="POST",
                 items=[identifier for sublist in identifiers for identifier in sublist],
             )
         )
         responses.raise_for_status()
-        return PagedResponse[NodeIdentifier].model_validate(responses.get_first_body()).items
+        return TypeAdapter(list[TypedNodeIdentifier]).validate_python(responses.get_items())
 
     @classmethod
-    def _retrieve_query(cls, items: Sequence[NodeIdentifier]) -> dict[str, Any]:
+    def _retrieve_query(cls, items: Sequence[TypedNodeIdentifier]) -> dict[str, Any]:
         return {
             "with": {
                 cls.LOCATION_REF: {
@@ -184,7 +183,7 @@ class InFieldCDMConfigAPI:
         results.raise_for_status()
         return TypeAdapter(list[InstanceResult]).validate_python(results.get_items())
 
-    def retrieve(self, items: Sequence[NodeIdentifier]) -> list[InFieldCDMLocationConfig]:
+    def retrieve(self, items: Sequence[TypedNodeIdentifier]) -> list[InFieldCDMLocationConfig]:
         if len(items) > 100:
             raise ValueError("Cannot retrieve more than 100 InFieldCDMLocationConfig items at once.")
         if not items:
@@ -200,23 +199,23 @@ class InFieldCDMConfigAPI:
         parsed_response = QueryResponse[InstanceResponseItem].model_validate(success.body_json)
         return self._parse_retrieve_response(parsed_response)
 
-    def delete(self, items: Sequence[InFieldCDMLocationConfig]) -> list[NodeIdentifier]:
+    def delete(self, items: Sequence[InFieldCDMLocationConfig]) -> list[TypedNodeIdentifier]:
         if len(items) > 500:
             raise ValueError("Cannot delete more than 500 InFieldCDMLocationConfig items at once.")
 
-        identifiers: Sequence = [item.as_id() for item in items]
-        responses = self._http_client.request_with_retries(
-            ItemsRequest(
+        identifiers = [item.as_id() for item in items]
+        responses = self._http_client.request_items_retries(
+            ItemsRequest2(
                 endpoint_url=self._config.create_api_url(f"{self.ENDPOINT}/delete"),
                 method="POST",
-                items=identifiers,  # type: ignore[arg-type]
+                items=identifiers,
             )
         )
         responses.raise_for_status()
-        return PagedResponse[NodeIdentifier].model_validate(responses.get_first_body()).items
+        return TypeAdapter(list[TypedNodeIdentifier]).validate_python(responses.get_items())
 
     @classmethod
-    def _retrieve_query(cls, items: Sequence[NodeIdentifier]) -> dict[str, Any]:
+    def _retrieve_query(cls, items: Sequence[TypedNodeIdentifier]) -> dict[str, Any]:
         return {
             "with": {
                 cls.LOCATION_REF: {

cognite_toolkit/_cdf_tk/client/api/streams.py

@@ -8,7 +8,6 @@ from cognite_toolkit._cdf_tk.client.data_classes.streams import StreamRequest, S
 from cognite_toolkit._cdf_tk.utils.http_client import (
     HTTPClient,
     ItemsRequest2,
-    ParamRequest,
     RequestMessage2,
 )
 
@@ -46,13 +45,13 @@ class StreamsAPI:
         Args:
             external_id: External ID of the stream to delete.
         """
-        responses = self._http_client.request_with_retries(
-            ParamRequest(
+        response = self._http_client.request_single_retries(
+            RequestMessage2(
                 endpoint_url=self._config.create_api_url(f"{self.ENDPOINT}/{external_id}"),
                 method="DELETE",
             )
         )
-        responses.raise_for_status()
+        _ = response.get_success_or_raise()
 
     def list(self) -> list[StreamResponse]:
         """List streams.

cognite_toolkit/_cdf_tk/client/api/three_d.py

@@ -1,14 +1,23 @@
-from collections.abc import Sequence
+from collections import defaultdict
+from collections.abc import Iterable, Sequence
+from typing import Any, TypeVar
 
+from pydantic import TypeAdapter
 from rich.console import Console
 
-from cognite_toolkit._cdf_tk.client.data_classes.api_classes import PagedResponse
-from cognite_toolkit._cdf_tk.client.data_classes.three_d import ThreeDModelClassicRequest, ThreeDModelResponse
+from cognite_toolkit._cdf_tk.client.data_classes.api_classes import InternalIdRequest, PagedResponse
+from cognite_toolkit._cdf_tk.client.data_classes.three_d import (
+    AssetMappingClassicRequest,
+    AssetMappingDMRequest,
+    AssetMappingResponse,
+    ThreeDModelClassicRequest,
+    ThreeDModelResponse,
+)
+from cognite_toolkit._cdf_tk.utils.collection import chunker_sequence
 from cognite_toolkit._cdf_tk.utils.http_client import (
     HTTPClient,
-    ItemsRequest,
+    ItemsRequest2,
     RequestMessage2,
-    SimpleBodyRequest,
 )
 from cognite_toolkit._cdf_tk.utils.useful_types import PrimitiveType
 
@@ -37,16 +46,15 @@ class ThreeDModelAPI:
             return []
         if len(models) > self.MAX_CLASSIC_MODELS_PER_CREATE_REQUEST:
             raise ValueError("Cannot create more than 1000 3D models in a single request.")
-        responses = self._http_client.request_with_retries(
-            ItemsRequest(
+        responses = self._http_client.request_items_retries(
+            ItemsRequest2(
                 endpoint_url=self._config.create_api_url(self.ENDPOINT),
                 method="POST",
-                items=list(models),
+                items=models,
             )
         )
         responses.raise_for_status()
-        body = responses.get_first_body()
-        return PagedResponse[ThreeDModelResponse].model_validate(body).items
+        return TypeAdapter(list[ThreeDModelResponse]).validate_python(responses.get_items())
 
     def delete(self, ids: Sequence[int]) -> None:
         """Delete 3D models by their IDs.
@@ -58,11 +66,11 @@ class ThreeDModelAPI:
             return None
         if len(ids) > self.MAX_MODELS_PER_DELETE_REQUEST:
             raise ValueError("Cannot delete more than 1000 3D models in a single request.")
-        responses = self._http_client.request_with_retries(
-            SimpleBodyRequest(
+        responses = self._http_client.request_items_retries(
+            ItemsRequest2(
                 endpoint_url=self._config.create_api_url(self.ENDPOINT + "/delete"),
                 method="POST",
-                body_content={"items": [{"id": id_} for id_ in ids]},
+                items=InternalIdRequest.from_ids(list(ids)),
             )
         )
         responses.raise_for_status()
@@ -126,6 +134,251 @@ class ThreeDModelAPI:
         return results
 
 
+T_RequestMapping = TypeVar("T_RequestMapping", bound=AssetMappingClassicRequest | AssetMappingDMRequest)
+
+
+class ThreeDAssetMappingAPI:
+    ENDPOINT = "/3d/models/{modelId}/revisions/{revisionId}/mappings"
+    CREATE_CLASSIC_MAX_MAPPINGS_PER_REQUEST = 1000
+    CREATE_DM_MAX_MAPPINGS_PER_REQUEST = 100
+    DELETE_CLASSIC_MAX_MAPPINGS_PER_REQUEST = 1000
+    DELETE_DM_MAX_MAPPINGS_PER_REQUEST = 100
+    LIST_REQUEST_MAX_LIMIT = 1000
+
+    def __init__(self, http_client: HTTPClient, console: Console) -> None:
+        self._http_client = http_client
+        self._console = console
+        self._config = http_client.config
+
+    def create(self, mappings: Sequence[AssetMappingClassicRequest]) -> list[AssetMappingResponse]:
+        """Create 3D asset mappings.
+
+        Args:
+            mappings (Sequence[AssetMappingClassicRequest]):
+                The 3D asset mapping(s) to create.
+
+        Returns:
+            list[AssetMappingResponse]: The created 3D asset mapping(s).
+        """
+        results: list[AssetMappingResponse] = []
+        for endpoint, model_id, revision_id, revision_mappings in self._chunk_mappings_by_endpoint(
+            mappings, self.CREATE_CLASSIC_MAX_MAPPINGS_PER_REQUEST
+        ):
+            responses = self._http_client.request_items_retries(
+                ItemsRequest2(
+                    endpoint_url=self._config.create_api_url(endpoint),
+                    method="POST",
+                    items=revision_mappings,
+                )
+            )
+            responses.raise_for_status()
+            items = responses.get_items()
+            for item in items:
+                # We append modelId and revisionId to each item since the API does not return them
+                # this is needed to fully populate the AssetMappingResponse data class
+                item["modelId"] = model_id
+                item["revisionId"] = revision_id
+            results.extend(TypeAdapter(list[AssetMappingResponse]).validate_python(items))
+        return results
+
+    def create_dm(
+        self, mappings: Sequence[AssetMappingDMRequest], object_3d_space: str, cad_node_space: str
+    ) -> list[AssetMappingResponse]:
+        """Create 3D asset mappings in Data Modeling format.
+
+        Args:
+            mappings (Sequence[AssetMappingDMRequest]):
+                The 3D asset mapping(s) to create
+            object_3d_space (str):
+                The instance space where the Cognite3DObject are located.
+            cad_node_space (str):
+                The instance space where the CogniteCADNode are located.
+        Returns:
+            list[AssetMappingResponse]: The created 3D asset mapping(s).
+        """
+        results: list[AssetMappingResponse] = []
+        for endpoint, model_id, revision_id, revision_mappings in self._chunk_mappings_by_endpoint(
+            mappings, self.CREATE_DM_MAX_MAPPINGS_PER_REQUEST
+        ):
+            responses = self._http_client.request_items_retries(
+                ItemsRequest2(
+                    endpoint_url=self._config.create_api_url(endpoint),
+                    method="POST",
+                    items=revision_mappings,
+                    extra_body_fields={
+                        "dmsContextualizationConfig": {
+                            "object3DSpace": object_3d_space,
+                            "cadNodeSpace": cad_node_space,
+                        }
+                    },
+                )
+            )
+            responses.raise_for_status()
+            items = responses.get_items()
+            for item in items:
+                # We append modelId and revisionId to each item since the API does not return them
+                # this is needed to fully populate the AssetMappingResponse data class
+                item["modelId"] = model_id
+                item["revisionId"] = revision_id
+            results.extend(TypeAdapter(list[AssetMappingResponse]).validate_python(items))
+        return results
+
+    @classmethod
+    def _chunk_mappings_by_endpoint(
+        cls, mappings: Sequence[T_RequestMapping], chunk_size: int
+    ) -> Iterable[tuple[str, int, int, list[T_RequestMapping]]]:
+        chunked_mappings: dict[tuple[int, int], list[T_RequestMapping]] = defaultdict(list)
+        for mapping in mappings:
+            key = mapping.model_id, mapping.revision_id
+            chunked_mappings[key].append(mapping)
+        for (model_id, revision_id), revision_mappings in chunked_mappings.items():
+            endpoint = cls.ENDPOINT.format(modelId=model_id, revisionId=revision_id)
+            for chunk in chunker_sequence(revision_mappings, chunk_size):
+                yield endpoint, model_id, revision_id, chunk
+
+    def delete(self, mappings: Sequence[AssetMappingClassicRequest]) -> None:
+        """Delete 3D asset mappings.
+
+        Args:
+            mappings (Sequence[AssetMappingClassicRequest]):
+                The 3D asset mapping(s) to delete.
+        """
+        for endpoint, *_, revision_mappings in self._chunk_mappings_by_endpoint(
+            mappings, self.DELETE_CLASSIC_MAX_MAPPINGS_PER_REQUEST
+        ):
+            responses = self._http_client.request_items_retries(
+                ItemsRequest2(
+                    endpoint_url=self._config.create_api_url(f"{endpoint}/delete"),
+                    method="DELETE",
+                    items=revision_mappings,
+                )
+            )
+            responses.raise_for_status()
+        return None
+
+    def delete_dm(self, mappings: Sequence[AssetMappingDMRequest], object_3d_space: str, cad_node_space: str) -> None:
+        """Delete 3D asset mappings in Data Modeling format.
+
+        Args:
+            mappings (Sequence[AssetMappingDMRequest]):
+                The 3D asset mapping(s) to delete.
+            object_3d_space (str):
+                The instance space where the Cognite3DObject are located.
+            cad_node_space (str):
+                The instance space where the CogniteCADNode are located.
+        """
+        for endpoint, *_, revision_mappings in self._chunk_mappings_by_endpoint(
+            mappings, self.DELETE_DM_MAX_MAPPINGS_PER_REQUEST
+        ):
+            responses = self._http_client.request_items_retries(
+                ItemsRequest2(
+                    endpoint_url=self._config.create_api_url(f"{endpoint}/delete"),
+                    method="DELETE",
+                    items=revision_mappings,
+                    extra_body_fields={
+                        "dmsContextualizationConfig": {
+                            "object3DSpace": object_3d_space,
+                            "cadNodeSpace": cad_node_space,
+                        }
+                    },
+                )
+            )
+            responses.raise_for_status()
+        return None
+
+    def iterate(
+        self,
+        model_id: int,
+        revision_id: int,
+        asset_ids: list[int] | None = None,
+        asset_instance_ids: list[str] | None = None,
+        node_ids: list[int] | None = None,
+        tree_indexes: list[int] | None = None,
+        get_dms_instances: bool = False,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[AssetMappingResponse]:
+        if not (0 < limit <= self.LIST_REQUEST_MAX_LIMIT):
+            raise ValueError(f"Limit must be between 1 and {self.LIST_REQUEST_MAX_LIMIT}, got {limit}.")
+        if sum(param is not None for param in [asset_ids, asset_instance_ids, node_ids, tree_indexes]) > 1:
+            raise ValueError("Only one of asset_ids, asset_instance_ids, node_ids, or tree_indexes can be provided.")
+        body: dict[str, Any] = {
+            "getDmsInstances": get_dms_instances,
+            "limit": limit,
+        }
+        if asset_ids is not None:
+            if not (0 < len(asset_ids) <= 100):
+                raise ValueError("asset_ids must contain between 1 and 100 IDs.")
+            body["filter"] = {"assetIds": asset_ids}
+        elif asset_instance_ids is not None:
+            if not (0 < len(asset_instance_ids) <= 100):
+                raise ValueError("asset_instance_ids must contain between 1 and 100 IDs.")
+            body["filter"] = {"assetInstanceIds": asset_instance_ids}
+        elif node_ids is not None:
+            if not (0 < len(node_ids) <= 100):
+                raise ValueError("node_ids must contain between 1 and 100 IDs.")
+            body["filter"] = {"nodeIds": node_ids}
+        elif tree_indexes is not None:
+            if not (0 < len(tree_indexes) <= 100):
+                raise ValueError("tree_indexes must contain between 1 and 100 indexes.")
+            body["filter"] = {"treeIndexes": tree_indexes}
+        if cursor is not None:
+            body["cursor"] = cursor
+
+        endpoint = self.ENDPOINT.format(modelId=model_id, revisionId=revision_id)
+        responses = self._http_client.request_single_retries(
+            RequestMessage2(
+                endpoint_url=self._config.create_api_url(f"{endpoint}/list"),
+                method="POST",
+                body_content=body,
+            )
+        )
+        success_response = responses.get_success_or_raise()
+        body_json = success_response.body_json
+        # Add modelId and revisionId to items since the API does not return them
+        for item in body_json.get("items", []):
+            item["modelId"] = model_id
+            item["revisionId"] = revision_id
+        return PagedResponse[AssetMappingResponse].model_validate(body_json)
+
+    def list(
+        self,
+        model_id: int,
+        revision_id: int,
+        asset_ids: list[int] | None = None,
+        asset_instance_ids: list[str] | None = None,
+        node_ids: list[int] | None = None,
+        tree_indexes: list[int] | None = None,
+        get_dms_instances: bool = False,
+        limit: int | None = 100,
+    ) -> list[AssetMappingResponse]:
+        results: list[AssetMappingResponse] = []
+        cursor: str | None = None
+        while True:
+            request_limit = (
+                self.LIST_REQUEST_MAX_LIMIT if limit is None else min(limit - len(results), self.LIST_REQUEST_MAX_LIMIT)
+            )
+            if request_limit <= 0:
+                break
+            page = self.iterate(
+                model_id=model_id,
+                revision_id=revision_id,
+                asset_ids=asset_ids,
+                asset_instance_ids=asset_instance_ids,
+                node_ids=node_ids,
+                tree_indexes=tree_indexes,
+                get_dms_instances=get_dms_instances,
+                limit=request_limit,
+                cursor=cursor,
+            )
+            results.extend(page.items)
+            if page.next_cursor is None:
+                break
+            cursor = page.next_cursor
+        return results
+
+
 class ThreeDAPI:
     def __init__(self, http_client: HTTPClient, console: Console) -> None:
         self.models = ThreeDModelAPI(http_client, console)
+        self.asset_mappings = ThreeDAssetMappingAPI(http_client, console)

cognite_toolkit/_cdf_tk/client/data_classes/api_classes.py

@@ -2,6 +2,8 @@ from typing import Generic, TypeVar
 
 from pydantic import BaseModel, Field, JsonValue
 
+from cognite_toolkit._cdf_tk.utils.http_client._data_classes2 import RequestResource
+
 T = TypeVar("T", bound=BaseModel)
 
 
@@ -15,3 +17,14 @@ class QueryResponse(BaseModel, Generic[T]):
     typing: dict[str, JsonValue] | None = None
     next_cursor: dict[str, str] = Field(alias="nextCursor")
     debug: dict[str, JsonValue] | None = None
+
+
+class InternalIdRequest(RequestResource):
+    id: int
+
+    def as_id(self) -> int:
+        return self.id
+
+    @classmethod
+    def from_ids(cls, ids: list[int]) -> list["InternalIdRequest"]:
+        return [cls(id=id_) for id_ in ids]

cognite_toolkit/_cdf_tk/client/data_classes/base.py

@@ -3,7 +3,7 @@ from abc import ABC, abstractmethod
 from collections import UserList
 from typing import TYPE_CHECKING, Any, Generic, TypeVar
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import ConfigDict
 from pydantic.alias_generators import to_camel
 
 from cognite_toolkit._cdf_tk.utils.http_client._data_classes2 import BaseModelObject, RequestResource
@@ -31,21 +31,17 @@ class ResponseResource(BaseModelObject, Generic[T_RequestResource], ABC):
         return self.as_request_resource()
 
 
-class Identifier(BaseModel):
+class Identifier(RequestResource, ABC):
     """Base class for all identifier classes."""
 
     model_config = ConfigDict(alias_generator=to_camel, extra="ignore", populate_by_name=True, frozen=True)
 
-    def dump(self, include_type: bool = True) -> dict[str, Any]:
-        """Dump the identifier to a dictionary.
+    def dump(self, camel_case: bool = True, include_type: bool = True) -> dict[str, Any]:
+        """Dump the resource to a dictionary.
 
-        Args:
-            include_type (bool): Whether to include the type of the identifier in the output.
-
-        Returns:
-            dict[str, Any]: The dumped identifier.
+        This is the default serialization method for request resources.
         """
-        return self.model_dump(mode="json", by_alias=True, exclude_defaults=not include_type)
+        return self.model_dump(mode="json", by_alias=camel_case, exclude_unset=not include_type)
 
     def as_id(self) -> Self:
         return self

cognite_toolkit/_cdf_tk/client/data_classes/instance_api.py

@@ -15,19 +15,19 @@ class TypedInstanceIdentifier(Identifier):
     external_id: str
 
 
-class InstanceIdentifier(Identifier):
-    space: str
-    external_id: str
-
-
-class NodeIdentifier(TypedInstanceIdentifier):
+class TypedNodeIdentifier(TypedInstanceIdentifier):
     instance_type: Literal["node"] = "node"
 
 
-class EdgeIdentifier(TypedInstanceIdentifier):
+class TypedEdgeIdentifier(TypedInstanceIdentifier):
     instance_type: Literal["edge"] = "edge"
 
 
+class InstanceIdentifier(Identifier):
+    space: str
+    external_id: str
+
+
 class InstanceResult(BaseModelObject):
     instance_type: InstanceType
     version: int