python-terminusgps 42.2.4__tar.gz → 43.0.0__tar.gz

{python_terminusgps-42.2.4 → python_terminusgps-43.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 42.2.4
+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.4 → python_terminusgps-43.0.0}/docs/source/conf.py

@@ -18,7 +18,7 @@ django.setup()
 project = "python-terminusgps"
 copyright = "2025, Terminus GPS, LLC"
 author = "Terminus GPS, LLC"
-release = "42.2.4"
+release = "44.0.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{python_terminusgps-42.2.4 → python_terminusgps-43.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "42.2.4"
+version = "43.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" } ]
@@ -46,7 +46,7 @@ exclude = [
     "dist",
     "build",
 ]
-line-length = 88
+line-length = 79
 indent-width = 4
 target-version = "py312"
 

python_terminusgps-43.0.0/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 *

python_terminusgps-42.2.4/terminusgps/authorizenet/profiles/addresses.py → python_terminusgps-43.0.0/terminusgps/authorizenet/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)
     )

python_terminusgps-43.0.0/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)
+    )

python_terminusgps-42.2.4/terminusgps/authorizenet/profiles/payments.py → python_terminusgps-43.0.0/terminusgps/authorizenet/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)
     )