refactor; Setup API shell

Author: doctrino

cognite/client/_api/iam.py

@@ -7,6 +7,7 @@
 
 from typing_extensions import TypeAlias
 
+from cognite.client._api.projects import ProjectsAPI
 from cognite.client._api.user_profiles import UserProfilesAPI
 from cognite.client._api_client import APIClient
 from cognite.client._constants import DEFAULT_LIMIT_READ
@@ -89,6 +90,7 @@ def _convert_capability_to_tuples(capabilities: ComparableCapability, project: s
 class IAMAPI(APIClient):
     def __init__(self, config: ClientConfig, api_version: str | None, cognite_client: CogniteClient) -> None:
         super().__init__(config, api_version, cognite_client)
+        self.projects = ProjectsAPI(config, api_version, cognite_client)
         self.groups = GroupsAPI(config, api_version, cognite_client)
         self.security_categories = SecurityCategoriesAPI(config, api_version, cognite_client)
         self.sessions = SessionsAPI(config, api_version, cognite_client)

cognite/client/_api/projects.py

@@ -1,19 +1,24 @@
 from __future__ import annotations
 
 from cognite.client._api_client import APIClient
+from cognite.client.data_classes import Project, ProjectUpdate, ProjectWrite
 
 
 class ProjectsAPI(APIClient):
     _RESOURCE_PATH = "/projects"
 
-    def create(self) -> None:
+    def create(self, item: ProjectWrite) -> Project:
+        """`Create a project <https://developer.cognite.com/api#tag/Projects/operation/createProject>`_"""
         raise NotImplementedError
 
-    def retrieve(self) -> None:
+    def retrieve(self, project: str) -> Project:
+        """`Retrieve a project <https://developer.cognite.com/api#tag/Projects/operation/getProject>`_"""
         raise NotImplementedError
 
-    def update(self) -> None:
+    def update(self, item: ProjectWrite | ProjectUpdate) -> Project:
+        """`Update a project <https://developer.cognite.com/api#tag/Projects/operation/updateProject>`_"""
         raise NotImplementedError
 
-    def list(self) -> None:
+    def list(self) -> list[str]:
+        """`List all projects <https://developer.cognite.com/api#tag/Projects/operation/listProjects>`_"""
         raise NotImplementedError

cognite/client/data_classes/__init__.py

@@ -151,6 +151,7 @@
     LabelDefinitionWrite,
     LabelFilter,
 )
+from cognite.client.data_classes.projects import Claim, OIDCConfiguration, Project, ProjectUpdate, ProjectWrite
 from cognite.client.data_classes.raw import (
     Database,
     DatabaseList,
@@ -557,4 +558,9 @@
     "WorkflowTask",
     "WorkflowUpsertList",
     "WorkflowVersionUpsertList",
+    "Project",
+    "ProjectUpdate",
+    "ProjectWrite",
+    "OIDCConfiguration",
+    "Claim",
 ]

cognite/client/data_classes/projects.py

@@ -27,6 +27,10 @@ class Claim(CogniteObject):
     def __init__(self, claim_name: str) -> None:
         self.claim_name = claim_name
 
+    @classmethod
+    def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Claim:
+        return cls(claim_name=resource["claimName"])
+
 
 class OIDCConfiguration(CogniteObject):
     """OIDC configuration for a project.

cognite/client/testing.py

@@ -31,6 +31,7 @@
 from cognite.client._api.geospatial import GeospatialAPI
 from cognite.client._api.iam import IAMAPI, GroupsAPI, SecurityCategoriesAPI, SessionsAPI, TokenAPI
 from cognite.client._api.labels import LabelsAPI
+from cognite.client._api.projects import ProjectsAPI
 from cognite.client._api.raw import RawAPI, RawDatabasesAPI, RawRowsAPI, RawTablesAPI
 from cognite.client._api.relationships import RelationshipsAPI
 from cognite.client._api.sequences import SequencesAPI, SequencesDataAPI
@@ -112,6 +113,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         self.geospatial = MagicMock(spec_set=GeospatialAPI)
 
         self.iam = MagicMock(spec=IAMAPI)
+        self.iam.projects = MagicMock(spec_set=ProjectsAPI)
         self.iam.groups = MagicMock(spec_set=GroupsAPI)
         self.iam.security_categories = MagicMock(spec_set=SecurityCategoriesAPI)
         self.iam.sessions = MagicMock(spec_set=SessionsAPI)