python-terminusgps 44.0.0__tar.gz → 45.0.0__tar.gz

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/PKG-INFO

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

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/docs/source/authorizenet/index.rst

@@ -25,9 +25,8 @@ Most `Authorizenet API endpoints <https://developer.authorize.net/api/reference/
     :maxdepth: 2
     :caption: Contents:
 
-    api.rst
     auth.rst
     constants.rst
     exceptions.rst
+    api.rst
     usage.rst
-    validators.rst

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/docs/source/conf.py

@@ -12,7 +12,7 @@ sys.path.insert(0, os.path.abspath("../../"))
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "44.0.0"
+release = "45.0.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/docs/source/index.rst

@@ -6,10 +6,12 @@
 python-terminusgps documentation
 ================================
 
-`python-terminusgps <https://pypi.org/project/python-terminusgps>`_ is a package [#f1]_ of subpackages that streamlines the use of web APIs for Terminus GPS developers.
+`python-terminusgps <https://pypi.org/project/python-terminusgps>`_ is a Python package [#f1]_ that streamlines the use of web APIs for Terminus GPS developers.
 
 `Terminus GPS <https://terminusgps.com/>`_ is an IoT software/hardware GPS monitoring company.
 
+Commonly written and repeated Python code used in Terminus GPS Django projects is accessible from the :py:mod:`terminusgps` package, e.g. :py:obj:`~terminusgps.mixins.HtmxTemplateResponseMixin` for HTMX-enabled Django views and :py:obj:`~terminusgps.validators.validate_e164_phone_number` for validating Django model/form fields.
+
 .. [#f1] In other programming languages, the term "library" is used to describe what Python calls a "package". Put simply, a "package" is a Python "library".
 
 ============

python_terminusgps-45.0.0/docs/source/wialon/constants.rst

@@ -0,0 +1,31 @@
+Constants
+=========
+
+.. currentmodule:: terminusgps.wialon.constants
+
+.. autoclass:: WialonLogAction
+    :members:
+
+.. autodata:: ACCESSMASK_RESOURCE_BASIC
+
+.. autodata:: ACCESSMASK_UNIT_BASIC
+
+.. autodata:: ACCESSMASK_UNIT_MIGRATION
+
+.. currentmodule:: terminusgps.wialon.flags
+
+.. autoclass:: AccessFlag
+    :members:
+    :member-order: bysource
+
+.. autoclass:: DataFlag
+    :members:
+    :member-order: bysource
+
+.. autoclass:: SettingsFlag
+    :members:
+    :member-order: bysource
+
+.. autoclass:: TokenFlag
+    :members:
+    :member-order: bysource

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/docs/source/wialon/index.rst

@@ -2,13 +2,14 @@ Wialon
 ======
 The :py:mod:`terminusgps.wialon` package provides a Pythonic interface for interacting with the Wialon API.
 
-Most Wialon objects are modeled as plain Python objects which have attributes and methods that make `Wialon API calls <https://help.wialon.com/en/api/user-guide/api-reference>`_.
+Most Wialon objects are modeled as plain Python classes which have methods that make `Wialon API calls <https://help.wialon.com/en/api/user-guide/api-reference>`_.
 
 .. toctree::
     :maxdepth: 2
     :caption: Contents:
 
-    items.rst
+    constants.rst
     exceptions.rst
+    items.rst
     session.rst
     usage.rst

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "44.0.0"
+version = "45.0.0"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/terminusgps/authorizenet/api/address_profiles.py

@@ -1,9 +1,7 @@
 from authorizenet import apicontractsv1, apicontrollers
+from authorizenet.apicontrollersbase import APIOperationBase
 from lxml.objectify import ObjectifiedElement
 
-from terminusgps.authorizenet.auth import get_merchant_auth
-from terminusgps.authorizenet.controllers import execute_controller
-
 __all__ = [
     "create_customer_shipping_address",
     "get_customer_shipping_address",
@@ -16,7 +14,7 @@ def create_customer_shipping_address(
     customer_profile_id: int,
     address: apicontractsv1.customerAddressType,
     default: bool = False,
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `createCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-shipping-address>`_.
 
@@ -24,26 +22,22 @@ def create_customer_shipping_address(
     :type customer_profile_id: int
     :param address: An Authorizenet customer address element.
     :type address: ~authorizenet.apicontractsv1.customerAddressType
-    :param default: Whether to set the address profile as default. Default is False.
+    :param default: Whether to set the address profile as default. Default is :py:obj:`False`.
     :type default: bool
-    :returns: An Authorizenet createCustomerShippingAddressResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.createCustomerShippingAddressRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.address = address
     request.defaultShippingAddress = str(default).lower()
-
-    return execute_controller(
-        apicontrollers.createCustomerShippingAddressController(request)
-    )
+    return request, apicontrollers.createCustomerShippingAddressController
 
 
 def get_customer_shipping_address(
     customer_profile_id: int, address_profile_id: int
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `getCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-shipping-address>`_.
 
@@ -51,25 +45,21 @@ def get_customer_shipping_address(
     :type customer_profile_id: int
     :param address_profile_id: An Authorizenet customer address profile id.
     :type address_profile_id: int
-    :returns: An Authorizenet getCustomerShippingAddressResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.getCustomerShippingAddressRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.customerAddressId = str(address_profile_id)
-
-    return execute_controller(
-        apicontrollers.getCustomerShippingAddressController(request)
-    )
+    return request, apicontrollers.getCustomerShippingAddressController
 
 
 def update_customer_shipping_address(
     customer_profile_id: int,
     address: apicontractsv1.customerAddressType,
     default: bool = False,
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `updateCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-shipping-address>`_.
 
@@ -77,26 +67,22 @@ def update_customer_shipping_address(
     :type customer_profile_id: int
     :param address: An Authorizenet customer address element.
     :type address: ~authorizenet.apicontractsv1.customerAddressType
-    :param default: Whether to set the address profile as default. Default is False.
+    :param default: Whether to set the address profile as default. Default is :py:obj:`False`.
     :type default: bool
-    :returns: An Authorizenet updateCustomerShippingAddressResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.updateCustomerShippingAddressRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.address = address
     request.defaultShippingAddress = str(default).lower()
-
-    return execute_controller(
-        apicontrollers.updateCustomerShippingAddressController(request)
-    )
+    return request, apicontrollers.updateCustomerShippingAddressController
 
 
 def delete_customer_shipping_address(
     customer_profile_id: int, address_profile_id: int
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `deleteCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-shipping-address>`_.
 
@@ -104,15 +90,11 @@ def delete_customer_shipping_address(
     :type customer_profile_id: int
     :param address_profile_id: An Authorizenet customer address profile id.
     :type address_profile_id: int
-    :returns: An Authorizenet deleteCustomerShippingAddressResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.deleteCustomerShippingAddressRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.customerAddressId = str(address_profile_id)
-
-    return execute_controller(
-        apicontrollers.deleteCustomerShippingAddressController(request)
-    )
+    return request, apicontrollers.deleteCustomerShippingAddressController

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/terminusgps/authorizenet/api/customer_profiles.py

@@ -1,9 +1,7 @@
 from authorizenet import apicontractsv1, apicontrollers
+from authorizenet.apicontrollersbase import APIOperationBase
 from lxml.objectify import ObjectifiedElement
 
-from terminusgps.authorizenet.auth import get_merchant_auth
-from terminusgps.authorizenet.controllers import execute_controller
-
 __all__ = [
     "create_customer_profile",
     "get_customer_profile",
@@ -15,7 +13,7 @@ __all__ = [
 
 def create_customer_profile(
     merchant_id: str, email: str, description: str = ""
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `createCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile>`_.
 
@@ -25,99 +23,81 @@ def create_customer_profile(
     :type email: str
     :param description: An optional customer description.
     :type description: str
-    :returns: An Authorizenet createCustomerProfileResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.createCustomerProfileRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.profile = apicontractsv1.customerProfileType()
     request.profile.merchantCustomerId = merchant_id
     request.profile.description = description
     request.profile.email = email
-
-    return execute_controller(
-        apicontrollers.createCustomerProfileController(request)
-    )
+    return request, apicontrollers.createCustomerProfileController
 
 
 def get_customer_profile(
     customer_profile_id: int, include_issuer_info: bool = False
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_.
 
-    :param customer_profile_id: An Authorizenet customer profile id.
+    :param customer_profile_id: Authorizenet customer profile id.
     :type customer_profile_id: int
-    :param include_issuer_info: Whether to include issuer info in the response. Default is False.
+    :param include_issuer_info: Whether to include issuer info in the response. Default is :py:obj:`False`.
     :type include_issuer_info: bool
-    :returns: An Authorizenet getCustomerProfileResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.getCustomerProfileRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.includeIssuerInfo = str(include_issuer_info).lower()
-
-    return execute_controller(
-        apicontrollers.getCustomerProfileController(request)
-    )
+    return request, apicontrollers.getCustomerProfileController
 
 
-def get_customer_profile_ids() -> ObjectifiedElement | None:
+def get_customer_profile_ids() -> tuple[
+    ObjectifiedElement, type[APIOperationBase]
+]:
     """
     `getCustomerProfileIdsRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile-ids>`_.
 
-    :returns: An Authorizenet getCustomerProfileIdsResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.getCustomerProfileIdsRequest()
-    request.merchantAuthentication = get_merchant_auth()
-
-    return execute_controller(
-        apicontrollers.getCustomerProfileIdsController(request)
-    )
+    return request, apicontrollers.getCustomerProfileIdsController
 
 
 def update_customer_profile(
     profile: apicontractsv1.customerProfileExType,
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `updateCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-profile>`_.
 
     :param profile: An Authorizenet customer profile ex element.
     :type profile: ~authorizenet.apicontractsv1.customerProfileExType
-    :returns: An Authorizenet updateCustomerProfileResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.updateCustomerProfileRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.profile = profile
-
-    return execute_controller(
-        apicontrollers.updateCustomerProfileController(request)
-    )
+    return request, apicontrollers.updateCustomerProfileController
 
 
 def delete_customer_profile(
     customer_profile_id: int,
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `deleteCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-profile>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: int
-    :returns: An Authorizenet deleteCustomerProfileResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.deleteCustomerProfileRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
-
-    return execute_controller(
-        apicontrollers.deleteCustomerProfileController(request)
-    )
+    return request, apicontrollers.deleteCustomerProfileController

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/terminusgps/authorizenet/api/payment_profiles.py

@@ -1,11 +1,8 @@
 from authorizenet import apicontractsv1, apicontrollers
+from authorizenet.apicontrollersbase import APIOperationBase
 from lxml.objectify import ObjectifiedElement
 
-from terminusgps.authorizenet.auth import (
-    get_merchant_auth,
-    get_validation_mode,
-)
-from terminusgps.authorizenet.controllers import execute_controller
+from terminusgps.authorizenet.auth import get_validation_mode
 
 __all__ = [
     "create_customer_payment_profile",
@@ -20,7 +17,7 @@ def create_customer_payment_profile(
     customer_profile_id: int,
     payment_profile: apicontractsv1.customerPaymentProfileType,
     validate: bool = True,
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `createCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-payment-profile>`_.
 
@@ -29,27 +26,23 @@ def create_customer_payment_profile(
     :param payment_profile: An Authorizenet payment profile element.
     :type payment_profile: ~authorizenet.apicontractsv1.customerPaymentProfileType
     :param validate: Whether to validate the payment profile. Default is True.
-    :returns: An Authorizenet createCustomerPaymentProfileResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.createCustomerPaymentProfileRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.paymentProfile = payment_profile
     if validate:
         request.validationMode = get_validation_mode()
-
-    return execute_controller(
-        apicontrollers.createCustomerPaymentProfileController(request)
-    )
+    return request, apicontrollers.createCustomerPaymentProfileController
 
 
 def get_customer_payment_profile(
     customer_profile_id: int,
     payment_profile_id: int,
     include_issuer_info: bool = False,
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `getCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile>`_.
 
@@ -59,24 +52,20 @@ def get_customer_payment_profile(
     :type payment_profile_id: int
     :param include_issuer_info: Whether to include issuer info in the response. Default is False.
     :type include_issuer_info: bool
-    :returns: An Authorizenet getCustomerPaymentProfileResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.getCustomerPaymentProfileRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.customerPaymentProfileId = str(payment_profile_id)
     request.includeIssuerInfo = str(include_issuer_info).lower()
-
-    return execute_controller(
-        apicontrollers.getCustomerPaymentProfileController(request)
-    )
+    return request, apicontrollers.getCustomerPaymentProfileController
 
 
 def validate_customer_payment_profile(
     customer_profile_id: int, payment_profile_id: int
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `validateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-validate-customer-payment-profile>`_.
 
@@ -84,19 +73,15 @@ def validate_customer_payment_profile(
     :type customer_profile_id: int
     :param payment_profile_id: An Authorizenet customer payment profile id.
     :type payment_profile_id: int
-    :returns: An Authorizenet validateCustomerPaymentProfileResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.validateCustomerPaymentProfileRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.customerPaymentProfileId = str(payment_profile_id)
     request.validationMode = get_validation_mode()
-
-    return execute_controller(
-        apicontrollers.validateCustomerPaymentProfileController(request)
-    )
+    return request, apicontrollers.validateCustomerPaymentProfileController
 
 
 def update_customer_payment_profile(
@@ -104,7 +89,7 @@ def update_customer_payment_profile(
     payment_profile_id: int,
     payment_profile: apicontractsv1.customerPaymentProfileType,
     validate: bool = True,
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `updateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-payment-profile>`_.
 
@@ -116,28 +101,24 @@ def update_customer_payment_profile(
     :type payment_profile: ~authorizenet.apicontractsv1.customerPaymentProfileType
     :param validate: Whether to validate the payment profile. Default is True.
     :type validate: bool
-    :returns: An Authorizenet updateCustomerPaymentProfileResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     if not hasattr(payment_profile, "customerPaymentProfileId"):
         payment_profile.customerPaymentProfileId = str(payment_profile_id)
 
     request = apicontractsv1.updateCustomerPaymentProfileRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.paymentProfile = payment_profile
     if validate:
         request.validationMode = get_validation_mode()
-
-    return execute_controller(
-        apicontrollers.updateCustomerPaymentProfileController(request)
-    )
+    return request, apicontrollers.updateCustomerPaymentProfileController
 
 
 def delete_customer_payment_profile(
     customer_profile_id: int, payment_profile_id: int
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `deleteCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-payment-profile>`_.
 
@@ -145,15 +126,11 @@ def delete_customer_payment_profile(
     :type customer_profile_id: int
     :param payment_profile_id: An Authorizenet customer payment profile id.
     :type payment_profile_id: int
-    :returns: An Authorizenet deleteCustomerPaymentProfileResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.deleteCustomerPaymentProfileRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.customerProfileId = str(customer_profile_id)
     request.customerPaymentProfileId = str(payment_profile_id)
-
-    return execute_controller(
-        apicontrollers.deleteCustomerPaymentProfileController(request)
-    )
+    return request, apicontrollers.deleteCustomerPaymentProfileController

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/terminusgps/authorizenet/api/subscriptions.py

@@ -1,9 +1,7 @@
 from authorizenet import apicontractsv1, apicontrollers
+from authorizenet.apicontrollersbase import APIOperationBase
 from lxml.objectify import ObjectifiedElement
 
-from terminusgps.authorizenet.auth import get_merchant_auth
-from terminusgps.authorizenet.controllers import execute_controller
-
 __all__ = [
     "create_subscription",
     "get_subscription",
@@ -15,28 +13,24 @@ __all__ = [
 
 def create_subscription(
     subscription: apicontractsv1.ARBSubscriptionType,
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `ARBCreateSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-create-a-subscription>`_.
 
     :param subscription: An Authorizenet ARBSubscriptionType element.
     :type subscription: ~authorizenet.apicontractsv1.ARBSubscriptionType
-    :returns: An Authorizenet ARBCreateSubscriptionResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.ARBCreateSubscriptionRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.subscription = subscription
-
-    return execute_controller(
-        apicontrollers.ARBCreateSubscriptionController(request)
-    )
+    return request, apicontrollers.ARBCreateSubscriptionController
 
 
 def get_subscription(
     subscription_id: int, include_transactions: bool = True
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `ARBGetSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-get-subscription>`_.
 
@@ -44,42 +38,36 @@ def get_subscription(
     :type subscription_id: int
     :param include_transactions: Whether to include the subscription transaction list in the response. Default is True.
     :type include_transactions: bool
-    :returns: An Authorizenet ARBGetSubscriptionResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.ARBGetSubscriptionRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.subscriptionId = str(subscription_id)
     request.includeTransactions = str(include_transactions).lower()
-
-    return execute_controller(
-        apicontrollers.ARBGetSubscriptionController(request)
-    )
+    return request, apicontrollers.ARBGetSubscriptionController
 
 
-def get_subscription_status(subscription_id: int) -> ObjectifiedElement | None:
+def get_subscription_status(
+    subscription_id: int,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `ARBGetSubscriptionStatusRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-get-subscription-status>`_.
 
     :param subscription_id: An Authorizenet subscription id.
     :type subscription_id: int
-    :returns: An Authorizenet ARBGetSubscriptionStatusResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.ARBGetSubscriptionStatusRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.subscriptionId = str(subscription_id)
-
-    return execute_controller(
-        apicontrollers.ARBGetSubscriptionStatusController(request)
-    )
+    return request, apicontrollers.ARBGetSubscriptionStatusController
 
 
 def update_subscription(
     subscription_id: int, subscription: apicontractsv1.ARBSubscriptionType
-) -> ObjectifiedElement | None:
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `ARBUpdateSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-update-a-subscription>`_.
 
@@ -87,34 +75,28 @@ def update_subscription(
     :type subscription_id: int
     :param subscription: An Authorizenet ARBSubscriptionType element.
     :type subscription: ~authorizenet.apicontractsv1.ARBSubscriptionType
-    :returns: An Authorizenet ARBUpdateSubscriptionResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.ARBUpdateSubscriptionRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.subscriptionId = str(subscription_id)
     request.subscription = subscription
-
-    return execute_controller(
-        apicontrollers.ARBUpdateSubscriptionController(request)
-    )
+    return request, apicontrollers.ARBUpdateSubscriptionController
 
 
-def cancel_subscription(subscription_id: int) -> ObjectifiedElement | None:
+def cancel_subscription(
+    subscription_id: int,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
     """
     `ARBCancelSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-cancel-a-subscription>`_.
 
     :param subscription_id: An Authorizenet subscription id.
     :type subscription_id: int
-    :returns: An Authorizenet ARBCancelSubscriptionResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
 
     """
     request = apicontractsv1.ARBCancelSubscriptionRequest()
-    request.merchantAuthentication = get_merchant_auth()
     request.subscriptionId = str(subscription_id)
-
-    return execute_controller(
-        apicontrollers.ARBCancelSubscriptionController(request)
-    )
+    return request, apicontrollers.ARBCancelSubscriptionController

python_terminusgps-45.0.0/terminusgps/authorizenet/api/transactions.py

@@ -0,0 +1,2 @@
+# TODO
+__all__ = []

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/terminusgps/authorizenet/controllers.py

@@ -1,7 +1,7 @@
 from authorizenet.apicontrollersbase import APIOperationBase
 from lxml.objectify import ObjectifiedElement
 
-from .auth import get_environment
+from .auth import get_environment, get_merchant_auth
 
 
 def execute_controller(
@@ -18,9 +18,10 @@ def execute_controller(
 
     """
     controller.setenvironment(get_environment())
+    controller.setmerchantauthentication(get_merchant_auth())
     controller.execute()
-    response = controller.getresponse()
 
+    response = controller.getresponse()
     if response is not None and response.messages.resultCode != "Ok":
         raise AuthorizenetControllerExecutionError(
             message=response.messages.message[0]["text"].text,

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/terminusgps/validators.py

@@ -8,7 +8,30 @@ VALID_COUNTRY_CODES = ("+1", "+52")
 
 
 def validate_e164_phone_number(value: str) -> None:
-    """Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is not a valid `E.164 <https://en.wikipedia.org/wiki/E.164>`_ formatted phone number."""
+    """
+    Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is not a valid `E.164 <https://en.wikipedia.org/wiki/E.164>`_ formatted phone number.
+
+    * Country Code: A 2-5 character code with a leading '+' indicating the phone number's destination country.
+    * Area Code: The first 3 digits of the phone number.
+    * Subscriber Number: The last 7 digits of the phone number.
+
+    :param value: A phone number in `E.164 <https://en.wikipedia.org/wiki/E.164>`_ format.
+    :type value: str
+    :raises ~django.core.exceptions.ValidationError: If the phone number wasn't provided.
+    :raises ~django.core.exceptions.ValidationError: If the phone number didn't start with a '+' character.
+    :raises ~django.core.exceptions.ValidationError: If the phone number contained any number of spaces.
+    :raises ~django.core.exceptions.ValidationError: If the phone number contained any number of hyphens.
+    :raises ~django.core.exceptions.ValidationError: If the phone number was less than 12 characters in length.
+    :raises ~django.core.exceptions.ValidationError: If the phone number was greater than 15 characters in length.
+    :raises ~django.core.exceptions.ValidationError: If the country code was invalid.
+    :raises ~django.core.exceptions.ValidationError: If the area code wasn't exactly 3 characters in length.
+    :raises ~django.core.exceptions.ValidationError: If the area code wasn't a digit.
+    :raises ~django.core.exceptions.ValidationError: If the subscriber number (non-area code number) wasn't exactly 7 characters in length.
+    :raises ~django.core.exceptions.ValidationError: If the subscriber number (non-area code number) wasn't a digit.
+    :returns: Nothing.
+    :rtype: None
+
+    """
     if not value:
         raise ValidationError(
             _("This field is required, got '%(value)s'"),
@@ -110,10 +133,10 @@ def validate_credit_card_number(value: str) -> None:
 
     Uses the `Luhn algorithm <https://en.wikipedia.org/wiki/Luhn_algorithm>`_ to validate the credit card number.
 
-    :param value: A credit card number string.
+    :param value: A credit card number.
     :type value: str
-    :raises ValidationError: If the value contains non-digit characters.
-    :raises ValidationError: If the value fails the Luhn algorithm.
+    :raises ~django.core.exceptions.ValidationError: If the credit card number contained non-digit characters.
+    :raises ~django.core.exceptions.ValidationError: If the credit card number failed the Luhn algorithm check.
     :returns: Nothing.
     :rtype: None
 
@@ -146,11 +169,11 @@ def validate_credit_card_expiry_month(value: str) -> None:
     """
     Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is an invalid credit card expiration date month.
 
-    :param value: A credit card expiration year string.
+    :param value: A credit card expiration month.
     :type value: str
-    :raises ValidationError: If the value contains non-digit characters.
-    :raises ValidationError: If the value is negative.
-    :raises ValidationError: If the value isn't between 1-12.
+    :raises ~django.core.exceptions.ValidationError: If the expiration month contained non-digit characters.
+    :raises ~django.core.exceptions.ValidationError: If the expiration month was negative.
+    :raises ~django.core.exceptions.ValidationError: If the expiration month was an invalid (non-existent) month.
     :returns: Nothing.
     :rtype: None
 
@@ -184,11 +207,11 @@ def validate_credit_card_expiry_year(value: str) -> None:
     """
     Raises :py:exc:`~django.core.exceptions.ValidationError` if the value is an invalid credit card expiration date year.
 
-    :param value: A credit card expiration year string.
+    :param value: A credit card expiration year.
     :type value: str
-    :raises ValidationError: If the value contains non-digit characters.
-    :raises ValidationError: If the value is negative.
-    :raises ValidationError: If the value is a year in the past.
+    :raises ~django.core.exceptions.ValidationError: If the expiration year contained non-digit characters.
+    :raises ~django.core.exceptions.ValidationError: If the expiration year was negative.
+    :raises ~django.core.exceptions.ValidationError: If the expiration year was a year in the past.
     :returns: Nothing.
     :rtype: None
 

{python_terminusgps-44.0.0 → python_terminusgps-45.0.0}/uv.lock

@@ -298,7 +298,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "44.0.0"
+version = "45.0.0"
 source = { editable = "." }
 dependencies = [
     { name = "authorizenet" },

python_terminusgps-44.0.0/docs/source/authorizenet/validators.rst

@@ -1,31 +0,0 @@
-Validators
-==========
-
-.. automodule:: terminusgps.authorizenet.validators
-   :members:
-
-=====
-Usage
-=====
-
-.. code:: python
-
-    from django import forms
-
-    from terminusgps.authorizenet.validators import (
-        validate_credit_card_number,
-        validate_credit_card_expiry_month,
-        validate_credit_card_expiry_year,
-    )
-
-    class CreditCardForm(forms.Form):
-        # Adding the validators to a form field renders error messages properly
-        cc_number = forms.CharField(
-            max_length=17, validators=[validate_credit_card_number]
-        )
-        cc_expiry_month = forms.CharField(
-            max_length=2, validators=[validate_credit_card_expiry_month]
-        )
-        cc_expiry_year = forms.CharField(
-            max_length=2, validators=[validate_credit_card_expiry_year]
-        )

python_terminusgps-44.0.0/terminusgps/authorizenet/api/transactions.py

@@ -1,79 +0,0 @@
-import datetime
-
-from authorizenet import apicontractsv1, apicontrollers
-from lxml.objectify import ObjectifiedElement
-
-from terminusgps.authorizenet.auth import get_merchant_auth
-from terminusgps.authorizenet.controllers import execute_controller
-
-__all__ = []
-
-
-def get_settled_batch_list(
-    start: datetime.datetime,
-    end: datetime.datetime,
-    include_statistics: bool = False,
-) -> ObjectifiedElement | None:
-    """
-    `getSettledBatchListRequest <https://developer.authorize.net/api/reference/index.html#transaction-reporting-get-settled-batch-list>`_.
-
-    :param start: First settlement date.
-    :type start: ~datetime.datetime
-    :param end: Last settlement date.
-    :type end: ~datetime.datetime
-    :returns: An Authorizenet getSettledBatchListResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
-
-    """
-    request = apicontractsv1.getSettledBatchListRequest()
-    request.merchantAuthentication = get_merchant_auth()
-    request.includeStatistics = str(include_statistics).lower()
-    request.firstSettlementDate = start
-    request.lastSettlementDate = end
-
-    return execute_controller(
-        apicontrollers.getSettledBatchListController(request)
-    )
-
-
-def get_transaction_list(
-    batch_id: int,
-    ordering: str = "submitTimeUTC",
-    descending: bool = False,
-    limit: int = 1000,
-    offset: int = 0,
-) -> ObjectifiedElement | None:
-    """
-    `getTransactionListRequest <https://developer.authorize.net/api/reference/index.html#transaction-reporting-get-transaction-list>`_.
-
-    :param batch_id: An Authorizenet transaction batch id.
-    :type batch_id int
-    :param ordering: An Authorizenet transaction list ordering string. Default is "submitTimeUTC".
-    :type ordering: str
-    :param descending: Whether to sort the transaction list in descending order. Default is False (ascending order).
-    :type descending: bool
-    :param limit: Total number of transactions to return in the list.
-    :type limit: int
-    :param offset: Page number to return results from.
-    :type offset: int
-    :returns: An Authorizenet getTransactionListResponse element.
-    :rtype: ~lxml.objectify.ObjectifiedElement | None
-
-    """
-    sorting = apicontractsv1.TransactionListSorting()
-    sorting.orderBy = ordering
-    sorting.orderDescending = str(descending).lower()
-
-    paging = apicontractsv1.Paging()
-    paging.limit = str(limit)
-    paging.offset = str(offset)
-
-    request = apicontractsv1.getTransactionListRequest()
-    request.merchantAuthentication = get_merchant_auth()
-    request.batchId = str(batch_id)
-    request.sorting = sorting
-    request.paging = paging
-
-    return execute_controller(
-        apicontrollers.getTransactionListController(request)
-    )