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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 43.3.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-43.3.0 → python_terminusgps-45.0.0}/docs/source/authorizenet/api.rst

@@ -1,5 +1,5 @@
-Authorizenet API Endpoints
-==========================
+Functions
+=========
 
 ================
 Address Profiles

python_terminusgps-45.0.0/docs/source/authorizenet/auth.rst

@@ -0,0 +1,22 @@
+Authentication
+==============
+
+Authentication for each Authorizenet API call is handled by values defined in a Django ``settings.py`` module.
+
+Required settings:
+
+   +-----------------------------------+---------------+
+   | setting                           | type          |
+   +===================================+===============+
+   | ``MERCHANT_AUTH_ENVIRONMENT``     | :py:obj:`str` |
+   +-----------------------------------+---------------+
+   | ``MERCHANT_AUTH_LOGIN_ID``        | :py:obj:`str` |
+   +-----------------------------------+---------------+
+   | ``MERCHANT_AUTH_TRANSACTION_KEY`` | :py:obj:`str` |
+   +-----------------------------------+---------------+
+   | ``MERCHANT_AUTH_VALIDATION_MODE`` | :py:obj:`str` |
+   +-----------------------------------+---------------+
+
+.. automodule:: terminusgps.authorizenet.auth
+    :synopsis: Provides functions for authenticating Authorizenet API calls.
+    :members:

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

@@ -0,0 +1,20 @@
+Constants
+=========
+
+These constants inherit from :py:obj:`~django.db.models.TextChoices`, not the built-in Python :py:obj:`~enum.StrEnum` type.
+
+Django :py:obj:`~django.db.models.TextChoices` provides attributes such as :py:attr:`~django.db.models.TextChoices.choices`, :py:attr:`~django.db.models.TextChoices.values`, :py:attr:`~django.db.models.TextChoices.labels` and more.
+
+.. py:currentmodule:: terminusgps.authorizenet.constants
+
+.. autoclass:: Environment
+    :members:
+
+.. autoclass:: SubscriptionStatus
+    :members:
+
+.. autoclass:: SubscriptionIntervalUnit
+    :members:
+
+.. autoclass:: ValidationMode
+    :members:

python_terminusgps-43.3.0/docs/source/authorizenet/controllers.rst → python_terminusgps-45.0.0/docs/source/authorizenet/exceptions.rst

@@ -1,4 +1,4 @@
-API Controllers
-===============
+Exceptions
+==========
 
 .. autoexception:: terminusgps.authorizenet.controllers.AuthorizenetControllerExecutionError

python_terminusgps-45.0.0/docs/source/authorizenet/index.rst

@@ -0,0 +1,32 @@
+Authorizenet
+============
+
+The :py:mod:`terminusgps.authorizenet` package provides convenient functions for interacting with the Authorizenet API in a Pythonic interface.
+
+Most `Authorizenet API endpoints <https://developer.authorize.net/api/reference/index.html>`_ are represented as plain Python functions.
+
+.. attention:: These functions require the following settings to be present in your Django project's ``settings.py`` module.
+
+   Using this package without setting these settings will raise :py:exc:`~django.core.exceptions.ImproperlyConfigured`.
+
+   +-----------------------------------+---------------+
+   | setting                           | type          |
+   +===================================+===============+
+   | ``MERCHANT_AUTH_ENVIRONMENT``     | :py:obj:`str` |
+   +-----------------------------------+---------------+
+   | ``MERCHANT_AUTH_LOGIN_ID``        | :py:obj:`str` |
+   +-----------------------------------+---------------+
+   | ``MERCHANT_AUTH_TRANSACTION_KEY`` | :py:obj:`str` |
+   +-----------------------------------+---------------+
+   | ``MERCHANT_AUTH_VALIDATION_MODE`` | :py:obj:`str` |
+   +-----------------------------------+---------------+
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    auth.rst
+    constants.rst
+    exceptions.rst
+    api.rst
+    usage.rst

{python_terminusgps-43.3.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 = "43.3.0"
+release = "45.0.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -28,8 +28,8 @@ extensions = [
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
     "django": (
-        "http://docs.djangoproject.com/en/stable/",
-        "http://docs.djangoproject.com/en/stable/_objects/",
+        "https://docs.djangoproject.com/en/5.2/",
+        "https://docs.djangoproject.com/en/5.2/objects.inv",
     ),
 }
 
@@ -40,7 +40,9 @@ exclude_patterns = []
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
+autodoc_member_order = "groupwise"
 html_theme = "sphinxawesome_theme"
 pygments_style = "sas"
 pygments_style_dark = "lightbulb"
 html_static_path = ["_static"]
+graphviz_dot = "/usr/bin/dot"

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

@@ -6,9 +6,11 @@
 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 hardware/software GPS monitoring company.
+`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".
 
@@ -16,23 +18,17 @@ python-terminusgps documentation
 Installation
 ============
 
-
 Use pip to install from `PyPI <https://pypi.org/project/python-terminusgps/>`_.
 
 .. code:: bash
 
-   pip install python-terminusgps
-
-All subpackages are nested within :py:mod:`terminusgps`:
-
-.. code:: python
-
-    from terminusgps.wialon.session import WialonSession # Creates Wialon API sessions
+    pip install python-terminusgps
 
 .. toctree::
     :maxdepth: 2
     :caption: Contents:
 
     authorizenet/index.rst
-    django/index.rst
+    mixins.rst
+    validators.rst
     wialon/index.rst

python_terminusgps-45.0.0/docs/source/mixins.rst

@@ -0,0 +1,5 @@
+Mixins
+======
+
+.. autoclass:: terminusgps.mixins.HtmxTemplateResponseMixin
+    :members:

python_terminusgps-45.0.0/docs/source/validators.rst

@@ -0,0 +1,5 @@
+Validators
+==========
+
+.. automodule:: terminusgps.validators
+    :members:

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-45.0.0/docs/source/wialon/exceptions.rst

@@ -0,0 +1,5 @@
+Exceptions
+==========
+
+.. autoexception:: terminusgps.wialon.session.WialonAPIError
+    :members:

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

@@ -0,0 +1,15 @@
+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 classes which have methods that make `Wialon API calls <https://help.wialon.com/en/api/user-guide/api-reference>`_.
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    constants.rst
+    exceptions.rst
+    items.rst
+    session.rst
+    usage.rst

{python_terminusgps-43.3.0 → python_terminusgps-45.0.0}/docs/source/wialon/items.rst

@@ -9,38 +9,43 @@ Base
     :autoclasstoc:
     :members:
 
-=======
-Factory
-=======
+=========
+Factories
+=========
 
 .. autoclass:: terminusgps.wialon.items.factory.WialonObjectFactory
     :autoclasstoc:
-    :members:
+
 
 ==============
 Wialon objects
 ==============
 
 .. autoclass:: terminusgps.wialon.items.account.WialonAccount
+    :autoclasstoc:
     :members:
 
 .. autoclass:: terminusgps.wialon.items.resource.WialonResource
+    :autoclasstoc:
     :members:
 
 .. autoclass:: terminusgps.wialon.items.retranslator.WialonRetranslator
-    :members:
-
-.. autoclass:: terminusgps.wialon.items.retranslator.WialonRetranslatorConfiguration
+    :autoclasstoc:
     :members:
 
 .. autoclass:: terminusgps.wialon.items.route.WialonRoute
+    :autoclasstoc:
     :members:
 
 .. autoclass:: terminusgps.wialon.items.unit.WialonUnit
+    :autoclasstoc:
     :members:
 
 .. autoclass:: terminusgps.wialon.items.unit_group.WialonUnitGroup
+    :autoclasstoc:
     :members:
 
 .. autoclass:: terminusgps.wialon.items.user.WialonUser
+    :autoclasstoc:
     :members:
+

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

@@ -0,0 +1,6 @@
+Sessions
+========
+
+.. autoclass:: terminusgps.wialon.session.WialonSession
+   :members:
+   :class-doc-from: init

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

@@ -0,0 +1,70 @@
+Usage
+=====
+
+To perform Wialon API operations, open a :py:obj:`~terminusgps.wialon.session.WialonSession` in a context manager, passing in your desired Wialon API token to use during the session's lifetime.
+
+If :py:data:`token` isn't provided, the environment variable ``"WIALON_TOKEN"`` is passed instead.
+
+.. code:: python
+
+    from terminusgps.wialon.session import WialonSession
+
+    # Context manager handles logging in and out of the Wialon API session
+    with WialonSession(token="my_wialon_api_token") as session:
+        # Perform Wialon API calls within this block
+        # Session is logged out when the interpreter exits this block
+        session.wialon_api.core_search_item(**{"id": 123, "flags": 0x1})
+
+    # Will raise WialonAPIError because the session is now invalid (logged out)
+    session.wialon_api.core_search_item(**{"id": 123, "flags": 0x1})
+
+Instead of remembering every `Wialon API endpoint <https://help.wialon.com/en/api/user-guide/api-reference>`_, initialize a :py:obj:`~terminusgps.wialon.items.factory.WialonObjectFactory` in a :py:obj:`~terminusgps.wialon.session.WialonSession` to retrieve objects with convenient methods for calling the Wialon API:
+
+.. code:: python
+
+    from terminusgps.wialon.items import WialonObjectFactory
+    from terminusgps.wialon.session import WialonSession
+
+    with WialonSession(token="my_wialon_api_token") as session:
+        # A valid Wialon API session is the only argument passed to the factory
+        factory = WialonObjectFactory(session)
+        # Call get() or create() on the factory to retrieve a WialonObject instance
+        # The 'items_type' argument mirrors Wialon's definition of Wialon objects, e.g. 'avl_unit' for WialonUnit, 'avl_resource' for WialonResource, etc.
+        unit = factory.get("avl_unit", 123)
+        # Refer to your IDE or this documentation for available attributes and methods of each Wialon object type.
+
+========
+Examples
+========
+
+Creating a new Wialon user
+--------------------------
+
+.. code:: python
+
+    from terminusgps.wialon.items import WialonObjectFactory
+    from terminusgps.wialon.session import WialonSession
+
+    with WialonSession() as session:
+        factory = WialonObjectFactory(session)
+        user = factory.create(
+            "user",
+            creator_id=12345678,
+            name="New User",
+            password="my_secure_password!1",
+        )
+
+.. seealso:: :py:meth:`~terminusgps.wialon.items.user.WialonUser.create` for details on creating a Wialon user.
+
+Update an existing Wialon user's name
+-------------------------------------
+
+.. code:: python
+
+    from terminusgps.wialon.items import WialonObjectFactory
+    from terminusgps.wialon.session import WialonSession
+
+    with WialonSession() as session:
+        factory = WialonObjectFactory(session)
+        user = factory.get("user", id=12345678)
+        user.set_name("New User")

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

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "43.3.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-43.3.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-43.3.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