Improve "Organization preferences"

Use new methods `{get,update,patch}_preferences` to avoid confusion.

Author: amotl

grafana_client/elements/organization.py

@@ -183,8 +183,8 @@ def organization_preference_get(self):
         """
         :return:
         """
-        warnings.warn("Deprecated, please use `organization_preferences_get`", DeprecationWarning)
-        return self.organization_preferences_get()
+        warnings.warn("This method is deprecated, please use `get_preferences`", DeprecationWarning)
+        return self.get_preferences()
 
     def organization_preference_update(self, theme="", home_dashboard_id=0, timezone="utc"):
         """
@@ -194,11 +194,11 @@ def organization_preference_update(self, theme="", home_dashboard_id=0, timezone
         :param timezone:
         :return:
         """
-        warnings.warn("Deprecated, please use `organization_preferences_update`", DeprecationWarning)
+        warnings.warn("This method is deprecated, please use `update_preferences`", DeprecationWarning)
         preferences = PersonalPreferences(theme=theme, homeDashboardId=home_dashboard_id, timezone=timezone)
-        return self.organization_preferences_update(preferences)
+        return self.update_preferences(preferences)
 
-    def organization_preferences_get(self):
+    def get_preferences(self):
         """
         Retrieve preferences of current organization.
 
@@ -208,15 +208,15 @@ def organization_preferences_get(self):
         r = self.client.GET(update_preference)
         return r
 
-    def organization_preferences_update(self, preferences: PersonalPreferences):
+    def update_preferences(self, preferences: PersonalPreferences):
         """
         Update preferences of current organization as a whole.
 
         From the `preferences` instance, only attributes with values `not None` will be submitted.
         However, Grafana will reset all undefined attributes to its internal defaults.
 
         If you want to update specific preference attributes, without touching the others,
-        please use the `organization_preferences_patch` method.
+        please use the `patch_preferences` method.
 
         :param preferences:
         :return:
@@ -230,7 +230,7 @@ def organization_preferences_update(self, preferences: PersonalPreferences):
         )
         return r
 
-    def organization_preferences_patch(self, preferences: PersonalPreferences):
+    def patch_preferences(self, preferences: PersonalPreferences):
         """
         Update specific preferences of current organization.
 

test/elements/test_organization.py

@@ -32,26 +32,24 @@ def test_organization_preference_update(self, m):
         self.assertEqual(preference["message"], "Preferences updated")
 
     @requests_mock.Mocker()
-    def test_organization_preferences_get(self, m):
+    def test_get_preferences(self, m):
         m.get("http://localhost/api/org/preferences", json={"theme": "", "homeDashboardId": 0, "timezone": ""})
 
-        result = self.grafana.organizations.organization_preferences_get()
+        result = self.grafana.organizations.get_preferences()
         self.assertEqual(result["homeDashboardId"], 0)
 
     @requests_mock.Mocker()
-    def test_organization_preferences_update(self, m):
+    def test_update_preferences(self, m):
         m.put("http://localhost/api/org/preferences", json={"message": "Preferences updated"})
-        preference = self.grafana.organizations.organization_preferences_update(
+        preference = self.grafana.organizations.update_preferences(
             PersonalPreferences(theme="", homeDashboardId=999, timezone="utc")
         )
         self.assertEqual(preference["message"], "Preferences updated")
 
     @requests_mock.Mocker()
-    def test_organization_preferences_patch(self, m):
+    def test_patch_preferences(self, m):
         m.patch("http://localhost/api/org/preferences", json={"message": "Preferences updated"})
-        preference = self.grafana.organizations.organization_preferences_patch(
-            PersonalPreferences(homeDashboardUID="zgjG8dKVz")
-        )
+        preference = self.grafana.organizations.patch_preferences(PersonalPreferences(homeDashboardUID="zgjG8dKVz"))
         self.assertEqual(preference["message"], "Preferences updated")
 
     @requests_mock.Mocker()