Improve "Team preferences"

- Align with model-based conversation introduced with improvements to
  "Organization preferences", now using `PersonalPreferences`.

Author: amotl

grafana_client/elements/organization.py

@@ -1,6 +1,6 @@
 import warnings
 
-from ..model import UserOrganizationPreferences
+from ..model import PersonalPreferences
 from .base import Base
 
 
@@ -195,7 +195,7 @@ def organization_preference_update(self, theme="", home_dashboard_id=0, timezone
         :return:
         """
         warnings.warn("Deprecated, please use `organization_preferences_update`", DeprecationWarning)
-        preferences = UserOrganizationPreferences(theme=theme, homeDashboardId=home_dashboard_id, timezone=timezone)
+        preferences = PersonalPreferences(theme=theme, homeDashboardId=home_dashboard_id, timezone=timezone)
         return self.organization_preferences_update(preferences)
 
     def organization_preferences_get(self):
@@ -208,7 +208,7 @@ def organization_preferences_get(self):
         r = self.client.GET(update_preference)
         return r
 
-    def organization_preferences_update(self, preferences: UserOrganizationPreferences):
+    def organization_preferences_update(self, preferences: PersonalPreferences):
         """
         Update preferences of current organization as a whole.
 
@@ -230,7 +230,7 @@ def organization_preferences_update(self, preferences: UserOrganizationPreferenc
         )
         return r
 
-    def organization_preferences_patch(self, preferences: UserOrganizationPreferences):
+    def organization_preferences_patch(self, preferences: PersonalPreferences):
         """
         Update specific preferences of current organization.
 

grafana_client/elements/team.py

@@ -1,3 +1,6 @@
+import typing as t
+
+from ..model import PersonalPreferences
 from .base import Base
 
 
@@ -142,15 +145,24 @@ def get_team_preferences(self, team_id):
         r = self.client.GET(get_team_preferences_path)
         return r
 
-    def update_team_preferences(self, team_id, preferences):
+    def update_team_preferences(self, team_id, preferences: t.Union[PersonalPreferences, t.Dict]):
         """
 
         :param team_id:
         :param preferences:
         :return:
         """
         update_team_preferences_path = "/teams/%s/preferences" % team_id
-        r = self.client.PUT(update_team_preferences_path, json=preferences)
+        if isinstance(preferences, dict):
+            data = preferences
+        elif isinstance(preferences, PersonalPreferences):
+            data = preferences.asdict(filter_none=True)
+        else:
+            raise TypeError(
+                f"Unable to use data type '{type(preferences)}' for updating preferences. "
+                f"Use `PersonalPreferences` or `dict`."
+            )
+        r = self.client.PUT(update_team_preferences_path, json=data)
         return r
 
     def get_team_external_group(self, team_id):

grafana_client/model.py

@@ -70,9 +70,9 @@ def asdict_compact(self):
 
 
 @dataclasses.dataclass
-class UserOrganizationPreferences:
+class PersonalPreferences:
     """
-    Request/response model for user- and organization-preferences.
+    Request/response model for user-, team- and organization-preferences.
 
     https://grafana.com/docs/grafana/latest/developers/http_api/preferences/
     """

test/elements/test_organization.py

@@ -3,7 +3,7 @@
 import requests_mock
 
 from grafana_client import GrafanaApi
-from grafana_client.model import UserOrganizationPreferences
+from grafana_client.model import PersonalPreferences
 
 
 class OrganizationTestCase(unittest.TestCase):
@@ -42,15 +42,15 @@ def test_organization_preferences_get(self, m):
     def test_organization_preferences_update(self, m):
         m.put("http://localhost/api/org/preferences", json={"message": "Preferences updated"})
         preference = self.grafana.organizations.organization_preferences_update(
-            UserOrganizationPreferences(theme="", homeDashboardId=999, timezone="utc")
+            PersonalPreferences(theme="", homeDashboardId=999, timezone="utc")
         )
         self.assertEqual(preference["message"], "Preferences updated")
 
     @requests_mock.Mocker()
     def test_organization_preferences_patch(self, m):
         m.patch("http://localhost/api/org/preferences", json={"message": "Preferences updated"})
         preference = self.grafana.organizations.organization_preferences_patch(
-            UserOrganizationPreferences(homeDashboardUID="zgjG8dKVz")
+            PersonalPreferences(homeDashboardUID="zgjG8dKVz")
         )
         self.assertEqual(preference["message"], "Preferences updated")
 

test/elements/test_team.py

@@ -4,6 +4,7 @@
 import requests_mock
 
 from grafana_client import GrafanaApi
+from grafana_client.model import PersonalPreferences
 
 
 class TeamsTestCase(unittest.TestCase):
@@ -251,12 +252,26 @@ def test_get_team_preferences(self, m):
         self.assertEqual(prefs["homeDashboardId"], 0)
 
     @requests_mock.Mocker()
-    def test_update_team_preferences(self, m):
+    def test_update_team_preferences_dict(self, m):
         m.put(
             "http://localhost/api/teams/1/preferences",
             json={"message": "Preferences updated"},
         )
-        prefs = {"theme": "light", "homeDashboardId": 0, "timezone": ""}
+        prefs = {"theme": "light", "homeDashboardId": 0, "timezone": "utc"}
+
+        updates = self.grafana.teams.update_team_preferences("1", prefs)
+        history = m.request_history
+        json_payload = history[0].json()
+        self.assertEqual(json_payload["theme"], "light")
+        self.assertEqual(updates["message"], "Preferences updated")
+
+    @requests_mock.Mocker()
+    def test_update_team_preferences_model(self, m):
+        m.put(
+            "http://localhost/api/teams/1/preferences",
+            json={"message": "Preferences updated"},
+        )
+        prefs = PersonalPreferences(theme="light", homeDashboardId=0, timezone="utc")
 
         updates = self.grafana.teams.update_team_preferences("1", prefs)
         history = m.request_history