clarity-api-sdk-python 0.3.36__tar.gz → 0.4.0__tar.gz

{clarity_api_sdk_python-0.3.36 → clarity_api_sdk_python-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.36
+Version: 0.4.0
 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.36 → clarity_api_sdk_python-0.4.0}/pyproject.toml

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

{clarity_api_sdk_python-0.3.36 → clarity_api_sdk_python-0.4.0}/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.36
+Version: 0.4.0
 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.36 → clarity_api_sdk_python-0.4.0}/src/clarity_api_sdk_python.egg-info/SOURCES.txt

@@ -51,6 +51,8 @@ src/cti/model/source.py
 src/cti/model/survey.py
 src/cti/model/target.py
 src/cti/model/tow_system.py
+src/cti/model/user_layer.py
 tests/test_cli.py
+tests/test_raw_file_device_mapping_model.py
 tests/test_sdk_async_methods.py
 tests/test_sdk_methods.py

{clarity_api_sdk_python-0.3.36 → clarity_api_sdk_python-0.4.0}/src/cti/api/sonar_wiz_api.py

@@ -99,6 +99,10 @@ from cti.model.target import TargetUpdate
 from cti.model.tow_system import TowSystem
 from cti.model.tow_system import TowSystemCreate
 from cti.model.tow_system import TowSystemUpdate
+from cti.model.user_layer import UserLayer
+from cti.model.user_layer import UserLayerCreate
+from cti.model.user_layer import UserLayerUpdate
+from cti.model.user_layer import UserLayerWithUpload
 
 from .client import ClarityApiClient
 
@@ -1975,13 +1979,34 @@ class SonarWizApi:
         response.raise_for_status()
         return ProcessingLog.model_validate(response.json())
 
-    def list_processing_logs(self) -> list[ProcessingLog]:
-        """List all processing logs.
+    def list_processing_logs(
+        self,
+        *,
+        raw_file_id: UUID | str | None = None,
+        survey_id: UUID | str | None = None,
+        processing_step: str | None = None,
+    ) -> list[ProcessingLog]:
+        """List processing logs, optionally filtered.
+
+        Filters compose: each provided filter narrows the result set.
+
+        Args:
+            raw_file_id: Match only logs for this raw file.
+            survey_id: Match only logs for this survey.
+            processing_step: Match only logs with this processing step
+                (e.g. ``"scan"``, ``"ingest"``, ``"products"``).
 
         Returns:
-            List of processing log instances.
+            List of matching processing logs (empty list if none match).
         """
-        response = self._client.get("/api/v1/processing-logs")
+        params: dict[str, str] = {}
+        if raw_file_id is not None:
+            params["raw_file_id"] = str(raw_file_id)
+        if survey_id is not None:
+            params["survey_id"] = str(survey_id)
+        if processing_step is not None:
+            params["processing_step"] = processing_step
+        response = self._client.get("/api/v1/processing-logs", params=params or None)
         response.raise_for_status()
         return [ProcessingLog.model_validate(item) for item in response.json()]
 
@@ -2004,6 +2029,81 @@ class SonarWizApi:
         response.raise_for_status()
         return ProcessingLog.model_validate(response.json())
 
+    # ── User Layers ──────────────────────────────────────────────────────
+
+    def create_user_layer(self, user_layer: UserLayerCreate) -> UserLayerWithUpload:
+        """Create a new user layer and initiate upload.
+
+        Args:
+            user_layer: User layer creation data.
+
+        Returns:
+            Created user layer instance with upload information.
+        """
+        response = self._client.post(
+            "/api/v1/user-layers/upload",
+            json=user_layer.model_dump(mode="json"),
+        )
+        response.raise_for_status()
+        return UserLayerWithUpload.model_validate(response.json())
+
+    def get_user_layer(self, user_layer_id: UUID) -> UserLayer:
+        """Fetch a user layer by ID.
+
+        Args:
+            user_layer_id: User layer UUID to fetch.
+
+        Returns:
+            UserLayer instance.
+        """
+        response = self._client.get(f"/api/v1/user-layers/{user_layer_id}")
+        response.raise_for_status()
+        return UserLayer.model_validate(response.json())
+
+    def list_user_layers(self, project_id: UUID) -> list[UserLayer]:
+        """List all user layers for a project.
+
+        Args:
+            project_id: Project UUID to filter by.
+
+        Returns:
+            List of user layer instances.
+        """
+        response = self._client.get(
+            "/api/v1/user-layers",
+            params={"project_id": str(project_id)},
+        )
+        response.raise_for_status()
+        return [UserLayer.model_validate(item) for item in response.json()]
+
+    def update_user_layer(
+        self, user_layer_id: UUID, user_layer: UserLayerUpdate
+    ) -> UserLayer:
+        """Update a user layer.
+
+        Args:
+            user_layer_id: User layer UUID to update.
+            user_layer: User layer update data.
+
+        Returns:
+            Updated user layer instance.
+        """
+        response = self._client.patch(
+            f"/api/v1/user-layers/{user_layer_id}",
+            json=user_layer.model_dump(mode="json", exclude_none=True),
+        )
+        response.raise_for_status()
+        return UserLayer.model_validate(response.json())
+
+    def delete_user_layer(self, user_layer_id: UUID) -> None:
+        """Delete a user layer.
+
+        Args:
+            user_layer_id: User layer UUID to delete.
+        """
+        response = self._client.delete(f"/api/v1/user-layers/{user_layer_id}")
+        response.raise_for_status()
+
     # ── Processing Jobs ──────────────────────────────────────────────────
 
     def create_job(self, job_data: ProcessingJobCreate) -> ProcessingJob:
@@ -2116,7 +2216,9 @@ class SonarWizApi:
             response.raise_for_status()
             configs = [RawFileConfiguration.model_validate(c) for c in response.json()]
             if not configs:
-                raise ValueError(f"No raw file configuration found for survey {survey_id}")
+                raise ValueError(
+                    f"No raw file configuration found for survey {survey_id}"
+                )
             raw_file_configuration_id = configs[0].raw_file_configuration_id
 
         # Initiate multipart upload
@@ -2156,7 +2258,9 @@ class SonarWizApi:
                         f"/api/v1/rawfiles/{raw_file.raw_file_id}/upload-parts/{part_number}/url"
                     )
                     url_response.raise_for_status()
-                    presigned_url = PartPresignedURL.model_validate(url_response.json()).url
+                    presigned_url = PartPresignedURL.model_validate(
+                        url_response.json()
+                    ).url
 
                     # The server generates presigned URLs using its S3_ENDPOINT_URL,
                     # which may be a Docker-internal hostname (e.g. minio:9000).
@@ -2210,23 +2314,27 @@ class SonarWizApi:
         )
         return completed
 
-    def trigger_processing(self, survey_id: UUID) -> ProcessingJob:
-        """Trigger processing for a survey.
-
-        Creates a processing job and dispatches it via SQS.
+    def process(self, survey_id: UUID, target_phase: str = "products") -> ProcessingJob:
+        """Dispatch a pipeline run for a survey.
 
         Args:
             survey_id: Survey to process.
+            target_phase: Pipeline phase to run up to. Defaults to "products"
+                (full pipeline). "scan" runs only setup → scan. The engine's
+                pull-chain resolves any required predecessor phases.
 
         Returns:
             The created ProcessingJob.
         """
-        response = self._client.post(f"/api/v1/ingest/{survey_id}")
+        response = self._client.post(
+            "/api/v1/process",
+            json={"survey_id": str(survey_id), "target_phase": target_phase},
+        )
         response.raise_for_status()
         data = response.json()
 
-        # The ingest endpoint returns a dict with job_id, not a full ProcessingJob.
-        # Fetch the full job record.
+        # The /process endpoint returns a dict with job_id, not a full
+        # ProcessingJob. Fetch the full job record.
         if job_id := data.get("job_id"):
             return self.get_job(job_id)
 

{clarity_api_sdk_python-0.3.36 → clarity_api_sdk_python-0.4.0}/src/cti/api/sonar_wiz_async_api.py

@@ -97,6 +97,10 @@ from cti.model.target import TargetUpdate
 from cti.model.tow_system import TowSystem
 from cti.model.tow_system import TowSystemCreate
 from cti.model.tow_system import TowSystemUpdate
+from cti.model.user_layer import UserLayer
+from cti.model.user_layer import UserLayerCreate
+from cti.model.user_layer import UserLayerUpdate
+from cti.model.user_layer import UserLayerWithUpload
 
 from .async_client import ClarityApiAsyncClient
 
@@ -2023,13 +2027,36 @@ class SonarWizAsyncApi:
         response.raise_for_status()
         return ProcessingLog.model_validate(response.json())
 
-    async def list_processing_logs(self) -> list[ProcessingLog]:
-        """List all processing logs.
+    async def list_processing_logs(
+        self,
+        *,
+        raw_file_id: UUID | str | None = None,
+        survey_id: UUID | str | None = None,
+        processing_step: str | None = None,
+    ) -> list[ProcessingLog]:
+        """List processing logs, optionally filtered.
+
+        Filters compose: each provided filter narrows the result set.
+
+        Args:
+            raw_file_id: Match only logs for this raw file.
+            survey_id: Match only logs for this survey.
+            processing_step: Match only logs with this processing step
+                (e.g. ``"scan"``, ``"ingest"``, ``"products"``).
 
         Returns:
-            List of processing log instances.
+            List of matching processing logs (empty list if none match).
         """
-        response = await self._client.get("/api/v1/processing-logs")
+        params: dict[str, str] = {}
+        if raw_file_id is not None:
+            params["raw_file_id"] = str(raw_file_id)
+        if survey_id is not None:
+            params["survey_id"] = str(survey_id)
+        if processing_step is not None:
+            params["processing_step"] = processing_step
+        response = await self._client.get(
+            "/api/v1/processing-logs", params=params or None
+        )
         response.raise_for_status()
         return [ProcessingLog.model_validate(item) for item in response.json()]
 
@@ -2052,6 +2079,83 @@ class SonarWizAsyncApi:
         response.raise_for_status()
         return ProcessingLog.model_validate(response.json())
 
+    # ── User Layers ──────────────────────────────────────────────────────
+
+    async def create_user_layer(
+        self, user_layer: UserLayerCreate
+    ) -> UserLayerWithUpload:
+        """Create a new user layer and initiate upload.
+
+        Args:
+            user_layer: User layer creation data.
+
+        Returns:
+            Created user layer instance with upload information.
+        """
+        response = await self._client.post(
+            "/api/v1/user-layers/upload",
+            json=user_layer.model_dump(mode="json"),
+        )
+        response.raise_for_status()
+        return UserLayerWithUpload.model_validate(response.json())
+
+    async def get_user_layer(self, user_layer_id: UUID) -> UserLayer:
+        """Fetch a user layer by ID.
+
+        Args:
+            user_layer_id: User layer UUID to fetch.
+
+        Returns:
+            UserLayer instance.
+        """
+        response = await self._client.get(f"/api/v1/user-layers/{user_layer_id}")
+        response.raise_for_status()
+        return UserLayer.model_validate(response.json())
+
+    async def list_user_layers(self, project_id: UUID) -> list[UserLayer]:
+        """List all user layers for a project.
+
+        Args:
+            project_id: Project UUID to filter by.
+
+        Returns:
+            List of user layer instances.
+        """
+        response = await self._client.get(
+            "/api/v1/user-layers",
+            params={"project_id": str(project_id)},
+        )
+        response.raise_for_status()
+        return [UserLayer.model_validate(item) for item in response.json()]
+
+    async def update_user_layer(
+        self, user_layer_id: UUID, user_layer: UserLayerUpdate
+    ) -> UserLayer:
+        """Update a user layer.
+
+        Args:
+            user_layer_id: User layer UUID to update.
+            user_layer: User layer update data.
+
+        Returns:
+            Updated user layer instance.
+        """
+        response = await self._client.patch(
+            f"/api/v1/user-layers/{user_layer_id}",
+            json=user_layer.model_dump(mode="json", exclude_none=True),
+        )
+        response.raise_for_status()
+        return UserLayer.model_validate(response.json())
+
+    async def delete_user_layer(self, user_layer_id: UUID) -> None:
+        """Delete a user layer.
+
+        Args:
+            user_layer_id: User layer UUID to delete.
+        """
+        response = await self._client.delete(f"/api/v1/user-layers/{user_layer_id}")
+        response.raise_for_status()
+
     # ── Processing Jobs ──────────────────────────────────────────────────
 
     async def create_job(self, job_data: ProcessingJobCreate) -> ProcessingJob:
@@ -2164,7 +2268,9 @@ class SonarWizAsyncApi:
             response.raise_for_status()
             configs = [RawFileConfiguration.model_validate(c) for c in response.json()]
             if not configs:
-                raise ValueError(f"No raw file configuration found for survey {survey_id}")
+                raise ValueError(
+                    f"No raw file configuration found for survey {survey_id}"
+                )
             raw_file_configuration_id = configs[0].raw_file_configuration_id
 
         # Initiate multipart upload
@@ -2206,7 +2312,9 @@ class SonarWizAsyncApi:
                             f"/api/v1/rawfiles/{raw_file.raw_file_id}/upload-parts/{part_number}/url"
                         )
                         url_response.raise_for_status()
-                        presigned_url = PartPresignedURL.model_validate(url_response.json()).url
+                        presigned_url = PartPresignedURL.model_validate(
+                            url_response.json()
+                        ).url
 
                         # Upload directly to S3/MinIO (not through API client)
                         put_response = await s3_client.put(presigned_url, content=chunk)
@@ -2246,27 +2354,29 @@ class SonarWizAsyncApi:
         )
         return completed
 
-    async def trigger_processing(
-        self, survey_id: UUID
+    async def process(
+        self, survey_id: UUID, target_phase: str = "products"
     ) -> ProcessingJob:
-        """Trigger processing for a survey.
-
-        Creates a processing job and dispatches it via SQS.
+        """Dispatch a pipeline run for a survey.
 
         Args:
             survey_id: Survey to process.
+            target_phase: Pipeline phase to run up to. Defaults to "products"
+                (full pipeline). "scan" runs only setup → scan. The engine's
+                pull-chain resolves any required predecessor phases.
 
         Returns:
             The created ProcessingJob.
         """
         response = await self._client.post(
-            f"/api/v1/ingest/{survey_id}",
+            "/api/v1/process",
+            json={"survey_id": str(survey_id), "target_phase": target_phase},
         )
         response.raise_for_status()
         data = response.json()
 
-        # The ingest endpoint returns a dict with job_id, not a full ProcessingJob.
-        # Fetch the full job record.
+        # The /process endpoint returns a dict with job_id, not a full
+        # ProcessingJob. Fetch the full job record.
         if job_id := data.get("job_id"):
             return await self.get_job(job_id)