edx-enterprise-subsidy-client 0.4.3__py2.py3-none-any.whl → 1.0.0__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.3'
+__version__ = '1.0.0'
 
 from .client import EnterpriseSubsidyAPIClient, EnterpriseSubsidyAPIClientV2, get_enterprise_subsidy_api_client

edx_enterprise_subsidy_client/client.py

@@ -291,6 +291,7 @@ class EnterpriseSubsidyAPIClientV2(EnterpriseSubsidyAPIClient):  # pylint: disab
     """
     V2_BASE_URL = EnterpriseSubsidyAPIClient.API_BASE_URL + 'v2/'
     TRANSACTIONS_LIST_ENDPOINT = V2_BASE_URL + 'subsidies/{subsidy_uuid}/admin/transactions/'
+    DEPOSITS_CREATE_ENDPOINT = V2_BASE_URL + 'subsidies/{subsidy_uuid}/admin/deposits/'
 
     def list_subsidy_transactions(
         self, subsidy_uuid, include_aggregates=True,
@@ -370,3 +371,43 @@ class EnterpriseSubsidyAPIClientV2(EnterpriseSubsidyAPIClient):  # pylint: disab
         )
         response.raise_for_status()
         return response.json()
+
+    def create_subsidy_deposit(
+        self,
+        subsidy_uuid,
+        desired_deposit_quantity,
+        sales_contract_reference_id,
+        sales_contract_reference_provider,
+        metadata=None,
+        idempotency_key=None,
+    ):
+        """
+        Creates a deposit in the given subsidy, requires operator-level permissions.
+
+        Raises:
+            requests.exceptions.HTTPError:
+                - 403 Forbidden: If auth failed.
+                - 429 Too Many Requests: If the ledger was locked (resource contention, try again later).
+                - 400 Bad Request: If any of the values were invalid. Reasons include:
+                      * non-positive quantity.
+                      * provider slug does not exist in database.
+                - 422 Unprocessable Entity: Catchall status for anything that prevented the deposit from being
+                  created.  Reasons include, but are not limited to:
+                      * Subsidy is inactive.
+                      * Another deposit with same idempotency_key already exists.
+        """
+        request_payload = {
+            'desired_deposit_quantity': desired_deposit_quantity,
+            'sales_contract_reference_id': sales_contract_reference_id,
+            'sales_contract_reference_provider': sales_contract_reference_provider,
+        }
+        if metadata is not None:
+            request_payload['metadata'] = metadata
+        if idempotency_key is not None:
+            request_payload['idempotency_key'] = idempotency_key
+        response = self.client.post(
+            self.DEPOSITS_CREATE_ENDPOINT.format(subsidy_uuid=subsidy_uuid),
+            json=request_payload,
+        )
+        response.raise_for_status()
+        return response.json()

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: edx-enterprise-subsidy-client
-Version: 0.4.3
+Version: 1.0.0
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -12,11 +12,21 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
 License-File: LICENSE
 License-File: LICENSE.txt
 Requires-Dist: edx-rest-api-client
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 edx-enterprise-subsidy-client
 #############################
@@ -225,6 +235,24 @@ Change Log
 Unreleased
 **********
 
+[1.0.0]
+*******
+* fix: Remove Python 3.8 Support
+* chore: Update Python Requirements
+* chore: Update pylintrc
+
+[0.4.6]
+*******
+* fix: Update the name of reviewers team in github flow
+
+[0.4.5]
+*******
+* fix: create_subsidy_deposit - metadata is optional (ENT-9133)
+
+[0.4.4]
+*******
+* feat: add support for deposit creation (ENT-9133)
+
 [0.4.3]
 *******
 * feat: adding new subsidy client method to fetch subsidy aggregate data

edx_enterprise_subsidy_client-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+edx_enterprise_subsidy_client/__init__.py,sha256=YCmaYBnrCruOG6IjN7HZ7vKXrZqnUiCZksGHWaziadM,205
+edx_enterprise_subsidy_client/client.py,sha256=ueCdV8Fb3hufsTqbNIjIjvK4Wz3grc9UpKCsk_uO1lw,15048
+edx_enterprise_subsidy_client-1.0.0.dist-info/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+edx_enterprise_subsidy_client-1.0.0.dist-info/LICENSE.txt,sha256=QTW2QN7q3XszgUAXm9Dzgtu5LXYKbR1SGnqMa7ufEuY,35139
+edx_enterprise_subsidy_client-1.0.0.dist-info/METADATA,sha256=zNVIcSFmg0k2YfotgznHgvxznDhmEenUXOh5LqXJmKs,10119
+edx_enterprise_subsidy_client-1.0.0.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
+edx_enterprise_subsidy_client-1.0.0.dist-info/top_level.txt,sha256=X3PxOH44rjQXFaA8EX-ZpUEL4SjfMM_yUkS-KbvNIZk,30
+edx_enterprise_subsidy_client-1.0.0.dist-info/RECORD,,

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

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

edx_enterprise_subsidy_client-0.4.3.dist-info/RECORD

@@ -1,8 +0,0 @@
-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,,