python-terminusgps 33.2.0__py3-none-any.whl → 33.3.0__py3-none-any.whl

{python_terminusgps-33.2.0.dist-info → python_terminusgps-33.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 33.2.0
+Version: 33.3.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://docs.terminusgps.com
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-33.2.0.dist-info → python_terminusgps-33.3.0.dist-info}/RECORD

@@ -3,7 +3,7 @@ terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 terminusgps/authorizenet/auth.py,sha256=umNpOXObDrIt2K40padWBedQl7tVAmEg2alBWhGk-qQ,1238
 terminusgps/authorizenet/constants.py,sha256=xmulPmiBLhFfZoc7Il3l-DZA9Nq5HSaJmJKU-v-5X-Y,420
 terminusgps/authorizenet/controllers.py,sha256=9t62qdGpmAkP4tNyPefd7vBRutXvMWsxql6z_pg52Bg,2146
-terminusgps/authorizenet/utils.py,sha256=zmBVqRamCmxEO6tZWRaGPn5uvL_Lr0yO36Lgc954m8k,2930
+terminusgps/authorizenet/utils.py,sha256=FrKqXWrplcgiET1rDTmUaqmN_ze7j93jWgfFeJR8rlg,7073
 terminusgps/authorizenet/profiles/__init__.py,sha256=IG4XCEEYtHKqXOatlZlob6J3ukAgF7cFR-RXxOSMS1c,161
 terminusgps/authorizenet/profiles/addresses.py,sha256=xDlnFlIjuR7NVXwfj5aJT9E_GolnYFuYASkfenvWfm8,6292
 terminusgps/authorizenet/profiles/base.py,sha256=lPc8Pugp5EcXtZmeBpeqicij7l0ROGvMYTV8J0fLLmQ,3768
@@ -12,7 +12,7 @@ terminusgps/authorizenet/profiles/payments.py,sha256=MmjvE4ZSfgyGPRUzeREB_dX_n6Q
 terminusgps/authorizenet/profiles/subscriptions.py,sha256=m_jb9GqeD1tLmeqSnaGwJrzPcQOulEkF8K1wCaqKR24,7924
 terminusgps/authorizenet/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/tests/test_auth.py,sha256=sdByYrcv8RKjcJckOHbyHH1z_M4qrATFI3qj_XDQXbk,1624
-terminusgps/authorizenet/tests/test_profiles.py,sha256=24lo71F5MWOUNdB2MwTAstPUkyfZ58aOiIxiRwyWcd0,7476
+terminusgps/authorizenet/tests/test_profiles.py,sha256=tvLBY0iSAC33RlWiBP_NSnPskUQBjfrf0YHMpR-m22k,7566
 terminusgps/authorizenet/tests/test_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/connect.py,sha256=TWf2bVz6LqSNQfVD7FKRn3K71VuLOwBj05Gs-9BsROg,693
@@ -53,7 +53,7 @@ terminusgps/wialon/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 terminusgps/wialon/tests/test_items.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/tests/test_session.py,sha256=9mBlYchMo9NeqRIZsmxYzrM1zBHorqu4ooxqSNppLpI,1336
 terminusgps/wialon/tests/test_utils.py,sha256=SK4PxJQGECFnzx_EQeRAQfsQ5_3FLaVcis2W9u_ibuI,1730
-python_terminusgps-33.2.0.dist-info/METADATA,sha256=zRen2hb6Tb8T0FM81XTAcRPElynhCVAPPt4hoN4hVJY,1581
-python_terminusgps-33.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-33.2.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-33.2.0.dist-info/RECORD,,
+python_terminusgps-33.3.0.dist-info/METADATA,sha256=CMGz4nsoWA7NjUaj9BPHN8WVudEFlyYj_UwqUH0T8R8,1581
+python_terminusgps-33.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-33.3.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-33.3.0.dist-info/RECORD,,

terminusgps/authorizenet/tests/test_profiles.py

@@ -149,7 +149,9 @@ class PaymentProfileTestCase(TestCase):
     def test_payment_profile_create(self) -> None:
         """Fails if a payment profile is not properly created in Authorizenet."""
         test_payment_profile = PaymentProfile(
-            id=None, customer_profile_id=self.test_customer_profile.id, default=True
+            id=None,
+            customer_profile_id=str(self.test_customer_profile.id),
+            default=True,
         )
         test_payment_profile.id = test_payment_profile.create(
             address=self.test_address_obj, payment=self.test_payment_obj
@@ -159,7 +161,9 @@ class PaymentProfileTestCase(TestCase):
     def test_payment_profile_delete(self) -> None:
         """Fails if a payment profile is not properly deleted in Authorizenet."""
         test_payment_profile = PaymentProfile(
-            id=None, customer_profile_id=self.test_customer_profile.id, default=True
+            id=None,
+            customer_profile_id=str(self.test_customer_profile.id),
+            default=True,
         )
         test_payment_profile.id = test_payment_profile.create(
             address=self.test_address_obj, payment=self.test_payment_obj
@@ -170,7 +174,9 @@ class PaymentProfileTestCase(TestCase):
     def test_payment_profile_last_4(self) -> None:
         """Fails if a payment profile's last 4 credit card digits are not properly retrieved."""
         test_payment_profile = PaymentProfile(
-            id=None, customer_profile_id=self.test_customer_profile.id, default=True
+            id=None,
+            customer_profile_id=str(self.test_customer_profile.id),
+            default=True,
         )
         test_payment_profile.id = test_payment_profile.create(
             address=self.test_address_obj, payment=self.test_payment_obj

terminusgps/authorizenet/utils.py

@@ -5,11 +5,107 @@ from .auth import get_merchant_auth
 from .controllers import AuthorizenetControllerExecutor
 
 
+def get_payment_profile_transactions(
+    customer_profile_id: int | str,
+    payment_profile_id: int | str,
+    descending: bool = False,
+    limit: int = 100,
+    offset: int = 0,
+) -> dict | None:
+    """
+    Returns a transaction list for a customer payment profile.
+
+    `getTransactionListForCustomerRequest <https://developer.authorize.net/api/reference/index.html#transaction-reporting-get-customer-profile-transaction-list>`_
+
+    :param customer_profile_id: A customer profile id.
+    :type customer_profile_id: :py:obj:`int` | :py:obj:`str`
+    :param payment_profile_id: A customer payment profile id.
+    :type payment_profile_id: :py:obj:`int` | :py:obj:`str`
+    :param descending: Whether or not to sort the response in descending order. Default is :py:obj:`False`.
+    :type descending: :py:obj:`bool`
+    :param limit: Maximum amount of transactions to return in the response. Default is :py:obj:`100` .
+    :type limit: :py:obj:`int`
+    :param offset: Offsets the response for pagination. Default is :py:obj:`0` for page 0.
+    :type offset: :py:obj:`int`
+    :raises ValueError: If ``customer_profile_id`` was provided as a string containing non-digits.
+    :raises ValueError: If ``payment_profile_id`` was provided as a string containing non-digits.
+    :raises AuthorizenetControllerExecutionError: If the API call fails.
+    :returns: A merchant details object, if found.
+    :rtype: :py:obj:`dict` | :py:obj:`None`
+
+    """
+    raise NotImplementedError
+
+    if isinstance(customer_profile_id, str) and not customer_profile_id.isdigit():
+        raise ValueError(
+            f"'customer_profile_id' can only contain digits, got '{customer_profile_id}'."
+        )
+    if isinstance(payment_profile_id, str) and not payment_profile_id.isdigit():
+        raise ValueError(
+            f"'payment_profile_id' can only contain digits, got '{payment_profile_id}'."
+        )
+
+    request = apicontractsv1.getTransactionListForCustomerRequest(
+        merchantAuthentication=get_merchant_auth(),
+        customerProfileId=str(customer_profile_id),
+        customerPaymentProfileId=str(payment_profile_id),
+        sorting={
+            "orderBy": "submitTimeUTC",
+            "orderDescending": str(descending).lower(),
+        },
+        paging={"limit": limit, "offset": offset},
+    )
+    controller = apicontrollers.getTransactionListForCustomerController(request)
+    return AuthorizenetControllerExecutor.execute_controller(controller)
+
+
+def get_merchant_details() -> dict | None:
+    """
+    Returns Authorizenet merchant details.
+
+    `getMerchantDetailsRequest <http://developer.authorize.net/api/reference/index.html#transaction-reporting-get-merchant-details>`_
+
+    :raises AuthorizenetControllerExecutionError: If the API call fails.
+    :returns: A merchant details object, if found.
+    :rtype: :py:obj:`dict` | :py:obj:`None`
+
+    """
+    request = apicontractsv1.getMerchantDetailsRequest(
+        merchantAuthentication=get_merchant_auth()
+    )
+    controller = apicontrollers.getMerchantDetailsController(request)
+    return AuthorizenetControllerExecutor.execute_controller(controller)
+
+
+def get_transaction(id: int | str) -> dict | None:
+    """
+    Returns Authorizenet transaction details by id.
+
+    `getTransactionDetailsRequest <https://developer.authorize.net/api/reference/index.html#transaction-reporting-get-transaction-details>`_
+
+    :param id: An Authorizenet transaction id.
+    :type id: :py:obj:`int` | :py:obj:`str`
+    :raises ValueError: If ``id`` was provided as a string containing non-digits.
+    :raises AuthorizenetControllerExecutionError: If the API call fails.
+    :returns: A transaction object, if found.
+    :rtype: :py:obj:`dict` | :py:obj:`None`
+
+    """
+    if isinstance(id, str) and not id.isdigit():
+        raise ValueError(f"'id' can only contain digits, got '{id}'.")
+
+    request = apicontractsv1.getTransactionDetailsRequest(
+        merchantAuthentication=get_merchant_auth(), transId=str(id)
+    )
+    controller = apicontrollers.getTransactionDetailsController(request)
+    return AuthorizenetControllerExecutor.execute_controller(controller)
+
+
 def get_customer_profile_ids() -> list[int]:
     """
     Returns a list of all customer profile ids in Authorizenet.
 
-    :raises ControllerExecutionError: If the API call fails.
+    :raises AuthorizenetControllerExecutionError: If the API call fails.
     :returns: A list of all customer profile ids in Authorizenet.
     :rtype: :py:obj:`list`