python-terminusgps 42.2.3__py3-none-any.whl → 43.0.0__py3-none-any.whl

{python_terminusgps-42.2.3.dist-info → python_terminusgps-43.0.0.dist-info}/METADATA

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

@@ -1,20 +1,20 @@
 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=L4j4TGDUTuSSf4bGzFOsG6HBYpqf974osWYCPc51PN8,2752
-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=7heMIOSQtk5eHgApH-vxigDRejWDCbO3sO362IsYDXw,4673
-terminusgps/authorizenet/profiles/customers.py,sha256=4MUgDgZak9vxCxcGMQaVyGUPyciC4Oa8Uo-zh3fgn3U,4298
-terminusgps/authorizenet/profiles/payments.py,sha256=G13Ag9zXGQD9joJr06F6PSeufdq7Ngml8ZqryZnjmTU,6033
+terminusgps/authorizenet/constants.py,sha256=MHAij1DKLJNUFOAbtb1_pKHrfXU2T7L6d0_zM5P15Gw,489
+terminusgps/authorizenet/controllers.py,sha256=oEomwVPu6uT2z5BGKKm-zLWXhODvBajUQ4GxDOHTecQ,2011
+terminusgps/authorizenet/validators.py,sha256=Wq4rqEuqG3JzOO7O1wM6oQ0FciNxxOK0HnJqTuLa8CY,3916
+terminusgps/authorizenet/api/__init__.py,sha256=VXR4Yco1yz5R-R7vgaH2zTP9VFqzfvvGy_XJVjyb3i0,154
+terminusgps/authorizenet/api/address_profiles.py,sha256=yl8aX2Csnlpmk5g0z0Xd2YyqHVuvduCBD_4HU42mFKk,4976
+terminusgps/authorizenet/api/customer_profiles.py,sha256=vWIZS4Z4uKRmi6IDpOoM8PCjGrQFw2lvDjG7UJwQ_3s,4654
+terminusgps/authorizenet/api/payment_profiles.py,sha256=1SmEZtyLxJ5kTZDyBE8gVfC2LVpHWgGabklfqtMQOzE,6681
+terminusgps/authorizenet/api/subscriptions.py,sha256=jMNeLNWJzg38Y4E80Q6E573qPPQMnObIJaQvNw5lgMI,4667
+terminusgps/authorizenet/api/transactions.py,sha256=Hl-MSw9ZjZJKTOJpV1S503h_ZnRzu3ltPg6DMaTF2X0,2848
 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
 terminusgps/django/utils.py,sha256=SYDQyHA5tTuVwdpZGsCtf0LpTTD0ilRKoxa8StfSTpQ,156
-terminusgps/django/validators.py,sha256=rfG2y1es_XjAYYXSWPMRMWasmqssTRUym2kwtZeCGkM,3523
+terminusgps/django/validators.py,sha256=chuJ4I1DBQ_H5dwb6CXPEIyv_CUuEzJzRUSijfss1vc,3510
 terminusgps/django/forms/__init__.py,sha256=hh8Z9AC_u2m2bu3h6sdmPyndfQneCEVovENPHmoTDC0,21
 terminusgps/django/forms/fields.py,sha256=BfuPzOZyGvWsEzONW2h4i01fhoL0IS0-gDdBKW4jHgI,2225
 terminusgps/django/forms/forms.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -36,7 +36,7 @@ terminusgps/wialon/items/route.py,sha256=xixlex6bUeFHXucVQdbfQUSLxI1Rhwk6slhoFP2
 terminusgps/wialon/items/unit.py,sha256=kIjnMOjjI3siCaA6wXojzEK2xqFIm5mN4xNqzKDUa1Q,5473
 terminusgps/wialon/items/unit_group.py,sha256=L7-PAVCj8Bf50fa04Ials4VHg8LOWkw6hwNhtSyMksE,2133
 terminusgps/wialon/items/user.py,sha256=hZlFeXCgOAdivl_Anjp_We6Cy5U8IxWNDAgm5MFZfp0,5194
-python_terminusgps-42.2.3.dist-info/METADATA,sha256=hnluxbKIliArWCAavQzIaNkR4hXlkM6G-x89Tsd19As,976
-python_terminusgps-42.2.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-42.2.3.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-42.2.3.dist-info/RECORD,,
+python_terminusgps-43.0.0.dist-info/METADATA,sha256=Xi5V8Ce3y79r2JjscFcL2v9WS59UJbqdzPE9pRub0IY,976
+python_terminusgps-43.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-43.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-43.0.0.dist-info/RECORD,,

terminusgps/authorizenet/api/__init__.py

@@ -0,0 +1,5 @@
+from .address_profiles import *
+from .customer_profiles import *
+from .payment_profiles import *
+from .subscriptions import *
+from .transactions import *

terminusgps/authorizenet/{profiles/addresses.py → api/address_profiles.py}

@@ -1,64 +1,65 @@
 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__ = [
     "create_customer_shipping_address",
-    "delete_customer_shipping_address",
     "get_customer_shipping_address",
     "update_customer_shipping_address",
+    "delete_customer_shipping_address",
 ]
 
 
 def create_customer_shipping_address(
     customer_profile_id: int,
-    new_address: apicontractsv1.customerAddressType,
+    address: apicontractsv1.customerAddressType,
     default: bool = True,
-):
+) -> ObjectifiedElement | None:
     """
     `createCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-shipping-address>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: :py:obj:`int`
-    :param new_address: An Authorizenet customer address object.
-    :type new_address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+    :param elem: An Authorizenet customer address element.
+    :type elem: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
     :param default: Whether or not to mark the new shipping address as default. Default is :py:obj:`True`.
     :type default: :py:obj:`bool`
     :returns: An Authorizenet createCustomerShippingAddress response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    request = apicontractsv1.createCustomerShippingAddressRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        address=new_address,
-        defaultShippingAddress=str(default).lower(),
-    )
+    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)
     )
 
 
 def get_customer_shipping_address(
-    customer_profile_id: int, customer_address_profile_id: int
-):
+    customer_profile_id: int, address_profile_id: int
+) -> ObjectifiedElement | None:
     """
     `getCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-shipping-address>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: :py:obj:`int`
-    :param customer_address_profile_id: An Authorizenet customer address profile id.
-    :type customer_address_profile_id: :py:obj:`int`
+    :param address_profile_id: An Authorizenet customer address profile id.
+    :type address_profile_id: :py:obj:`int`
     :returns: An Authorizenet getCustomerShippingAddress response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    request = apicontractsv1.getCustomerShippingAddressRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        customerAddressId=str(customer_address_profile_id),
-    )
+    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)
     )
@@ -66,52 +67,52 @@ def get_customer_shipping_address(
 
 def update_customer_shipping_address(
     customer_profile_id: int,
-    new_address: apicontractsv1.customerAddressType,
+    address: apicontractsv1.customerAddressType,
     default: bool = False,
-):
+) -> ObjectifiedElement | None:
     """
     `updateCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-shipping-address>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: :py:obj:`int`
-    :param new_address: An Authorizenet customer address object.
-    :type new_address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+    :param address: An Authorizenet customer address element.
+    :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
     :param default: Whether or not to mark the new shipping address as default. Default is :py:obj:`False`.
     :type default: :py:obj:`bool`
     :returns: An Authorizenet updateCustomerShippingAddress response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    request = apicontractsv1.updateCustomerShippingAddressRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        address=new_address,
-        defaultShippingAddress=str(default).lower(),
-    )
+    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)
     )
 
 
 def delete_customer_shipping_address(
-    customer_profile_id: int, customer_address_profile_id: int
-):
+    customer_profile_id: int, address_profile_id: int
+) -> ObjectifiedElement | None:
     """
     `deleteCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-shipping-address>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: :py:obj:`int`
-    :param customer_address_profile_id: An Authorizenet customer address profile id.
-    :type customer_address_profile_id: :py:obj:`int`
-    :returns: An Authorizenet deleteCustomerShippingAddress response.
-    :rtype: :py:obj:`dict`
+    :param address_profile_id: An Authorizenet customer address profile id.
+    :type address_profile_id: :py:obj:`int`
+    :returns: An Authorizenet deleteCustomerShippingAddressResponse element.
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    request = apicontractsv1.deleteCustomerShippingAddressRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        customerAddressId=str(customer_address_profile_id),
-    )
+    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)
     )

terminusgps/authorizenet/api/customer_profiles.py

@@ -0,0 +1,123 @@
+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__ = [
+    "create_customer_profile",
+    "get_customer_profile",
+    "get_customer_profile_ids",
+    "update_customer_profile",
+    "delete_customer_profile",
+]
+
+
+def create_customer_profile(
+    merchant_id: str, email: str, description: str = ""
+) -> ObjectifiedElement | None:
+    """
+    `createCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile>`_.
+
+    :param merchant_id: A merchant designated customer id.
+    :type merchant_id: :py:obj:`str`
+    :param email: A customer email address.
+    :type email: :py:obj:`str`
+    :param description: An optional customer description.
+    :type description: :py:obj:`str`
+    :returns: An Authorizenet createCustomerProfile response.
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
+
+    """
+    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)
+    )
+
+
+def get_customer_profile(
+    customer_profile_id: int, include_issuer_info: bool = False
+) -> ObjectifiedElement | None:
+    """
+    `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_.
+
+    :param customer_profile_id: An Authorizenet customer profile id.
+    :type customer_profile_id: :py:obj:`int`
+    :param include_issuer_info: Whether or not to include issuer info in the response. Default is :py:obj:`False`.
+    :type include_issuer_info: :py:obj:`bool`
+    :returns: An Authorizenet getCustomerProfile response.
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
+
+    """
+    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)
+    )
+
+
+def get_customer_profile_ids() -> ObjectifiedElement | None:
+    """
+    `getCustomerProfileIdsRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile-ids>`_.
+
+    :returns: An Authorizenet getCustomerProfileIds response.
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
+
+    """
+    request = apicontractsv1.getCustomerProfileIdsRequest()
+    request.merchantAuthentication = get_merchant_auth()
+
+    return execute_controller(
+        apicontrollers.getCustomerProfileIdsController(request)
+    )
+
+
+def update_customer_profile(
+    profile: apicontractsv1.customerProfileExType,
+) -> ObjectifiedElement | None:
+    """
+    `updateCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-profile>`_.
+
+    :param profile: An Authorizenet customer profile ex element.
+    :type profile: :py:obj:`~authorizenet.apicontractsv1.customerProfileExType`
+    :returns: An Authorizenet updateCustomerProfile response.
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
+
+    """
+    request = apicontractsv1.updateCustomerProfileRequest()
+    request.merchantAuthentication = get_merchant_auth()
+    request.profile = profile
+
+    return execute_controller(
+        apicontrollers.updateCustomerProfileController(request)
+    )
+
+
+def delete_customer_profile(
+    customer_profile_id: int,
+) -> ObjectifiedElement | None:
+    """
+    `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: :py:obj:`int`
+    :returns: An Authorizenet deleteCustomerProfile response.
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
+
+    """
+    request = apicontractsv1.deleteCustomerProfileRequest()
+    request.merchantAuthentication = get_merchant_auth()
+    request.customerProfileId = str(customer_profile_id)
+
+    return execute_controller(
+        apicontrollers.deleteCustomerProfileController(request)
+    )

terminusgps/authorizenet/{profiles/payments.py → api/payment_profiles.py}

@@ -1,38 +1,44 @@
 from authorizenet import apicontractsv1, apicontrollers
+from lxml.objectify import ObjectifiedElement
 
-from terminusgps.authorizenet.auth import get_merchant_auth, get_validation_mode
+from terminusgps.authorizenet.auth import (
+    get_merchant_auth,
+    get_validation_mode,
+)
 from terminusgps.authorizenet.controllers import execute_controller
 
 __all__ = [
     "create_customer_payment_profile",
-    "delete_customer_payment_profile",
     "get_customer_payment_profile",
-    "update_customer_payment_profile",
     "validate_customer_payment_profile",
+    "update_customer_payment_profile",
+    "delete_customer_payment_profile",
 ]
 
 
 def create_customer_payment_profile(
     customer_profile_id: int,
-    new_payment_profile: apicontractsv1.customerPaymentProfileType,
-):
+    payment_profile: apicontractsv1.customerPaymentProfileType,
+    validate: bool = False,
+) -> ObjectifiedElement | None:
     """
     `createCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-payment-profile>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: :py:obj:`int`
-    :param new_payment_profile: An Authorizenet payment profile object.
-    :type new_payment_profile: :py:obj:`~authorizenet.apicontractsv1.customerPaymentProfileType`
+    :param payment_profile: An Authorizenet payment profile element.
+    :type payment_profile: :py:obj:`~authorizenet.apicontractsv1.customerPaymentProfileType`
     :returns: An Authorizenet createCustomerPaymentProfile response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    request = apicontractsv1.createCustomerPaymentProfileRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        paymentProfile=new_payment_profile,
-        validationMode=get_validation_mode(),
-    )
+    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)
     )
@@ -40,36 +46,36 @@ def create_customer_payment_profile(
 
 def get_customer_payment_profile(
     customer_profile_id: int,
-    customer_payment_profile_id: int,
+    payment_profile_id: int,
     include_issuer_info: bool = False,
-):
+) -> ObjectifiedElement | None:
     """
     `getCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: :py:obj:`int`
-    :param customer_payment_profile_id: An Authorizenet customer payment profile id.
-    :type customer_payment_profile_id: :py:obj:`int`
-    :param include_issuer_info: Whether or not to include issuer info in the response. Default is :py:obj:`False`.
+    :param payment_profile_id: An Authorizenet customer payment profile id.
+    :type payment_profile_id: :py:obj:`int`
+    :param include_issuer_info: Whether to include issuer info in the response. Default is :py:obj:`False`.
     :type include_issuer_info: :py:obj:`bool`
     :returns: An Authorizenet getCustomerPaymentProfile response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    request = apicontractsv1.getCustomerPaymentProfileRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        customerPaymentProfileId=str(customer_payment_profile_id),
-        includeIssuerInfo=str(include_issuer_info).lower(),
-    )
+    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)
     )
 
 
 def validate_customer_payment_profile(
-    customer_profile_id: int, customer_payment_profile_id: int
-):
+    customer_profile_id: int, payment_profile_id: int
+) -> ObjectifiedElement | None:
     """
     `validateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-validate-customer-payment-profile>`_.
 
@@ -78,15 +84,15 @@ def validate_customer_payment_profile(
     :param customer_payment_profile_id: An Authorizenet customer payment profile id.
     :type customer_payment_profile_id: :py:obj:`int`
     :returns: An Authorizenet validateCustomerPaymentProfile response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    request = apicontractsv1.validateCustomerPaymentProfileRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        customerPaymentProfileId=str(customer_payment_profile_id),
-        validationMode=get_validation_mode(),
-    )
+    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)
     )
@@ -94,53 +100,59 @@ def validate_customer_payment_profile(
 
 def update_customer_payment_profile(
     customer_profile_id: int,
-    customer_payment_profile_id: int,
-    new_payment_profile: apicontractsv1.customerPaymentProfileType,
-):
+    payment_profile_id: int,
+    payment_profile: apicontractsv1.customerPaymentProfileType,
+    validate: bool = False,
+) -> ObjectifiedElement | None:
     """
     `updateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-payment-profile>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: :py:obj:`int`
-    :param customer_payment_profile_id: An Authorizenet customer payment profile id.
-    :type customer_payment_profile_id: :py:obj:`int`
-    :param new_payment_profile: An Authorizenet payment profile object.
-    :type new_payment_profile: :py:obj:`~authorizenet.apicontractsv1.customerPaymentProfileType`
+    :param payment_profile_id: An Authorizenet customer payment profile id.
+    :type payment_profile_id: :py:obj:`int`
+    :param payment_profile: An Authorizenet payment profile element.
+    :type payment_profile: :py:obj:`~authorizenet.apicontractsv1.customerPaymentProfileType`
+    :param validate: Whether to validate the updated payment profile. Default is :py:obj:`False`.
+    :type validate: :py:obj:`bool`
     :returns: An Authorizenet updateCustomerPaymentProfile response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    new_payment_profile.customerPaymentProfileId = str(customer_payment_profile_id)
-    request = apicontractsv1.updateCustomerPaymentProfileRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        paymentProfile=new_payment_profile,
-        validationMode=get_validation_mode(),
-    )
+    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)
     )
 
 
 def delete_customer_payment_profile(
-    customer_profile_id: int, customer_payment_profile_id: int
-):
+    customer_profile_id: int, payment_profile_id: int
+) -> ObjectifiedElement | None:
     """
     `deleteCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-payment-profile>`_.
 
     :param customer_profile_id: An Authorizenet customer profile id.
     :type customer_profile_id: :py:obj:`int`
-    :param customer_payment_profile_id: An Authorizenet customer payment profile id.
-    :type customer_payment_profile_id: :py:obj:`int`
+    :param payment_profile_id: An Authorizenet customer payment profile id.
+    :type payment_profile_id: :py:obj:`int`
     :returns: An Authorizenet deleteCustomerPaymentProfile response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    request = apicontractsv1.deleteCustomerPaymentProfileRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        customerPaymentProfileId=str(customer_payment_profile_id),
-    )
+    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)
     )

terminusgps/authorizenet/{subscriptions.py → api/subscriptions.py}

@@ -1,26 +1,42 @@
 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__ = [
+    "create_subscription",
+    "get_subscription",
+    "get_subscription_status",
+    "update_subscription",
+    "cancel_subscription",
+]
 
-def create_subscription(subscription_obj: apicontractsv1.ARBSubscriptionType):
+
+def create_subscription(
+    subscription: apicontractsv1.ARBSubscriptionType,
+) -> ObjectifiedElement | None:
     """
     `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`
+    :param subscription: An Authorizenet ARBSubscriptionType element.
+    :type subscription: :py:obj:`~authorizenet.apicontractsv1.ARBSubscriptionType`
     :returns: An Authorizenet ARBCreateSubscription response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    request = apicontractsv1.ARBCreateSubscriptionRequest(
-        merchantAuthentication=get_merchant_auth(), subscription=subscription_obj
+    request = apicontractsv1.ARBCreateSubscriptionRequest()
+    request.merchantAuthentication = get_merchant_auth()
+    request.subscription = subscription
+
+    return execute_controller(
+        apicontrollers.ARBCreateSubscriptionController(request)
     )
-    return execute_controller(apicontrollers.ARBCreateSubscriptionController(request))
 
 
-def get_subscription(subscription_id: int, include_transactions: bool = True):
+def get_subscription(
+    subscription_id: int, include_transactions: bool = True
+) -> ObjectifiedElement | None:
     """
     `ARBGetSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-get-subscription>`_.
 
@@ -29,7 +45,7 @@ def get_subscription(subscription_id: int, include_transactions: bool = True):
     :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`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
     request = apicontractsv1.ARBGetSubscriptionRequest(
@@ -37,21 +53,24 @@ def get_subscription(subscription_id: int, include_transactions: bool = True):
         subscriptionId=str(subscription_id),
         includeTransactions=str(include_transactions).lower(),
     )
-    return execute_controller(apicontrollers.ARBGetSubscriptionController(request))
+    return execute_controller(
+        apicontrollers.ARBGetSubscriptionController(request)
+    )
 
 
-def get_subscription_status(subscription_id: int):
+def get_subscription_status(subscription_id: int) -> ObjectifiedElement | None:
     """
     `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`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
     request = apicontractsv1.ARBGetSubscriptionStatusRequest(
-        merchantAuthentication=get_merchant_auth(), subscriptionId=str(subscription_id)
+        merchantAuthentication=get_merchant_auth(),
+        subscriptionId=str(subscription_id),
     )
     return execute_controller(
         apicontrollers.ARBGetSubscriptionStatusController(request)
@@ -60,7 +79,7 @@ def get_subscription_status(subscription_id: int):
 
 def update_subscription(
     subscription_id: int, subscription_obj: apicontractsv1.ARBSubscriptionType
-):
+) -> ObjectifiedElement | None:
     """
     `ARBUpdateSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-update-a-subscription>`_.
 
@@ -69,7 +88,7 @@ def update_subscription(
     :param subscription_obj: An Authorizenet subscription object.
     :type subscription_obj: :py:obj:`~authorizenet.apicontractsv1.ARBSubscriptionType`
     :returns: An Authorizenet ARBUpdateSubscription response.
-    :rtype: :py:obj:`dict`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
     request = apicontractsv1.ARBUpdateSubscriptionRequest(
@@ -77,20 +96,25 @@ def update_subscription(
         subscriptionId=str(subscription_id),
         subscription=subscription_obj,
     )
-    return execute_controller(apicontrollers.ARBUpdateSubscriptionController(request))
+    return execute_controller(
+        apicontrollers.ARBUpdateSubscriptionController(request)
+    )
 
 
-def cancel_subscription(subscription_id: int):
+def cancel_subscription(subscription_id: int) -> ObjectifiedElement | None:
     """
     `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`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
     request = apicontractsv1.ARBCancelSubscriptionRequest(
-        merchantAuthentication=get_merchant_auth(), subscriptionId=str(subscription_id)
+        merchantAuthentication=get_merchant_auth(),
+        subscriptionId=str(subscription_id),
+    )
+    return execute_controller(
+        apicontrollers.ARBCancelSubscriptionController(request)
     )
-    return execute_controller(apicontrollers.ARBCancelSubscriptionController(request))

terminusgps/authorizenet/api/transactions.py

@@ -0,0 +1,77 @@
+from datetime 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, end: 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: :py:obj:`~datetime.datetime`
+    :param end: Last settlement date.
+    :type end: :py:obj:`~datetime.datetime`
+    :returns: An Authorizenet getSettledBatchListResponse element.
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`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 :py:obj:`int`
+    :param ordering: An Authorizenet transaction list ordering string. Default is :py:obj:`"submitTimeUTC"`.
+    :type ordering: :py:obj:`str`
+    :param descending: Whether to sort the transaction list in descending order. Default is :py:obj:`False` (ascending order).
+    :type descending: :py:obj:`bool`
+    :param limit: Total number of transactions to return in the list.
+    :type limit: :py:obj:`int`
+    :param offset: Page number to return results from.
+    :type offset: :py:obj:`int`
+    :returns: An Authorizenet getTransactionListResponse element.
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`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)
+    )

terminusgps/authorizenet/constants.py

@@ -1,19 +1,15 @@
-import enum
+from django.db import models
+from django.utils.translation import gettext_lazy as _
 
 ANET_XMLNS = "{AnetApi/xml/v1/schema/AnetApiSchema.xsd}"
 """Authorizenet XML namespace."""
 
 
-class AuthorizenetSubscriptionStatus(enum.StrEnum):
-    """Authorizenet subscription statuses."""
+class AuthorizenetSubscriptionStatus(models.TextChoices):
+    """An Authorizenet subscription status."""
 
-    ACTIVE = "active"
-    """An active subscription."""
-    EXPIRED = "expired"
-    """An expired subscription."""
-    SUSPENDED = "suspended"
-    """A suspended subscription."""
-    CANCELED = "canceled"
-    """A canceled subscription."""
-    TERMINATED = "terminated"
-    """A terminated subscription."""
+    ACTIVE = "active", _("Active")
+    EXPIRED = "expired", _("Expired")
+    SUSPENDED = "suspended", _("Suspended")
+    CANCELED = "canceled", _("Canceled")
+    TERMINATED = "terminated", _("Terminated")

terminusgps/authorizenet/controllers.py

@@ -1,11 +1,12 @@
-import typing
-
 from authorizenet.apicontrollersbase import APIOperationBase
+from lxml.objectify import ObjectifiedElement
 
 from .auth import get_environment
 
 
-def execute_controller(controller: APIOperationBase) -> dict[str, typing.Any] | None:
+def execute_controller(
+    controller: APIOperationBase,
+) -> ObjectifiedElement | None:
     """
     Executes an Authorizenet API controller and returns its response.
 
@@ -13,15 +14,12 @@ def execute_controller(controller: APIOperationBase) -> dict[str, typing.Any] |
     :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`
+    :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
 
     """
-    try:
-        controller.setenvironment(get_environment())
-        controller.execute()
-        response = controller.getresponse()
-    except Exception:
-        response = None
+    controller.setenvironment(get_environment())
+    controller.execute()
+    response = controller.getresponse()
 
     if response is not None and response.messages.resultCode != "Ok":
         raise AuthorizenetControllerExecutionError(
@@ -31,26 +29,6 @@ def execute_controller(controller: APIOperationBase) -> dict[str, typing.Any] |
     return response
 
 
-class AuthorizenetControllerExecutor:
-    """Allows objects to use :py:meth:`execute_controller` to execute Authorizenet API controllers."""
-
-    @staticmethod
-    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`
-
-        """
-        return execute_controller(controller)
-
-
 class AuthorizenetControllerExecutionError(Exception):
     """Raised when an Authorizenet API controller fails to execute."""
 

terminusgps/authorizenet/validators.py

@@ -32,7 +32,10 @@ def validate_credit_card_number(value: str) -> None:
 
     checksum = 0
     checksum += sum(
-        [digit * 2 if digit * 2 <= 9 else (digit * 2) % 9 or 9 for digit in even_digits]
+        [
+            digit * 2 if digit * 2 <= 9 else (digit * 2) % 9 or 9
+            for digit in even_digits
+        ]
     )
     checksum += sum([digit for digit in odd_digits])
 
@@ -61,7 +64,9 @@ def validate_credit_card_expiry_month(value: str) -> None:
         )
     if not int(value) > 0:
         raise ValidationError(
-            _("Expiration month can only be a positive value, got '%(value)s'."),
+            _(
+                "Expiration month can only be a positive value, got '%(value)s'."
+            ),
             code="invalid",
             params={"value": value},
         )
@@ -97,7 +102,9 @@ def validate_credit_card_expiry_year(value: str) -> None:
         )
     if not int(value) > 0:
         raise ValidationError(
-            _("Expiration year can only be a positive value, got '%(value)s'."),
+            _(
+                "Expiration year can only be a positive value, got '%(value)s'."
+            ),
             code="invalid",
             params={"value": value},
         )

terminusgps/django/validators.py

@@ -30,26 +30,26 @@ def validate_e164_phone_number(value: str) -> None:
             code="invalid",
             params={"value": value},
         )
-    if len(value) < 11:
+    if len(value) < 12:
         raise ValidationError(
             _(
-                "E.164 phone number cannot be less than 11 characters in length, got %(len)s."
+                "E.164 phone number cannot be less than 12 characters in length, got %(len)s."
             ),
             code="invalid",
             params={"len": len(value)},
         )
-    if len(value) > 16:
+    if len(value) > 15:
         raise ValidationError(
             _(
-                "E.164 phone number cannot be greater than 16 characters in length, got %(len)s."
+                "E.164 phone number cannot be greater than 15 characters in length, got %(len)s."
             ),
             code="invalid",
             params={"len": len(value)},
         )
 
-    country_code: str = value[:-10]
-    area_code: str = value[-10:-7]
-    subscriber_number: str = value[-7:]
+    country_code = value[:-10]
+    area_code = value[-10:-7]
+    subscriber_number = value[-7:]
 
     if len(country_code) < 2 or len(country_code) > 5:
         raise ValidationError(
@@ -77,7 +77,7 @@ def validate_e164_phone_number(value: str) -> None:
         )
     if not area_code.isdigit():
         raise ValidationError(
-            _("E.164 phone number must have a valid area code, got '%(area_code)s'"),
+            _("E.164 phone number must have a valid area code, got '%(area_code)s'."),
             code="invalid",
             params={"area_code": area_code},
         )
@@ -92,7 +92,7 @@ def validate_e164_phone_number(value: str) -> None:
     if not subscriber_number.isdigit():
         raise ValidationError(
             _(
-                "E.164 phone number must have a valid subscriber number, got '%(subscriber_number)s'"
+                "E.164 phone number must have a valid subscriber number, got '%(subscriber_number)s'."
             ),
             code="invalid",
             params={"subscriber_number": subscriber_number},

terminusgps/authorizenet/profiles/__init__.py

@@ -1,3 +0,0 @@
-from .addresses import *
-from .customers import *
-from .payments import *

terminusgps/authorizenet/profiles/customers.py

@@ -1,107 +0,0 @@
-from authorizenet import apicontractsv1, apicontrollers
-
-from terminusgps.authorizenet.auth import get_merchant_auth
-from terminusgps.authorizenet.controllers import execute_controller
-
-__all__ = [
-    "create_customer_profile",
-    "delete_customer_profile",
-    "get_customer_profile",
-    "get_customer_profile_ids",
-    "update_customer_profile",
-]
-
-
-def create_customer_profile(merchant_id: int | str, email: str, description: str = ""):
-    """
-    `createCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile>`_.
-
-    :param merchant_id: A merchant designated customer id.
-    :type merchant_id: :py:obj:`int` | :py:obj:`str`
-    :param email: A customer email address.
-    :type email: :py:obj:`str`
-    :param description: An optional customer description.
-    :type description: :py:obj:`str`
-    :returns: An Authorizenet createCustomerProfile response.
-    :rtype: :py:obj:`dict`
-
-    """
-    request = apicontractsv1.createCustomerProfileRequest(
-        merchantAuthentication=get_merchant_auth(),
-        profile=apicontractsv1.customerProfileType(
-            merchantCustomerId=str(merchant_id), description=description, email=email
-        ),
-    )
-    return execute_controller(apicontrollers.createCustomerProfileController(request))
-
-
-def get_customer_profile(customer_profile_id: int, include_issuer_info: bool = False):
-    """
-    `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_.
-
-    :param customer_profile_id: An Authorizenet customer profile id.
-    :type customer_profile_id: :py:obj:`int`
-    :param include_issuer_info: Whether or not to include issuer info in the response. Default is :py:obj:`False`.
-    :type include_issuer_info: :py:obj:`bool`
-    :returns: An Authorizenet getCustomerProfile response.
-    :rtype: :py:obj:`dict`
-
-    """
-    request = apicontractsv1.getCustomerProfileRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-        includeIssuerInfo=str(include_issuer_info).lower(),
-    )
-    return execute_controller(apicontrollers.getCustomerProfileController(request))
-
-
-def get_customer_profile_ids():
-    """
-    `getCustomerProfileIdsRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile-ids>`_.
-
-    :returns: An Authorizenet getCustomerProfileIds response.
-    :rtype: :py:obj:`dict`
-
-    """
-    request = apicontractsv1.getCustomerProfileIdsRequest(
-        merchantAuthentication=get_merchant_auth()
-    )
-    return execute_controller(apicontrollers.getCustomerProfileIdsController(request))
-
-
-def update_customer_profile(
-    customer_profile_id: int, new_profile: apicontractsv1.customerProfileExType
-):
-    """
-    `updateCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-profile>`_.
-
-    :param customer_profile_id: An Authorizenet customer profile id.
-    :type customer_profile_id: :py:obj:`int`
-    :param new_profile: An Authorizenet customer profile ex object.
-    :type new_profile: :py:obj:`~authorizenet.apicontractsv1.customerProfileExType`
-    :returns: An Authorizenet updateCustomerProfile response.
-    :rtype: :py:obj:`dict`
-
-    """
-    new_profile.customerProfileId = str(customer_profile_id)
-    request = apicontractsv1.updateCustomerProfileRequest(
-        merchantAuthentication=get_merchant_auth(), profile=new_profile
-    )
-    return execute_controller(apicontrollers.updateCustomerProfileController(request))
-
-
-def delete_customer_profile(customer_profile_id: int):
-    """
-    `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: :py:obj:`int`
-    :returns: An Authorizenet deleteCustomerProfile response.
-    :rtype: :py:obj:`dict`
-
-    """
-    request = apicontractsv1.deleteCustomerProfileRequest(
-        merchantAuthentication=get_merchant_auth(),
-        customerProfileId=str(customer_profile_id),
-    )
-    return execute_controller(apicontrollers.deleteCustomerProfileController(request))

terminusgps/authorizenet/utils.py

@@ -1,172 +0,0 @@
-import datetime
-import decimal
-
-from authorizenet import apicontractsv1, apicontrollers
-from django import forms
-from django.conf import settings
-
-from .auth import get_merchant_auth
-from .controllers import AuthorizenetControllerExecutor
-
-
-def calculate_amount_plus_tax(
-    amount: decimal.Decimal, tax_rate: decimal.Decimal | None = None
-) -> decimal.Decimal:
-    """
-    Returns the amount + tax. Uses :confval:`DEFAULT_TAX_RATE` if ``tax_rate`` wasn't provided.
-
-    :param amount: Amount to add tax to.
-    :type amount: :py:obj:`~decimal.Decimal`
-    :param tax_rate: A tax rate to use in the calculation.
-    :type tax_rate: :py:obj:`~decimal.Decimal` | :py:obj:`None`
-    :returns: The amount + tax.
-    :rtype: :py:obj:`~decimal.Decimal`
-
-    """
-    if tax_rate is None:
-        tax_rate = settings.DEFAULT_TAX_RATE
-    return round(amount * (1 + tax_rate), ndigits=2)
-
-
-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 generate_monthly_subscription_schedule(
-    start_date: datetime.date, total_occurrences: int = 9999, trial_occurrences: int = 0
-) -> apicontractsv1.paymentScheduleType:
-    return apicontractsv1.paymentScheduleType(
-        interval=apicontractsv1.paymentScheduleTypeInterval(
-            length=1, unit=apicontractsv1.ARBSubscriptionUnitEnum.months
-        ),
-        startDate=f"{start_date:%Y-%m-%d}",
-        totalOccurrences=str(total_occurrences),
-        trialOccurrences=str(trial_occurrences),
-    )
-
-
-def get_customer_profile_ids() -> list[int]:
-    """
-    Returns a list of all customer profile ids in Authorizenet.
-
-    :raises AuthorizenetControllerExecutionError: If the API call fails.
-    :returns: A list of all customer profile ids in Authorizenet.
-    :rtype: :py:obj:`list`
-
-    """
-    request = apicontractsv1.getCustomerProfileIdsRequest(
-        merchantAuthentication=get_merchant_auth()
-    )
-    controller = apicontrollers.getCustomerProfileIdsController(request)
-    response = AuthorizenetControllerExecutor.execute_controller(controller)
-    if response is None or "ids" not in response.getchildren():
-        return []
-    return [int(id) for id in response.ids.getchildren()]
-
-
-def generate_customer_address(form: forms.Form) -> apicontractsv1.customerAddressType:
-    """
-    Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.customerAddressType`.
-
-    Required form fields:
-
-    +----------------+------------------------------------------------------------+
-    | name           | type                                                       |
-    +================+============================================================+
-    | ``address``    | :py:obj:`~authorizenet.apicontractsv1.customerAddressType` |
-    +----------------+------------------------------------------------------------+
-    | ``first_name`` | :py:obj:`str`                                              |
-    +----------------+------------------------------------------------------------+
-    | ``last_name``  | :py:obj:`str`                                              |
-    +----------------+------------------------------------------------------------+
-
-    :param form: A Django form.
-    :type form: :py:obj:`~django.forms.Form`
-    :raises ValueError: If ``address`` wasn't in the form.
-    :raises ValueError: If ``first_name`` wasn't in the form.
-    :raises ValueError: If ``last_name`` wasn't in the form.
-    :returns: A customer address object.
-    :rtype: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
-
-    """
-    required_fields: list[str] = ["address", "first_name", "last_name"]
-    for field in required_fields:
-        if field not in form.cleaned_data or form.cleaned_data.get(field) is None:
-            raise ValueError(
-                f"'{field}' was not provided by the form, got '{form.cleaned_data.get(field)}'."
-            )
-
-    address: apicontractsv1.customerAddressType = form.cleaned_data["address"]
-    address.firstName = form.cleaned_data["first_name"]
-    address.lastName = form.cleaned_data["last_name"]
-    if form.cleaned_data.get("phone"):
-        address.phone = form.cleaned_data["phone"]
-    return address
-
-
-def generate_customer_payment(form: forms.Form) -> apicontractsv1.paymentType:
-    """
-    Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.paymentType`.
-
-    Required form fields:
-
-    +-----------------+-------------------------------------------------------+
-    | name            | type                                                  |
-    +=================+=======================================================+
-    | ``credit_card`` | :py:obj:`~authorizenet.apicontractsv1.creditCardType` |
-    +-----------------+-------------------------------------------------------+
-
-    :param form: A Django form.
-    :type form: :py:obj:`~django.forms.Form`
-    :raises ValueError: If ``credit_card`` wasn't in the form.
-    :returns: A payment object.
-    :rtype: :py:obj:`~authorizenet.apicontractsv1.paymentType`
-
-    """
-    required_fields: list[str] = ["credit_card"]
-    for field in required_fields:
-        if field not in form.cleaned_data or form.cleaned_data.get(field) is None:
-            raise ValueError(
-                f"'{field}' was not provided by the form, got '{form.cleaned_data.get(field)}'."
-            )
-
-    credit_card: apicontractsv1.creditCardType = form.cleaned_data["credit_card"]
-    return apicontractsv1.paymentType(creditCard=credit_card)