python-terminusgps 40.0.0__py3-none-any.whl → 40.1.0__py3-none-any.whl

{python_terminusgps-40.0.0.dist-info → python_terminusgps-40.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 40.0.0
+Version: 40.1.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-40.0.0.dist-info → python_terminusgps-40.1.0.dist-info}/RECORD

@@ -2,13 +2,14 @@ terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/authorizenet/auth.py,sha256=CKT_pfDEL-53GceOEaFtIU6IBXVuVd8MVHikpPAX0xY,1184
 terminusgps/authorizenet/constants.py,sha256=uXkYVmQPrnYBDfGahVEmzwTny21A8jGcrH7qfSdLhvc,512
-terminusgps/authorizenet/controllers.py,sha256=rMuBwSoKJjte7wVuB1ewaqnzfuDXxwus-d5mkqbfnGE,2193
+terminusgps/authorizenet/controllers.py,sha256=Kqp-cvHwX_TCbRa_xoCVV6A9Ky1bQuaX8PJpQFRfFOI,2685
+terminusgps/authorizenet/subscriptions.py,sha256=8QPLMwLXHu3SLapGsNKoasTUiPqCd7GkK7UpXsXp5wk,3996
 terminusgps/authorizenet/utils.py,sha256=LosPGnOam97Fk51aoCAIdoyrQRdxV43mXxpZ1TsmPDQ,7042
 terminusgps/authorizenet/validators.py,sha256=Z4JfKMHhMIH9elsmzW-6KHi9TwOlNp3h_uvtRPCX0GI,3822
 terminusgps/authorizenet/profiles/__init__.py,sha256=WYODXV43js8JN_rd__0FiW0-6GsiDPqfOAIlpyASiak,74
-terminusgps/authorizenet/profiles/addresses.py,sha256=UYK1PzOX2dcQVQ6TwnTdTvJSFXMW9IRH_7f1AKs27o8,4809
-terminusgps/authorizenet/profiles/customers.py,sha256=mOK5OhAPjVgymuQo7IkURk0N6z04wiKUvHvgF0Io868,4597
-terminusgps/authorizenet/profiles/payments.py,sha256=cP-HzBpjB22nT_rTxTWvjA0vEsO2rZIuqr2nUfJgCZk,6200
+terminusgps/authorizenet/profiles/addresses.py,sha256=7heMIOSQtk5eHgApH-vxigDRejWDCbO3sO362IsYDXw,4673
+terminusgps/authorizenet/profiles/customers.py,sha256=x9w0gWnF2CSrzH6SVRl2TrfBNlMkA0DzI4IuYkvA84s,4360
+terminusgps/authorizenet/profiles/payments.py,sha256=G13Ag9zXGQD9joJr06F6PSeufdq7Ngml8ZqryZnjmTU,6033
 terminusgps/django/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/django/mixins.py,sha256=Q9ZJuzpk3d9lDnlVA8ZTVvnZWxB13p08EQ8yVJcztn4,1034
 terminusgps/django/settings.py,sha256=NLjcdnD_Ny_04eNNVWabUwzWvw0zS_-ebXnzhx8PJRU,691
@@ -34,7 +35,7 @@ terminusgps/wialon/items/route.py,sha256=2dEUK9o8nwutPE03W-5GUcZrjGvbwLoExVnFV9L
 terminusgps/wialon/items/unit.py,sha256=kee7dwpvjxbfDuRFzqbhKjLWjCN9iAimkjTyMilqKek,12124
 terminusgps/wialon/items/unit_group.py,sha256=HhYMZ9b7UATXeEgHkXN9r5-M_w82fabjDYADCUwBtxQ,4442
 terminusgps/wialon/items/user.py,sha256=pR6OTrm6f7Zo0J8eLvKtWVsdhGi430OxMsMMthGh8YE,5382
-python_terminusgps-40.0.0.dist-info/METADATA,sha256=7in35e5_F17RHrN1PhvklvP00FZ5z9FR0bt67AyXV88,1036
-python_terminusgps-40.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-40.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-40.0.0.dist-info/RECORD,,
+python_terminusgps-40.1.0.dist-info/METADATA,sha256=1BvaYYwi2wGVfwAmMZHfEy7ZVjNKxKYIZ-c4zk7JdjU,1036
+python_terminusgps-40.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-40.1.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-40.1.0.dist-info/RECORD,,

terminusgps/authorizenet/controllers.py

@@ -5,6 +5,29 @@ from authorizenet.apicontrollersbase import APIOperationBase
 from .auth import get_environment
 
 
+def execute_controller(controller: APIOperationBase) -> dict[str, typing.Any] | None:
+    """
+    Executes an Authorizenet API controller and returns its response.
+
+    :param controller: An Authorizenet API controller.
+    :type controller: :py:obj:`~authorizenet.apicontrollersbase.APIOperationBase`
+    :raises AuthorizenetControllerExecutionError: If the API call fails.
+    :returns: An Authorizenet API response, if any.
+    :rtype: :py:obj:`dict` | :py:obj:`None`
+
+    """
+    controller.setenvironment(get_environment())
+    controller.execute()
+    response = controller.getresponse()
+
+    if response is not None and response.messages.resultCode != "Ok":
+        raise AuthorizenetControllerExecutionError(
+            message=response.messages.message[0]["text"].text,
+            code=response.messages.message[0]["code"].text,
+        )
+    return response
+
+
 class AuthorizenetControllerExecutor:
     """Allows objects to use :py:meth:`execute_controller` to execute Authorizenet API controllers."""
 
@@ -22,16 +45,7 @@ class AuthorizenetControllerExecutor:
         :rtype: :py:obj:`dict` | :py:obj:`None`
 
         """
-        controller.setenvironment(get_environment())
-        controller.execute()
-        response = controller.getresponse()
-
-        if response is not None and response.messages.resultCode != "Ok":
-            raise AuthorizenetControllerExecutionError(
-                message=response.messages.message[0]["text"].text,
-                code=response.messages.message[0]["code"].text,
-            )
-        return response
+        return execute_controller(controller)
 
 
 class AuthorizenetControllerExecutionError(Exception):

terminusgps/authorizenet/profiles/addresses.py

@@ -1,7 +1,7 @@
 from authorizenet import apicontractsv1, apicontrollers
 
 from terminusgps.authorizenet.auth import get_merchant_auth
-from terminusgps.authorizenet.controllers import AuthorizenetControllerExecutor
+from terminusgps.authorizenet.controllers import execute_controller
 
 __all__ = [
     "create_customer_shipping_address",
@@ -35,7 +35,7 @@ def create_customer_shipping_address(
         address=new_address,
         defaultShippingAddress=str(default).lower(),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
+    return execute_controller(
         apicontrollers.createCustomerShippingAddressController(request)
     )
 
@@ -59,7 +59,7 @@ def get_customer_shipping_address(
         customerProfileId=str(customer_profile_id),
         customerAddressId=str(customer_address_profile_id),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
+    return execute_controller(
         apicontrollers.getCustomerShippingAddressController(request)
     )
 
@@ -88,7 +88,7 @@ def update_customer_shipping_address(
         address=new_address,
         defaultShippingAddress=str(default).lower(),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
+    return execute_controller(
         apicontrollers.updateCustomerShippingAddressController(request)
     )
 
@@ -112,6 +112,6 @@ def delete_customer_shipping_address(
         customerProfileId=str(customer_profile_id),
         customerAddressId=str(customer_address_profile_id),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
+    return execute_controller(
         apicontrollers.deleteCustomerShippingAddressController(request)
     )

terminusgps/authorizenet/profiles/customers.py

@@ -1,7 +1,7 @@
 from authorizenet import apicontractsv1, apicontrollers
 
 from terminusgps.authorizenet.auth import get_merchant_auth, get_validation_mode
-from terminusgps.authorizenet.controllers import AuthorizenetControllerExecutor
+from terminusgps.authorizenet.controllers import execute_controller
 
 __all__ = [
     "create_customer_profile",
@@ -33,9 +33,7 @@ def create_customer_profile(merchant_id: int | str, email: str, description: str
         ),
         validationMode=get_validation_mode(),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
-        apicontrollers.createCustomerProfileController(request)
-    )
+    return execute_controller(apicontrollers.createCustomerProfileController(request))
 
 
 def get_customer_profile(customer_profile_id: int, include_issuer_info: bool = False):
@@ -55,9 +53,7 @@ def get_customer_profile(customer_profile_id: int, include_issuer_info: bool = F
         customerProfileId=str(customer_profile_id),
         includeIssuerInfo=str(include_issuer_info).lower(),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
-        apicontrollers.getCustomerProfileController(request)
-    )
+    return execute_controller(apicontrollers.getCustomerProfileController(request))
 
 
 def get_customer_profile_ids():
@@ -71,9 +67,7 @@ def get_customer_profile_ids():
     request = apicontractsv1.getCustomerProfileIdsRequest(
         merchantAuthentication=get_merchant_auth()
     )
-    return AuthorizenetControllerExecutor.execute_controller(
-        apicontrollers.getCustomerProfileIdsController(request)
-    )
+    return execute_controller(apicontrollers.getCustomerProfileIdsController(request))
 
 
 def update_customer_profile(
@@ -94,9 +88,7 @@ def update_customer_profile(
     request = apicontractsv1.updateCustomerProfileRequest(
         merchantAuthentication=get_merchant_auth(), profile=new_profile
     )
-    return AuthorizenetControllerExecutor.execute_controller(
-        apicontrollers.updateCustomerProfileController(request)
-    )
+    return execute_controller(apicontrollers.updateCustomerProfileController(request))
 
 
 def delete_customer_profile(customer_profile_id: int):
@@ -113,6 +105,4 @@ def delete_customer_profile(customer_profile_id: int):
         merchantAuthentication=get_merchant_auth(),
         customerProfileId=str(customer_profile_id),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
-        apicontrollers.deleteCustomerProfileController(request)
-    )
+    return execute_controller(apicontrollers.deleteCustomerProfileController(request))

terminusgps/authorizenet/profiles/payments.py

@@ -1,7 +1,7 @@
 from authorizenet import apicontractsv1, apicontrollers
 
 from terminusgps.authorizenet.auth import get_merchant_auth, get_validation_mode
-from terminusgps.authorizenet.controllers import AuthorizenetControllerExecutor
+from terminusgps.authorizenet.controllers import execute_controller
 
 __all__ = [
     "create_customer_payment_profile",
@@ -33,7 +33,7 @@ def create_customer_payment_profile(
         paymentProfile=new_payment_profile,
         validationMode=get_validation_mode(),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
+    return execute_controller(
         apicontrollers.createCustomerPaymentProfileController(request)
     )
 
@@ -62,7 +62,7 @@ def get_customer_payment_profile(
         customerPaymentProfileId=str(customer_payment_profile_id),
         includeIssuerInfo=str(include_issuer_info).lower(),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
+    return execute_controller(
         apicontrollers.getCustomerPaymentProfileController(request)
     )
 
@@ -87,7 +87,7 @@ def validate_customer_payment_profile(
         customerPaymentProfileId=str(customer_payment_profile_id),
         validationMode=get_validation_mode(),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
+    return execute_controller(
         apicontrollers.validateCustomerPaymentProfileController(request)
     )
 
@@ -117,7 +117,7 @@ def update_customer_payment_profile(
         paymentProfile=new_payment_profile,
         validationMode=get_validation_mode(),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
+    return execute_controller(
         apicontrollers.updateCustomerPaymentProfileController(request)
     )
 
@@ -141,6 +141,6 @@ def delete_customer_payment_profile(
         customerProfileId=str(customer_profile_id),
         customerPaymentProfileId=str(customer_payment_profile_id),
     )
-    return AuthorizenetControllerExecutor.execute_controller(
+    return execute_controller(
         apicontrollers.deleteCustomerPaymentProfileController(request)
     )

terminusgps/authorizenet/subscriptions.py

@@ -0,0 +1,96 @@
+from authorizenet import apicontractsv1, apicontrollers
+
+from terminusgps.authorizenet.auth import get_merchant_auth
+from terminusgps.authorizenet.controllers import execute_controller
+
+
+def create_subscription(subscription_obj: apicontractsv1.ARBSubscriptionType):
+    """
+    `ARBCreateSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-create-a-subscription>`_.
+
+    :param subscription_obj: An Authorizenet subscription object.
+    :type subscription_obj: :py:obj:`~authorizenet.apicontractsv1.ARBSubscriptionType`
+    :returns: An Authorizenet ARBCreateSubscription response.
+    :rtype: :py:obj:`dict`
+
+    """
+    request = apicontractsv1.ARBCreateSubscriptionRequest(
+        merchantAuthentication=get_merchant_auth(), subscription=subscription_obj
+    )
+    return execute_controller(apicontrollers.ARBCreateSubscriptionController(request))
+
+
+def get_subscription(subscription_id: int, include_transactions: bool = True):
+    """
+    `ARBGetSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-get-subscription>`_.
+
+    :param subscription_id: An Authorizenet subscription id.
+    :type subscription_id: :py:obj:`int`
+    :param include_transactions: Whether or not to include the subscription transaction list in the response. Default is :py:obj:`True`.
+    :type include_transactions: :py:obj:`bool`
+    :returns: An Authorizenet ARBGetSubscription response.
+    :rtype: :py:obj:`dict`
+
+    """
+    request = apicontractsv1.ARBGetSubscriptionRequest(
+        merchantAuthentication=get_merchant_auth(),
+        subscriptionId=str(subscription_id),
+        includeTransactions=str(include_transactions).lower(),
+    )
+    return execute_controller(apicontrollers.ARBGetSubscriptionController(request))
+
+
+def get_subscription_status(subscription_id: int):
+    """
+    `ARBGetSubscriptionStatusRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-get-subscription-status>`_.
+
+    :param subscription_id: An Authorizenet subscription id.
+    :type subscription_id: :py:obj:`int`
+    :returns: An Authorizenet ARBGetSubscriptionStatus response.
+    :rtype: :py:obj:`dict`
+
+    """
+    request = apicontractsv1.ARBGetSubscriptionStatusRequest(
+        merchantAuthentication=get_merchant_auth(), subscriptionId=str(subscription_id)
+    )
+    return execute_controller(
+        apicontrollers.ARBGetSubscriptionStatusController(request)
+    )
+
+
+def update_subscription(
+    subscription_id: int, subscription_obj: apicontractsv1.ARBSubscriptionType
+):
+    """
+    `ARBUpdateSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-update-a-subscription>`_.
+
+    :param subscription_id: An Authorizenet subscription id.
+    :type subscription_id: :py:obj:`int`
+    :param subscription_obj: An Authorizenet subscription object.
+    :type subscription_obj: :py:obj:`~authorizenet.apicontractsv1.ARBSubscriptionType`
+    :returns: An Authorizenet ARBUpdateSubscription response.
+    :rtype: :py:obj:`dict`
+
+    """
+    request = apicontractsv1.ARBUpdateSubscriptionRequest(
+        merchantAuthentication=get_merchant_auth(),
+        subscriptionId=str(subscription_id),
+        subscription=subscription_obj,
+    )
+    return execute_controller(apicontrollers.ARBUpdateSubscriptionController(request))
+
+
+def cancel_subscription(subscription_id: int):
+    """
+    `ARBCancelSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-cancel-a-subscription>`_.
+
+    :param subscription_id: An Authorizenet subscription id.
+    :type subscription_id: :py:obj:`int`
+    :returns: An Authorizenet ARBCancelSubscription response.
+    :rtype: :py:obj:`dict`
+
+    """
+    request = apicontractsv1.ARBCancelSubscriptionRequest(
+        merchantAuthentication=get_merchant_auth(), subscriptionId=str(subscription_id)
+    )
+    return execute_controller(apicontrollers.ARBCancelSubscriptionController(request))