Feature/alerts aggregate data (#319)

* added method get_aggregate_data to alerts

* added tests

* added changelog

* fix style

* fix docs tense

CHANGELOG.md

@@ -22,6 +22,8 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 
 - `sdk.alerts.search()` accepts optional `page_num` and `page_size` arguments.
 
+- `sdk.alerts.get_aggregate_data()` to get alert summary and observations.
+
 ## 1.13.0 - 2021-04-14
 
 ### Added

src/py42/clients/alerts.py

@@ -123,3 +123,14 @@ def update_note(self, alert_id, note):
             :class:`py42.response.Py42Response`
         """
         return self._alert_service.update_note(alert_id, note)
+
+    def get_aggregate_data(self, alert_id):
+        """Gets alert summary with details about observations.
+
+        Args:
+            alert_id (str): Gets the details for the alert with the given ID.
+
+        Returns:
+            :class:`py42.response.Py42Response`
+        """
+        return self._alert_service.get_aggregate_data(alert_id)

src/py42/services/alerts.py

@@ -135,6 +135,13 @@ def update_note(self, alert_id, note):
         }
         return self._connection.post(uri, json=data)
 
+    def get_aggregate_data(self, alert_id):
+        uri = self._uri_prefix.format(u"query-details-aggregate")
+        data = {
+            u"alertId": alert_id,
+        }
+        return self._connection.post(uri, json=data)
+
 
 def _convert_observation_json_strings_to_objects(results):
     for alert in results[u"alerts"]:

tests/clients/test_alerts.py

@@ -85,3 +85,10 @@ def test_alerts_client_calls_search_all_pages_with_expected_value_and_param(
         query = '{"test": "data"}}'
         alert_client.search_all_pages(query)
         mock_alerts_service.search_all_pages.assert_called_once_with(query)
+
+    def test_alerts_client_calls_get_aggregate_data_with_expected_value_and_param(
+        self, mock_alerts_service, mock_alert_rules_service,
+    ):
+        alert_client = AlertsClient(mock_alerts_service, mock_alert_rules_service)
+        alert_client.get_aggregate_data("alert-id")
+        mock_alerts_service.get_aggregate_data.assert_called_once_with("alert-id")

tests/services/test_alerts.py

@@ -416,3 +416,15 @@ def test_search_posts_expected_data_overwrites_default_option_when_passed_page_n
             and post_data["groups"][0]["filters"][0]["term"] == "state"
             and post_data["groups"][0]["filters"][0]["value"] == "OPEN"
         )
+
+    def test_get_aggregate_data_calls_post_with_expected_url_and_data(
+        self, mock_connection, user_context
+    ):
+        alert_service = AlertService(mock_connection, user_context)
+        alert_service.get_aggregate_data("alert-id")
+        assert (
+            mock_connection.post.call_args[0][0]
+            == "/svc/api/v1/query-details-aggregate"
+        )
+        post_data = mock_connection.post.call_args[1]["json"]
+        assert post_data["alertId"] == "alert-id"