update function param of get_area_weighted_series_df to allow multiple regions

Author: cn1036

groclient/client.py

@@ -1995,7 +1995,7 @@ def reverse_geocode_points(self, points: list):
     def get_area_weighted_series_df(
         self,
         series: Dict[str, int],
-        region_id: int,
+        region_ids: List[int],
         weights: Optional[List[Dict[str, int]]] = None,
         weight_names: Optional[List[str]] = None,
         start_date: Optional[str] = None,
@@ -2011,8 +2011,8 @@ def get_area_weighted_series_df(
         series: dict
             A dictionary that maps required entity types to its value.
             e.g. {"item_id": 321, "metric_id": 70029, "frequency_id": 3, "source_id": 3}
-        region_id: integer
-            The region for which the weighted series will be computed
+        region_ids: list of integer
+            The selected regions for which the weighted series will be computed
             Supported region levels are (1, 2, 3, 4, 5, 8)
         weights: list of dict
             A list of dictionaries with each representing a weight object. Mutually exclusive with "weight_names".
@@ -2041,7 +2041,7 @@ def get_area_weighted_series_df(
             self.access_token,
             self.api_host,
             series,
-            region_id,
+            region_ids,
             weights,
             weight_names,
             start_date,

groclient/client_test.py

@@ -725,7 +725,7 @@ def test_get_area_weighted_series_df(self):
                 "frequency_id": 3,
                 "source_id": 3
             },
-            "region_id": 1215,
+            "region_ids": [1215],
             "weight_names": ["Wheat"],
             "start_date": "2023-10-01"
         }

groclient/lib.py

@@ -883,15 +883,15 @@ def validate_series_object(series_object):
 
 def generate_payload_for_v2_area_weighting(
     series: Dict[str, int],
-    region_id: int,
+    region_ids: List[int],
     weights: Optional[List[Dict[str, int]]] = None,
     weight_names: Optional[List[str]] = None,
     start_date: Optional[str] = None,
     end_date: Optional[str] = None,
     method: Optional[str] = "sum",
 ):
     payload = {
-        "region_id": region_id,
+        "region_ids": region_ids,
         "method": method,
     }
 
@@ -959,7 +959,7 @@ def get_area_weighted_series_df(
     access_token: str,
     api_host: str,
     series: Dict[str, int],
-    region_id: int,
+    region_ids: List[int],
     weights: Optional[List[Dict[str, int]]] = None,
     weight_names: Optional[List[str]] = None,
     start_date: Optional[str] = None,
@@ -968,7 +968,7 @@ def get_area_weighted_series_df(
 ) -> pd.DataFrame:
     payload = generate_payload_for_v2_area_weighting(
         series,
-        region_id,
+        region_ids,
         weights,
         weight_names,
         start_date,

groclient/lib_test.py

@@ -1228,7 +1228,7 @@ def test_get_area_weighted_series_df(mock_requests_post):
             "frequency_id": 3,
             "source_id": 3
         },
-        "region_id": 1215,
+        "region_ids": [1215],
         "weight_names": ["Corn", "Wheat"],
         "start_date": "2023-10-01"
     }