edx-enterprise-subsidy-client 0.4.1__py2.py3-none-any.whl → 0.4.3__py2.py3-none-any.whl

edx_enterprise_subsidy_client/__init__.py

@@ -2,6 +2,6 @@
 Client for interacting with the enterprise-subsidy service..
 """
 
-__version__ = '0.4.1'
+__version__ = '0.4.3'
 
 from .client import EnterpriseSubsidyAPIClient, EnterpriseSubsidyAPIClientV2, get_enterprise_subsidy_api_client

edx_enterprise_subsidy_client/client.py

@@ -73,6 +73,41 @@ class EnterpriseSubsidyAPIClient:
             settings.BACKEND_SERVICE_EDX_OAUTH2_SECRET,
         )
 
+    def get_subsidy_aggregates_by_learner_url(self, subsidy_uuid):
+        """
+        Helper method to fetch subsidy learner aggregate data API url.
+        """
+        return f"{self.SUBSIDIES_ENDPOINT}{subsidy_uuid}/aggregates-by-learner"
+
+    def get_subsidy_aggregates_by_learner_data(self, subsidy_uuid, policy_uuid=None):
+        """
+        Client method to fetch subsidy specific learner aggregate data.
+
+        Args:
+            subsidy_uuid (str): Subsidy record UUID
+            policy_uuid (string): Optional param to filter subsidy aggregate data by subsidy access policy UUID
+        Returns:
+            json subsidy learner aggregate data response:
+                [{
+                    'lms_user_id': '1337',
+                    'enrollment_count': 45,
+                } ... ]
+        """
+        url = self.get_subsidy_aggregates_by_learner_url(subsidy_uuid)
+        if policy_uuid:
+            url += f"?subsidy_access_policy_uuid={policy_uuid}"
+        try:
+            resp = self.client.get(url)
+            response_data = resp
+            resp.raise_for_status()
+        except requests.exceptions.HTTPError as exc:
+            logger.exception(
+                f'Subsidy client failed to fetch aggregate data for {subsidy_uuid} '
+                f'and policy: {policy_uuid}'
+            )
+            raise exc
+        return response_data.json()
+
     def get_content_metadata_url(self, content_identifier):
         """Helper method to generate the subsidy service metadata API url, with a trailing slash."""
         return self.CONTENT_METADATA_ENDPOINT + content_identifier + '/'

{edx_enterprise_subsidy_client-0.4.1.dist-info → edx_enterprise_subsidy_client-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-subsidy-client
-Version: 0.4.1
+Version: 0.4.3
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -225,8 +225,15 @@ Change Log
 Unreleased
 **********
 
+[0.4.3]
+*******
+* feat: adding new subsidy client method to fetch subsidy aggregate data
+
+[0.4.2]
+*******
 * Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
   deprecated
+* Add python 3.12 support
 
 [0.4.1]
 *******

edx_enterprise_subsidy_client-0.4.3.dist-info/RECORD

@@ -0,0 +1,8 @@
+edx_enterprise_subsidy_client/__init__.py,sha256=ohnfF6pu_QiBBqJuz8O3HJhED7cUdSsYU2qj5HDT0fI,205
+edx_enterprise_subsidy_client/client.py,sha256=omt6lIVuGu4GtbYu45u5ghCKUzg-309EDpnGqldTWMw,13212
+edx_enterprise_subsidy_client-0.4.3.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+edx_enterprise_subsidy_client-0.4.3.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
+edx_enterprise_subsidy_client-0.4.3.dist-info/METADATA,sha256=9QwvAwDzaH4HDoiSPyv30l8VfJADkUajv1qFGZ64Aeg,9585
+edx_enterprise_subsidy_client-0.4.3.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+edx_enterprise_subsidy_client-0.4.3.dist-info/top_level.txt,sha256=X3PxOH44rjQXFaA8EX-ZpUEL4SjfMM_yUkS-KbvNIZk,30
+edx_enterprise_subsidy_client-0.4.3.dist-info/RECORD,,

{edx_enterprise_subsidy_client-0.4.1.dist-info → edx_enterprise_subsidy_client-0.4.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any

edx_enterprise_subsidy_client-0.4.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-edx_enterprise_subsidy_client/__init__.py,sha256=Qago1ji3EXcw5_c2Kjq5XF2IkFbZqRuwci3kGut6Qt8,205
-edx_enterprise_subsidy_client/client.py,sha256=56yVQkW6Mgbcm1qTYpJInBVMyIqG3QQSIm4q5MB1MHc,11836
-edx_enterprise_subsidy_client-0.4.1.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-edx_enterprise_subsidy_client-0.4.1.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
-edx_enterprise_subsidy_client-0.4.1.dist-info/METADATA,sha256=Z36WHMQceViigljVvODv5LkpWqaLgkPcxKHiCOLmzsw,9453
-edx_enterprise_subsidy_client-0.4.1.dist-info/WHEEL,sha256=iYlv5fX357PQyRT2o6tw1bN-YcKFFHKqB_LwHO5wP-g,110
-edx_enterprise_subsidy_client-0.4.1.dist-info/top_level.txt,sha256=X3PxOH44rjQXFaA8EX-ZpUEL4SjfMM_yUkS-KbvNIZk,30
-edx_enterprise_subsidy_client-0.4.1.dist-info/RECORD,,