edx-enterprise-subsidy-client 0.4.3__tar.gz → 0.4.4__tar.gz

{edx-enterprise-subsidy-client-0.4.3 → edx_enterprise_subsidy_client-0.4.4}/CHANGELOG.rst

@@ -14,6 +14,10 @@ Change Log
 Unreleased
 **********
 
+[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-0.4.3 → edx_enterprise_subsidy_client-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-subsidy-client
-Version: 0.4.3
+Version: 0.4.4
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -225,6 +225,10 @@ Change Log
 Unreleased
 **********
 
+[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-0.4.3 → edx_enterprise_subsidy_client-0.4.4}/edx_enterprise_subsidy_client/__init__.py

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

{edx-enterprise-subsidy-client-0.4.3 → edx_enterprise_subsidy_client-0.4.4}/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,42 @@ 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,
+        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,
+            '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 → edx_enterprise_subsidy_client-0.4.4}/edx_enterprise_subsidy_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-enterprise-subsidy-client
-Version: 0.4.3
+Version: 0.4.4
 Summary: Client for interacting with the enterprise-subsidy service.
 Home-page: https://github.com/openedx/edx-enterprise-subsidy-client
 Author: edX
@@ -225,6 +225,10 @@ Change Log
 Unreleased
 **********
 
+[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-0.4.3 → edx_enterprise_subsidy_client-0.4.4}/tests/test_client.py

@@ -172,3 +172,41 @@ def test_v2_list_subsidy_transactions(mock_oauth_client):
                 'page_size': 1,
             },
         )
+
+
+@mock.patch('edx_enterprise_subsidy_client.client.OAuthAPIClient', return_value=mock.MagicMock())
+def test_client_v2_create_subsidy_deposit(mock_oauth_client):
+    """
+    Test the client's ability to create subsidy deposits.
+    """
+    mocked_data = {
+        'uuid': str(uuid.uuid4()),
+    }
+    mock_post = mock_oauth_client.return_value.post
+    mock_post.return_value = MockResponse(mocked_data, 201)
+
+    subsidy_service_client = EnterpriseSubsidyAPIClientV2()
+
+    payload = {
+        'subsidy_uuid': uuid.uuid4(),
+        'desired_deposit_quantity': 100,
+        'sales_contract_reference_id': str(uuid.uuid4()),
+        'sales_contract_reference_provider': 'foo-bar',
+        'idempotency_key': 'hello',
+        'metadata': {'key': 'value'},
+    }
+
+    response = subsidy_service_client.create_subsidy_deposit(**payload)
+
+    assert response == mocked_data
+    expected_url = EnterpriseSubsidyAPIClientV2.DEPOSITS_CREATE_ENDPOINT.format(
+        subsidy_uuid=payload['subsidy_uuid'],
+    )
+    expected_post_payload = {
+        'desired_deposit_quantity': 100,
+        'sales_contract_reference_id': payload['sales_contract_reference_id'],
+        'sales_contract_reference_provider': 'foo-bar',
+        'idempotency_key': 'hello',
+        'metadata': {'key': 'value'},
+    }
+    mock_post.assert_called_once_with(expected_url, json=expected_post_payload)