feat: add AssetsService.exists() with mocked tests

Author: radu-mocanu

packages/uipath-platform/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-platform"
-version = "0.1.84"
+version = "0.1.85"
 description = "HTTP client library for programmatic access to UiPath Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

packages/uipath-platform/src/uipath/platform/orchestrator/_assets_service.py

@@ -602,6 +602,51 @@ async def update_async(
 
         return response.json()
 
+    @traced(name="assets_exists", run_type="uipath")
+    def exists(
+        self,
+        name: str,
+        *,
+        folder_key: Optional[str] = None,
+        folder_path: Optional[str] = None,
+    ) -> bool:
+        """Check whether an asset with the given name exists.
+
+        Args:
+            name (str): The name of the asset.
+            folder_key (Optional[str]): The key of the folder. Override the default one set in the SDK config.
+            folder_path (Optional[str]): The path of the folder. Override the default one set in the SDK config.
+
+        Returns:
+            bool: True if an asset with the given name exists, False otherwise.
+
+        Examples:
+            ```python
+            from uipath.platform import UiPath
+
+            client = UiPath()
+
+            client.assets.exists(name="MyAsset")
+            ```
+        """
+        spec = self._list_spec(
+            folder_path=folder_path,
+            folder_key=folder_key,
+            filter=f"Name eq '{name}'",
+            orderby=None,
+            skip=0,
+            top=1,
+        )
+        response = self.request(
+            spec.method,
+            url=spec.endpoint,
+            params=spec.params,
+            content=spec.content,
+            headers=spec.headers,
+            json=spec.json,
+        )
+        return len(response.json().get("value", [])) > 0
+
     @property
     def custom_headers(self) -> Dict[str, str]:
         return self.folder_headers

packages/uipath-platform/tests/services/test_assets_service.py

@@ -177,6 +177,55 @@ def test_retrieve_asset(
                 == f"UiPath.Python.Sdk/UiPath.Python.Sdk.Activities.AssetsService.retrieve/{version}"
             )
 
+    class TestExistsAsset:
+        def test_exists_returns_true(
+            self,
+            httpx_mock: HTTPXMock,
+            base_url: str,
+            org: str,
+            tenant: str,
+            version: str,
+            config: UiPathApiConfig,
+            monkeypatch: pytest.MonkeyPatch,
+        ) -> None:
+            monkeypatch.delenv("UIPATH_ROBOT_KEY", raising=False)
+            service = AssetsService(
+                config=config,
+                execution_context=UiPathExecutionContext(),
+            )
+
+            httpx_mock.add_response(
+                url=f"{base_url}{org}{tenant}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetFiltered?$skip=0&$top=1&$filter=Name eq 'MyAsset'",
+                status_code=200,
+                json={"value": [{"Key": "asset-key-1", "Name": "MyAsset"}]},
+            )
+
+            assert service.exists(name="MyAsset") is True
+
+        def test_exists_returns_false(
+            self,
+            httpx_mock: HTTPXMock,
+            base_url: str,
+            org: str,
+            tenant: str,
+            version: str,
+            config: UiPathApiConfig,
+            monkeypatch: pytest.MonkeyPatch,
+        ) -> None:
+            monkeypatch.delenv("UIPATH_ROBOT_KEY", raising=False)
+            service = AssetsService(
+                config=config,
+                execution_context=UiPathExecutionContext(),
+            )
+
+            httpx_mock.add_response(
+                url=f"{base_url}{org}{tenant}/orchestrator_/odata/Assets/UiPath.Server.Configuration.OData.GetFiltered?$skip=0&$top=1&$filter=Name eq 'Missing'",
+                status_code=200,
+                json={"value": []},
+            )
+
+            assert service.exists(name="Missing") is False
+
     class TestListAssets:
         def test_list_assets(
             self,