add support for the simulators endpoint

CHANGELOG.md

@@ -17,6 +17,10 @@ Changes are grouped as follows
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## [Unreleased]
+### Added
+- Support for the `/simulators` and `/simulators/integration` API endpoints.
+
 ## [7.71.2] - 2025-01-07
 ### Added
 - Instance ID is now supported for `retrieve_latest` in the datapoints API.
@@ -34,6 +38,7 @@ Changes are grouped as follows
 ### Added
 - Support for InstanceReferences filter for Data Modeling
 
+
 ## [7.70.7] - 2024-12-20
 ### Fixed
 - Passing a valid but empty string as external_id no longer raises an error for certain SDK methods

cognite/client/_api/simulators/__init__.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from cognite.client._api.simulators.integrations import SimulatorIntegrationsAPI
+from cognite.client._api_client import APIClient
+from cognite.client._constants import DEFAULT_LIMIT_READ
+from cognite.client.data_classes.simulators.simulators import Simulator, SimulatorList
+from cognite.client.utils._experimental import FeaturePreviewWarning
+
+if TYPE_CHECKING:
+    from cognite.client import CogniteClient
+    from cognite.client.config import ClientConfig
+
+
+class SimulatorsAPI(APIClient):
+    _RESOURCE_PATH = "/simulators"
+
+    def __init__(self, config: ClientConfig, api_version: str | None, cognite_client: CogniteClient) -> None:
+        super().__init__(config, api_version, cognite_client)
+        self.integrations = SimulatorIntegrationsAPI(config, api_version, cognite_client)
+        self._warning = FeaturePreviewWarning(
+            api_maturity="General Availability", sdk_maturity="alpha", feature_name="Simulators"
+        )
+
+    def list(self, limit: int = DEFAULT_LIMIT_READ) -> SimulatorList:
+        """`List simulators <https://developer.cognite.com/api#tag/Simulators/operation/filter_simulators_simulators_list_post>`_
+
+        List simulators
+
+        Args:
+            limit (int): Maximum number of results to return. Defaults to 25. Set to -1, float(“inf”) or None to return all items.
+
+        Returns:
+            SimulatorList: List of simulators
+
+        Examples:
+
+            List simulators:
+
+                    >>> from cognite.client import CogniteClient
+                    >>> client = CogniteClient()
+                    >>> res = client.simulators.list()
+
+        """
+        self._warning.warn()
+        return self._list(method="POST", limit=limit, resource_cls=Simulator, list_cls=SimulatorList)

cognite/client/_api/simulators/integrations.py

@@ -0,0 +1,88 @@
+from __future__ import annotations
+
+from collections.abc import Sequence
+from typing import TYPE_CHECKING
+
+from cognite.client._api_client import APIClient
+from cognite.client._constants import DEFAULT_LIMIT_READ
+from cognite.client.data_classes._base import CogniteFilter
+from cognite.client.data_classes.simulators.filters import SimulatorIntegrationFilter
+from cognite.client.data_classes.simulators.simulators import (
+    SimulatorIntegration,
+    SimulatorIntegrationList,
+)
+from cognite.client.utils._experimental import FeaturePreviewWarning
+from cognite.client.utils._identifier import IdentifierSequence
+from cognite.client.utils.useful_types import SequenceNotStr
+
+if TYPE_CHECKING:
+    from cognite.client import CogniteClient
+    from cognite.client.config import ClientConfig
+
+
+class SimulatorIntegrationsAPI(APIClient):
+    _RESOURCE_PATH = "/simulators/integrations"
+
+    def __init__(self, config: ClientConfig, api_version: str | None, cognite_client: CogniteClient) -> None:
+        super().__init__(config, api_version, cognite_client)
+        self._DELETE_LIMIT = 1
+        self._warning = FeaturePreviewWarning(
+            api_maturity="General Availability", sdk_maturity="alpha", feature_name="Simulators"
+        )
+
+    def list(
+        self,
+        limit: int = DEFAULT_LIMIT_READ,
+        filter: SimulatorIntegrationFilter | None = None,
+    ) -> SimulatorIntegrationList:
+        """`Filter simulator integrations <https://developer.cognite.com/api#tag/Simulator-Integrations/operation/filter_simulator_integrations_simulators_integrations_list_post>`_
+        Retrieves a list of simulator integrations that match the given criteria
+        Args:
+            limit (int): The maximum number of simulator integrations to return.
+            filter (SimulatorIntegrationFilter | None): Filter to apply.
+        Returns:
+            SimulatorIntegrationList: List of simulator integrations
+        Examples:
+            List simulator integrations:
+                    >>> from cognite.client import CogniteClient
+                    >>> client = CogniteClient()
+                    >>> res = client.simulators.integrations.list()
+
+            Filter integrations by active status:
+                    >>> from cognite.client.data_classes.simulators.filters import SimulatorIntegrationFilter
+                    >>> res = client.simulators.integrations.list(
+                    ...     filter=SimulatorIntegrationFilter(active=True))
+        """
+
+        self._warning.warn()
+        return self._list(
+            method="POST",
+            limit=limit,
+            resource_cls=SimulatorIntegration,
+            list_cls=SimulatorIntegrationList,
+            filter=filter.dump() if isinstance(filter, CogniteFilter) else None,
+        )
+
+    def delete(
+        self,
+        id: int | Sequence[int] | None = None,
+        external_ids: str | SequenceNotStr[str] | SequenceNotStr[str] | None = None,
+    ) -> None:
+        """`Delete one or more integrations <https://developer.cognite.com/api#tag/Simulator-Integrations/operation/delete_simulator_integrations_simulators_integrations_delete_post>`_
+
+        Args:
+            id (int | Sequence[int] | None): Id or list of ids
+            external_ids (str | SequenceNotStr[str] | SequenceNotStr[str] | None): No description.
+
+        Examples:
+
+            Delete integrations by id or external id:
+
+                >>> from cognite.client import CogniteClient
+                >>> client = CogniteClient()
+                >>> client.simulators.integrations.delete(id=[1,2,3], external_id="foo")
+        """
+        self._delete_multiple(
+            identifiers=IdentifierSequence.load(ids=id, external_ids=external_ids),
+            wrap_ids=True,
+        )

cognite/client/_api_client.py

@@ -101,6 +101,7 @@ class APIClient:
                     "geospatial/(compute|crs/byids|featuretypes/(byids|list))",
                     "geospatial/featuretypes/[A-Za-z][A-Za-z0-9_]{0,31}/features/(aggregate|list|byids|search|search-streaming|[A-Za-z][A-Za-z0-9_]{0,255}/rasters/[A-Za-z][A-Za-z0-9_]{0,31})",
                     "transformations/(filter|byids|jobs/byids|schedules/byids|query/run)",
+                    "simulators/list",
                     "extpipes/(list|byids|runs/list)",
                     "workflows/.*",
                     "hostedextractors/.*",

cognite/client/_cognite_client.py

@@ -23,6 +23,7 @@
 from cognite.client._api.raw import RawAPI
 from cognite.client._api.relationships import RelationshipsAPI
 from cognite.client._api.sequences import SequencesAPI
+from cognite.client._api.simulators import SimulatorsAPI
 from cognite.client._api.templates import TemplatesAPI
 from cognite.client._api.three_d import ThreeDAPI
 from cognite.client._api.time_series import TimeSeriesAPI
@@ -83,6 +84,8 @@ def __init__(self, config: ClientConfig | None = None) -> None:
         self.documents = DocumentsAPI(self._config, self._API_VERSION, self)
         self.workflows = WorkflowAPI(self._config, self._API_VERSION, self)
         self.units = UnitAPI(self._config, self._API_VERSION, self)
+        self.simulators = SimulatorsAPI(self._config, self._API_VERSION, self)
+
         # APIs just using base_url:
         self._api_client = APIClient(self._config, api_version=None, cognite_client=self)
 

cognite/client/data_classes/simulators/__init__.py

@@ -1 +1,23 @@
 from __future__ import annotations
+
+from cognite.client.data_classes.simulators.simulators import (
+    Simulator,
+    SimulatorIntegration,
+    SimulatorIntegrationList,
+    SimulatorList,
+    SimulatorStep,
+    SimulatorStepField,
+    SimulatorStepOption,
+    SimulatorUnitEntry,
+)
+
+__all__ = [
+    "Simulator",
+    "SimulatorIntegration",
+    "SimulatorIntegrationList",
+    "SimulatorList",
+    "SimulatorStep",
+    "SimulatorStepField",
+    "SimulatorStepOption",
+    "SimulatorUnitEntry",
+]

cognite/client/data_classes/simulators/filters.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from cognite.client.data_classes._base import CogniteFilter
+from cognite.client.utils.useful_types import SequenceNotStr
+
+
+class SimulatorIntegrationFilter(CogniteFilter):
+    def __init__(
+        self,
+        simulator_external_ids: SequenceNotStr[str] | None = None,
+        active: bool | None = None,
+    ) -> None:
+        self.simulator_external_ids = simulator_external_ids
+        self.active = active