fix get accepted licences

Author: malmans2

cads_api_client/api_client.py

@@ -205,6 +205,27 @@ def estimate_costs(self, collection_id: str, **request: Any) -> dict[str, Any]:
         """
         return self.get_process(collection_id).estimate_costs(**request)
 
+    def get_accepted_licences(
+        self,
+        scope: Literal["all", "dataset", "portal"] | None = None,
+    ) -> list[dict[str, Any]]:
+        """Retrieve acccepted licences.
+
+        Parameters
+        ----------
+        scope: str | None
+            Licence scope. Options: ``"all", "dataset", "portal"``.
+
+        Returns
+        -------
+        list[dict[str, Any]]
+            List of dictionaries with license information.
+        """
+        params = {k: v for k, v in zip(["scope"], [scope]) if v is not None}
+        licences: list[dict[str, Any]]
+        licences = self._profile_api.accepted_licences(**params).get("licences", [])
+        return licences
+
     def get_collection(self, collection_id: str) -> cads_api_client.Collection:
         """Retrieve a catalogue collection.
 
@@ -424,16 +445,3 @@ def submit_and_wait_on_results(
         cads_api_client.Results
         """
         return self._retrieve_api.submit(collection_id, **request).make_results()
-
-    @property
-    def accepted_licences(self) -> list[dict[str, Any]]:
-        """Accepted licences.
-
-        Returns
-        -------
-        list[dict[str, Any]]
-            List of dictionaries with license information.
-        """
-        licences: list[dict[str, Any]]
-        licences = self._profile_api.accepted_licences.get("licences", [])
-        return licences

cads_api_client/profile.py

@@ -50,10 +50,9 @@ def accept_licence(self, licence_id: str, revision: int) -> dict[str, Any]:
         url = f"{self.url}/account/licences/{licence_id}"
         return self._get_api_response("put", url, json={"revision": revision}).json
 
-    @property
-    def accepted_licences(self) -> dict[str, Any]:
+    def accepted_licences(self, **params: Any) -> dict[str, Any]:
         url = f"{self.url}/account/licences"
-        return self._get_api_response("get", url).json
+        return self._get_api_response("get", url, params=params).json
 
     def check_authentication(self) -> dict[str, Any]:
         url = f"{self.url}/account/verification/pat"

tests/integration_test_50_profile.py

@@ -1,18 +1,23 @@
+from typing import Literal
+
 import pytest
 from requests import HTTPError
 
 from cads_api_client import ApiClient, config
 
 
-def test_api_client_accept_licence() -> None:
+@pytest.mark.parametrize("scope", [None, "all", "dataset", "portal"])
+def test_api_client_accept_licence(
+    scope: Literal["all", "dataset", "portal"] | None,
+) -> None:
     try:
         # Can not use anonymous user
         config.get_config("key")
     except Exception:
         pytest.skip("The API key is missing")
 
     client = ApiClient(maximum_tries=0)
-    licence = client.get_licences()[0]
+    licence = client.get_licences(scope=scope)[0]
     licence_id = licence["id"]
     licence_revision = licence["revision"]
 
@@ -22,7 +27,7 @@ def test_api_client_accept_licence() -> None:
 
     assert any(
         licence["id"] == licence_id and licence["revision"] == licence_revision
-        for licence in client.accepted_licences
+        for licence in client.get_accepted_licences(scope=scope)
     )