clarity-api-sdk-python 0.4.2__py3-none-any.whl → 0.4.3__py3-none-any.whl

{clarity_api_sdk_python-0.4.2.dist-info → clarity_api_sdk_python-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.4.2
+Version: 0.4.3
 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.4.2.dist-info → clarity_api_sdk_python-0.4.3.dist-info}/RECORD

@@ -5,8 +5,8 @@ cti/api/__init__.py,sha256=2abRmywGsoOIyI5LGIW323A83Ip_m_2-n9XviU2_iNM,275
 cti/api/async_client.py,sha256=k4S8uVRYPGETdQ4LR6_pDyro5h6pyzmvi3q9l0ot65Q,5223
 cti/api/client.py,sha256=xzmhsHVJc02Svf8TMMqHU2U_J0-EpeLrKRU5Vn0SB5Q,4980
 cti/api/session.py,sha256=Glfx8zJlD0K1QPFFwTY5Nk7nbMNxrpiSn-PR3m8Ln9U,3905
-cti/api/sonar_wiz_api.py,sha256=3_m8ADDhNGX4Z2YSvbf6VulV8RNF_-2OHRIfOAb5z2Q,81907
-cti/api/sonar_wiz_async_api.py,sha256=VkdGvzbcex04Ze0wRgOALLU4CJWgHaTK1PAbwmu_4_4,83403
+cti/api/sonar_wiz_api.py,sha256=sZn6mHzFd52C9ZW30rDnGSDkh0nTh5UVAH62xY0FbC4,82966
+cti/api/sonar_wiz_async_api.py,sha256=yQJtLl40gxIoX8_it8P2eTCO1ZRXNW1NLib_Oq-rbxw,84474
 cti/cli/__init__.py,sha256=8JSrgU2n_cZIRU4pi95GfNVNRgaC-2VIYefMBSipUnI,75
 cti/cli/__main__.py,sha256=iwQCepbPuq8GETBFeTWFDWLFiRVV9Ee4Vm1808ggBJw,424
 cti/cli/client.py,sha256=ZA5rtWHtn2bBqMo2Vk-5iAH_XnMbrpyaP2q6u8MIdwQ,1264
@@ -46,8 +46,8 @@ cti/model/tow_system.py,sha256=zQd6k2VbOwXFzjFc0isD_y159OM16eSqETMrO3wR5UE,1337
 cti/model/user_layer.py,sha256=KXvM1__o9YNpt63Uq3VwqvGEzWE8gQb1xkLfSuKiZr0,3775
 cti/positioning/__init__.py,sha256=AMr1zGAO_3Q18uOqr1fnSNrXQV8HoAROjacOn4_w2HM,375
 cti/positioning/target_geometry.py,sha256=km3h8Kpz2CnJnSdeDp7mi3p5yXCnROsdHMzU9UqREy4,6294
-clarity_api_sdk_python-0.4.2.dist-info/METADATA,sha256=FZqx_Uge1m8XBLpsw0DbEsd01-Yzlp9I2Bvpcpzd270,3901
-clarity_api_sdk_python-0.4.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-clarity_api_sdk_python-0.4.2.dist-info/entry_points.txt,sha256=A6tseI4vcnR4KBPaZAbXyf0dWhi-CmZB5mlSCvXeh3Q,46
-clarity_api_sdk_python-0.4.2.dist-info/top_level.txt,sha256=q0eCD9KnKXWf_VImQ7xYkyYD7cvcG-4X-vm36HhdT_M,4
-clarity_api_sdk_python-0.4.2.dist-info/RECORD,,
+clarity_api_sdk_python-0.4.3.dist-info/METADATA,sha256=WbbiaoXioHlZ_UVNNzoa7tiSVFulpZYnNQWLGWiES2Y,3901
+clarity_api_sdk_python-0.4.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+clarity_api_sdk_python-0.4.3.dist-info/entry_points.txt,sha256=A6tseI4vcnR4KBPaZAbXyf0dWhi-CmZB5mlSCvXeh3Q,46
+clarity_api_sdk_python-0.4.3.dist-info/top_level.txt,sha256=q0eCD9KnKXWf_VImQ7xYkyYD7cvcG-4X-vm36HhdT_M,4
+clarity_api_sdk_python-0.4.3.dist-info/RECORD,,

cti/api/sonar_wiz_api.py

@@ -1709,33 +1709,56 @@ class SonarWizApi:
         response.raise_for_status()
         return Target.model_validate(response.json())
 
-    def list_targets(self) -> list[Target]:
-        """List all targets.
+    def list_targets(self, sidescan_ping_source_id: UUID | str) -> list[Target]:
+        """List all targets for one sidescan ping source.
+
+        The cross-source ``GET /api/v1/targets`` endpoint is deprecated;
+        the spec scopes target reads to a single SidescanPingSource.
+
+        Args:
+            sidescan_ping_source_id: SidescanPingSource UUID or string identifier.
 
         Returns:
-            List of target instances.
+            List of target instances, each with the ``derived`` block
+            populated when the parent line's nav state is available.
         """
-        response = self._client.get("/api/v1/targets")
+        response = self._client.get(
+            f"/api/v1/sidescan-ping-sources/{sidescan_ping_source_id}/targets"
+        )
         response.raise_for_status()
         return [Target.model_validate(item) for item in response.json()]
 
     def update_target(self, target_id: UUID | str, target: TargetUpdate) -> Target:
-        """Update a target.
+        """Partially update a target.
+
+        Targets MVP is the first endpoint in the API to use PATCH (older
+        update endpoints use PUT for legacy reasons but already behave as
+        PATCH server-side via ``exclude_unset=True``). Body fields are
+        optional; only the supplied fields are mutated.
 
         Args:
             target_id: Target UUID or string identifier.
-            target: Target update data.
+            target: Partial target update data.
 
         Returns:
             Updated target instance.
         """
-        response = self._client.put(
+        response = self._client.patch(
             f"/api/v1/targets/{target_id}",
             json=target.model_dump(mode="json", exclude_unset=True),
         )
         response.raise_for_status()
         return Target.model_validate(response.json())
 
+    def delete_target(self, target_id: UUID | str) -> None:
+        """Hard-delete a target.
+
+        Args:
+            target_id: Target UUID or string identifier.
+        """
+        response = self._client.delete(f"/api/v1/targets/{target_id}")
+        response.raise_for_status()
+
     def create_tow_system(self, tow_system: TowSystemCreate) -> TowSystem:
         """Create a new tow system.
 

cti/api/sonar_wiz_async_api.py

@@ -1753,35 +1753,58 @@ class SonarWizAsyncApi:
         response.raise_for_status()
         return Target.model_validate(response.json())
 
-    async def list_targets(self) -> list[Target]:
-        """List all targets.
+    async def list_targets(self, sidescan_ping_source_id: UUID | str) -> list[Target]:
+        """List all targets for one sidescan ping source.
+
+        The cross-source ``GET /api/v1/targets`` endpoint is deprecated;
+        the spec scopes target reads to a single SidescanPingSource.
+
+        Args:
+            sidescan_ping_source_id: SidescanPingSource UUID or string identifier.
 
         Returns:
-            List of target instances.
+            List of target instances, each with the ``derived`` block
+            populated when the parent line's nav state is available.
         """
-        response = await self._client.get("/api/v1/targets")
+        response = await self._client.get(
+            f"/api/v1/sidescan-ping-sources/{sidescan_ping_source_id}/targets"
+        )
         response.raise_for_status()
         return [Target.model_validate(item) for item in response.json()]
 
     async def update_target(
         self, target_id: UUID | str, target: TargetUpdate
     ) -> Target:
-        """Update a target.
+        """Partially update a target.
+
+        Targets MVP is the first endpoint in the API to use PATCH (older
+        update endpoints use PUT for legacy reasons but already behave as
+        PATCH server-side via ``exclude_unset=True``). Body fields are
+        optional; only the supplied fields are mutated.
 
         Args:
             target_id: Target UUID or string identifier.
-            target: Target update data.
+            target: Partial target update data.
 
         Returns:
             Updated target instance.
         """
-        response = await self._client.put(
+        response = await self._client.patch(
             f"/api/v1/targets/{target_id}",
             json=target.model_dump(mode="json", exclude_unset=True),
         )
         response.raise_for_status()
         return Target.model_validate(response.json())
 
+    async def delete_target(self, target_id: UUID | str) -> None:
+        """Hard-delete a target.
+
+        Args:
+            target_id: Target UUID or string identifier.
+        """
+        response = await self._client.delete(f"/api/v1/targets/{target_id}")
+        response.raise_for_status()
+
     async def create_tow_system(self, tow_system: TowSystemCreate) -> TowSystem:
         """Create a new tow system.