clarity-api-sdk-python 0.3.25__tar.gz → 0.3.27__tar.gz

{clarity_api_sdk_python-0.3.25 → clarity_api_sdk_python-0.3.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.25
+Version: 0.3.27
 Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python

{clarity_api_sdk_python-0.3.25 → clarity_api_sdk_python-0.3.27}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clarity-api-sdk-python"
-version = "0.3.25"
+version = "0.3.27"
 authors = [
   { name="Chesapeake Technology Inc.", email="support@chesapeaketech.com" },
 ]

{clarity_api_sdk_python-0.3.25 → clarity_api_sdk_python-0.3.27}/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.25
+Version: 0.3.27
 Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python

{clarity_api_sdk_python-0.3.25 → clarity_api_sdk_python-0.3.27}/src/cti/api/sonar_wiz_api.py

@@ -778,6 +778,229 @@ class SonarWizApi:
         )
         return devices
 
+    def get_device_altitude_sources(
+        self, device_id: UUID | str
+    ) -> list[AltitudeSource]:
+        """Get all altitude sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of altitude source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_altitude_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = self._client.get(f"/api/v1/devices/{device_id}/altitude-sources")
+        response.raise_for_status()
+        sources = [AltitudeSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_altitude_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    def get_device_attitude_sources(
+        self, device_id: UUID | str
+    ) -> list[AttitudeSource]:
+        """Get all attitude sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of attitude source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_attitude_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = self._client.get(f"/api/v1/devices/{device_id}/attitude-source")
+        response.raise_for_status()
+        source = AttitudeSource.model_validate(response.json())
+        sources = [source]
+        logger.info(
+            "device_attitude_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    def get_device_depth_sources(self, device_id: UUID | str) -> list[DepthSource]:
+        """Get all depth sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of depth source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_depth_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = self._client.get(f"/api/v1/devices/{device_id}/depth-sources")
+        response.raise_for_status()
+        sources = [DepthSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_depth_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    def get_device_layback_sources(
+        self, device_id: UUID | str
+    ) -> list[LaybackSource]:
+        """Get all layback sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of layback source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_layback_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = self._client.get(f"/api/v1/devices/{device_id}/layback-sources")
+        response.raise_for_status()
+        sources = [LaybackSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_layback_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    def get_device_position_sources(
+        self, device_id: UUID | str
+    ) -> list[PositionSource]:
+        """Get all position sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of position source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_position_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = self._client.get(f"/api/v1/devices/{device_id}/position-sources")
+        response.raise_for_status()
+        sources = [PositionSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_position_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    def get_device_sidescan_ping_sources(
+        self, device_id: UUID | str
+    ) -> list[SidescanPingSource]:
+        """Get all sidescan ping sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of sidescan ping source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_sidescan_ping_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = self._client.get(
+            f"/api/v1/devices/{device_id}/sidescan-ping-sources"
+        )
+        response.raise_for_status()
+        sources = [SidescanPingSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_sidescan_ping_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    def get_position_source_raw_positions(
+        self, position_source_id: UUID | str
+    ) -> list[RawPosition]:
+        """Get all raw positions associated with a position source.
+
+        Args:
+            position_source_id: Position source UUID.
+
+        Returns:
+            List of raw position instances.
+        """
+        logger.info(
+            "fetching_position_source_raw_positions",
+            extra={"position_source_id": str(position_source_id)},
+        )
+        response = self._client.get(
+            f"/api/v1/position-sources/{position_source_id}/raw-positions"
+        )
+        response.raise_for_status()
+        raw_positions = [RawPosition.model_validate(item) for item in response.json()]
+        logger.info(
+            "position_source_raw_positions_fetched",
+            extra={
+                "position_source_id": str(position_source_id),
+                "count": len(raw_positions),
+            },
+        )
+        return raw_positions
+
+    def get_sidescan_ping_source_raw_sidescan_pings(
+        self, sidescan_ping_source_id: UUID | str
+    ) -> list[RawSidescanPing]:
+        """Get all raw sidescan pings associated with a sidescan ping source.
+
+        Args:
+            sidescan_ping_source_id: Sidescan ping source UUID.
+
+        Returns:
+            List of raw sidescan ping instances.
+        """
+        logger.info(
+            "fetching_sidescan_ping_source_raw_sidescan_pings",
+            extra={"sidescan_ping_source_id": str(sidescan_ping_source_id)},
+        )
+        response = self._client.get(
+            f"/api/v1/sidescan-ping-sources/{sidescan_ping_source_id}/raw-sidescan-pings"
+        )
+        response.raise_for_status()
+        raw_sidescan_pings = [
+            RawSidescanPing.model_validate(item) for item in response.json()
+        ]
+        logger.info(
+            "sidescan_ping_source_raw_sidescan_pings_fetched",
+            extra={
+                "sidescan_ping_source_id": str(sidescan_ping_source_id),
+                "count": len(raw_sidescan_pings),
+            },
+        )
+        return raw_sidescan_pings
+
     def create_source(self, source: SourceCreate) -> Source:
         """Create a new source.
 

{clarity_api_sdk_python-0.3.25 → clarity_api_sdk_python-0.3.27}/src/cti/api/sonar_wiz_async_api.py

@@ -778,6 +778,239 @@ class SonarWizAsyncApi:
         )
         return devices
 
+    async def get_device_altitude_sources(
+        self, device_id: UUID | str
+    ) -> list[AltitudeSource]:
+        """Get all altitude sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of altitude source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_altitude_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = await self._client.get(
+            f"/api/v1/devices/{device_id}/altitude-sources"
+        )
+        response.raise_for_status()
+        sources = [AltitudeSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_altitude_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    async def get_device_attitude_sources(
+        self, device_id: UUID | str
+    ) -> list[AttitudeSource]:
+        """Get all attitude sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of attitude source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_attitude_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = await self._client.get(
+            f"/api/v1/devices/{device_id}/attitude-source"
+        )
+        response.raise_for_status()
+        source = AttitudeSource.model_validate(response.json())
+        sources = [source]
+        logger.info(
+            "device_attitude_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    async def get_device_depth_sources(
+        self, device_id: UUID | str
+    ) -> list[DepthSource]:
+        """Get all depth sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of depth source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_depth_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = await self._client.get(f"/api/v1/devices/{device_id}/depth-sources")
+        response.raise_for_status()
+        sources = [DepthSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_depth_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    async def get_device_layback_sources(
+        self, device_id: UUID | str
+    ) -> list[LaybackSource]:
+        """Get all layback sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of layback source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_layback_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = await self._client.get(
+            f"/api/v1/devices/{device_id}/layback-sources"
+        )
+        response.raise_for_status()
+        sources = [LaybackSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_layback_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    async def get_device_position_sources(
+        self, device_id: UUID | str
+    ) -> list[PositionSource]:
+        """Get all position sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of position source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_position_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = await self._client.get(
+            f"/api/v1/devices/{device_id}/position-sources"
+        )
+        response.raise_for_status()
+        sources = [PositionSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_position_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    async def get_device_sidescan_ping_sources(
+        self, device_id: UUID | str
+    ) -> list[SidescanPingSource]:
+        """Get all sidescan ping sources associated with a device.
+
+        Args:
+            device_id: Device UUID or string identifier.
+
+        Returns:
+            List of sidescan ping source instances associated with the device.
+        """
+        logger.info(
+            "fetching_device_sidescan_ping_sources",
+            extra={"device_id": str(device_id)},
+        )
+        response = await self._client.get(
+            f"/api/v1/devices/{device_id}/sidescan-ping-sources"
+        )
+        response.raise_for_status()
+        sources = [SidescanPingSource.model_validate(item) for item in response.json()]
+        logger.info(
+            "device_sidescan_ping_sources_fetched",
+            extra={
+                "device_id": str(device_id),
+                "count": len(sources),
+            },
+        )
+        return sources
+
+    async def get_position_source_raw_positions(
+        self, position_source_id: UUID | str
+    ) -> list[RawPosition]:
+        """Get all raw positions associated with a position source.
+
+        Args:
+            position_source_id: Position source UUID.
+
+        Returns:
+            List of raw position instances.
+        """
+        logger.info(
+            "fetching_position_source_raw_positions",
+            extra={"position_source_id": str(position_source_id)},
+        )
+        response = await self._client.get(
+            f"/api/v1/position-sources/{position_source_id}/raw-positions"
+        )
+        response.raise_for_status()
+        raw_positions = [RawPosition.model_validate(item) for item in response.json()]
+        logger.info(
+            "position_source_raw_positions_fetched",
+            extra={
+                "position_source_id": str(position_source_id),
+                "count": len(raw_positions),
+            },
+        )
+        return raw_positions
+
+    async def get_sidescan_ping_source_raw_sidescan_pings(
+        self, sidescan_ping_source_id: UUID | str
+    ) -> list[RawSidescanPing]:
+        """Get all raw sidescan pings associated with a sidescan ping source.
+
+        Args:
+            sidescan_ping_source_id: Sidescan ping source UUID.
+
+        Returns:
+            List of raw sidescan ping instances.
+        """
+        logger.info(
+            "fetching_sidescan_ping_source_raw_sidescan_pings",
+            extra={"sidescan_ping_source_id": str(sidescan_ping_source_id)},
+        )
+        response = await self._client.get(
+            f"/api/v1/sidescan-ping-sources/{sidescan_ping_source_id}/raw-sidescan-pings"
+        )
+        response.raise_for_status()
+        raw_sidescan_pings = [
+            RawSidescanPing.model_validate(item) for item in response.json()
+        ]
+        logger.info(
+            "sidescan_ping_source_raw_sidescan_pings_fetched",
+            extra={
+                "sidescan_ping_source_id": str(sidescan_ping_source_id),
+                "count": len(raw_sidescan_pings),
+            },
+        )
+        return raw_sidescan_pings
+
     async def create_source(self, source: SourceCreate) -> Source:
         """Create a new source.