python-terminusgps 22.0.2__py3-none-any.whl → 23.0.0__py3-none-any.whl

{python_terminusgps-22.0.2.dist-info → python_terminusgps-23.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 22.0.2
+Version: 23.0.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://app.terminusgps.com/docs/apps/python-terminusgps/index.html
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps
@@ -17,8 +17,5 @@ Requires-Dist: authorizenet>=1.1.5
 Requires-Dist: boto3>=1.34.144
 Requires-Dist: django>=5.1.5
 Requires-Dist: matplotlib>=3.10.1
-Requires-Dist: opencv-python>=4.11.0.86
-Requires-Dist: pyqt6>=6.8.1
 Requires-Dist: python-wialon>=1.2.4
-Requires-Dist: pyzbar>=0.1.9
 Requires-Dist: twilio>=9.4.5

{python_terminusgps-22.0.2.dist-info → python_terminusgps-23.0.0.dist-info}/RECORD

@@ -1,26 +1,25 @@
 terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/settings.py,sha256=JMcMFqNQRIcljIZrEsU9pm9AhxG-gcnDC7EONKd3ShE,502
+terminusgps/settings.py,sha256=UBj2tvuBzQDEz05PeFqHG4_ise3Bl6Iu7pxcrtjNaYE,568
 terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/authorizenet/auth.py,sha256=JuP-l23PRnsnufda5f29Y61K9yhT6p6pRMEH5KGzmp0,564
-terminusgps/authorizenet/subscriptions.py,sha256=_SfaTYS_3rgHNqQuvZ59TK_zDFymU64sAzj9FCyqYyU,2217
+terminusgps/authorizenet/auth.py,sha256=l3sPpLycqVO-gppU2sH7YAScuHmm3xXylxW6Gdu6a7Q,563
+terminusgps/authorizenet/subscriptions.py,sha256=W2oIb1oWXEhtET4bHpUWzuLIl3XbAqMkghAXy0AyWAQ,1366
+terminusgps/authorizenet/utils.py,sha256=q8ReDcYIk2eG6d36IM1vZorfeAxKhyQRLdtrIpKTNwA,2212
 terminusgps/authorizenet/profiles/__init__.py,sha256=QKjMKcXpCSCEhv6LBCz0yGP8t0VxAyKyYRS4_HLYnxQ,114
-terminusgps/authorizenet/profiles/addresses.py,sha256=ffAi3LcEOB3Xsr9f4N_PfjSZcN3I9dTKNamoAmnLpo4,3838
-terminusgps/authorizenet/profiles/base.py,sha256=G7lXIYrWk5m1_MLuZT0xBs5vabKAUVbk9eZHl8Rahl8,3378
-terminusgps/authorizenet/profiles/customers.py,sha256=iEuNFP6PHuGdFQftgxxKpQFYaGw8IWLjsOaugvEOA-g,4513
-terminusgps/authorizenet/profiles/payments.py,sha256=qOWp-gO6qBCADP98WjoNCHm-jtq7DY5-moiPsOnT5yI,5263
+terminusgps/authorizenet/profiles/addresses.py,sha256=xAiqETexGXicYOd_M3a4SBuHweeZPDlfWhtpqdvls-g,5466
+terminusgps/authorizenet/profiles/base.py,sha256=UTudVCju5-pLJQwoK0IfuT8OvxZVJCX3vApveUY3XE4,2286
+terminusgps/authorizenet/profiles/customers.py,sha256=ehtsWhPt0zF8_3dFlgFBWHA4NbQb-6AvOhtjTy3uQDg,8639
+terminusgps/authorizenet/profiles/payments.py,sha256=jcF_uJcaeU2JR5Sqza0LccsQGe9F-SUCjvg3o3QskIk,8808
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/aws/secrets.py,sha256=kgRA77rs0mD4berWRLkPtJLOe4Grf--o5f8NzwQqXCk,360
+terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
 terminusgps/aws/ses.py,sha256=sDca2GjMaZvUt3kUPtGCpcqHiOkij9lMV1ogZofgYUU,2372
-terminusgps/opencv/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/opencv/barcodes.py,sha256=NmdpUnixlGJI-6shbKGcb6-M_IZvgSZJRDVSsI7pcFg,669
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
 terminusgps/twilio/caller.py,sha256=nHCIwUulo-C_v2orsp6OY0nuJA6YetSkxpMTwrRQ-uA,1831
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=n1ux68oWYWnzeZdN811Iw_Lk78KBM0YMJMoonn67uZY,1723
 terminusgps/wialon/flags.py,sha256=_NIL3mrEGhvI5YISVjimjYtUatdgOqhZPJX368MtKSU,13959
 terminusgps/wialon/logger.py,sha256=nUBsaLMaffSaAHGHAM6mFXDzix9hbNecVtA3INVtii8,968
-terminusgps/wialon/session.py,sha256=6xg65LZz6cebWclTQp1KRLvPss0aM-bWhAmmwiDOlMg,10267
-terminusgps/wialon/utils.py,sha256=HUuBgkqJzzsFHGKPgf_YAE0e5Oui8xdaYtb9fv_ibOc,6344
+terminusgps/wialon/session.py,sha256=t3d7trBQRxnXFnex73alSSD5n2LDTZQ9VAtzUKIERto,9670
+terminusgps/wialon/utils.py,sha256=Y7fo9a81w84b3N39h1AmVLS-AnC3aRT5R137hIsqCHU,6723
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
 terminusgps/wialon/items/base.py,sha256=EAtzlnCvB7WTu3iX1bV1-S9TvwXc-Eez7e0X4TMiK9U,6943
 terminusgps/wialon/items/resource.py,sha256=qmQKEakJa9LH5YkI9-iBDA0hsotc5ctcwdb7kZuXdfQ,14549
@@ -29,7 +28,7 @@ terminusgps/wialon/items/route.py,sha256=PTJx1gmT_PGz7nlSSUS2VzjYD-aAuvkEOIdIFne
 terminusgps/wialon/items/unit.py,sha256=-jQL5Alvz77FZWteYNM9VNX15jtCufI-DWRRj3hRsgA,8539
 terminusgps/wialon/items/unit_group.py,sha256=vGVJMBY1BrKK0tP-C1DCIz4Bh6P-HKRnKY1g8g95UIs,5031
 terminusgps/wialon/items/user.py,sha256=INwAibQVmjNNelepQXMfDevgJqMvIjHHgEjAMLRvhB0,7082
-python_terminusgps-22.0.2.dist-info/METADATA,sha256=1YPz8oMH4ULPwmgyGVls3OiNRkzULUwCQLTMZ7746pA,1043
-python_terminusgps-22.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-22.0.2.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-22.0.2.dist-info/RECORD,,
+python_terminusgps-23.0.0.dist-info/METADATA,sha256=mWo-bctKKFZdbhH0ROVcDsqvN9kC58jMl1o49TQkFCI,946
+python_terminusgps-23.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-23.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-23.0.0.dist-info/RECORD,,

terminusgps/authorizenet/auth.py

@@ -1,6 +1,5 @@
 from authorizenet.apicontractsv1 import merchantAuthenticationType
 from authorizenet.constants import constants
-
 from django.conf import settings
 
 

terminusgps/authorizenet/profiles/addresses.py

@@ -1,47 +1,59 @@
 from authorizenet import apicontractsv1, apicontrollers
-from authorizenet.apicontractsv1 import customerAddressType
 
 from terminusgps.authorizenet.profiles.base import AuthorizenetSubProfileBase
 
 
 class AddressProfile(AuthorizenetSubProfileBase):
-    def create(self, **kwargs) -> int:
+    """An Authorizenet customer address profile."""
+
+    def create(self, shipping_addr: apicontractsv1.customerAddressType) -> int:
         """
-        Creates an Authorize.NET address profile.
+        Creates an Authorizenet address profile.
 
-        :param shipping_addr: An Authorize.NET customer address.
+        :param shipping_addr: An Authorizenet customer address.
         :type shipping_addr: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
-        :raises ValueError: If no customer address was provided.
-        :raises TypeError: If the customer address is not a :py:obj:`~authorizenet.apicontractsv1.customerAddressType` object.
-        :returns: The new address profile's id.
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: A new address profile id.
         :rtype: :py:obj:`int`
 
         """
-        shipping_addr = kwargs.get("shipping_addr")
-
-        if not shipping_addr:
-            raise ValueError("'shipping_addr' is required on creation.")
-
-        if not isinstance(shipping_addr, customerAddressType):
-            raise TypeError(
-                f"'shipping_addr' must be customerAddressType, got '{type(shipping_addr)}'."
-            )
-
         response = self._authorizenet_create_shipping_address(shipping_addr)
         return int(response.customerAddressId)
 
-    def update(self, shipping_addr: customerAddressType) -> dict:
-        """Updates the Authorize.NET payment profile."""
+    def update(self, shipping_addr: apicontractsv1.customerAddressType) -> dict:
+        """
+        Updates the Authorizenet address profile.
+
+        :param shipping_addr: A customer shipping address.
+        :type shipping_addr: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         return self._authorizenet_update_shipping_address(shipping_addr)
 
     def delete(self) -> dict:
-        """Deletes the Authorize.NET payment profile."""
-        return self._authorizenet_delete_shipping_address()
+        """
+        Deletes the Authorizenet address profile.
 
-    def get_details(self) -> dict:
-        return self._authorizenet_get_shipping_address()
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict`
+
+        """
+        return self._authorizenet_delete_shipping_address()
 
     def _authorizenet_get_shipping_address(self) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerShippingAddressRequest` using the Authorizenet API.
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.getCustomerShippingAddressRequest(
@@ -53,7 +65,18 @@ class AddressProfile(AuthorizenetSubProfileBase):
         response = self.execute_controller(controller)
         return response
 
-    def _authorizenet_create_shipping_address(self, addr: customerAddressType) -> dict:
+    def _authorizenet_create_shipping_address(
+        self, addr: apicontractsv1.customerAddressType
+    ) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.createCustomerShippingAddressRequest` using the Authorizenet API.
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         request = apicontractsv1.createCustomerShippingAddressRequest(
             merchantAuthentication=self.merchantAuthentication,
             customerProfileId=self.customerProfileId,
@@ -64,10 +87,21 @@ class AddressProfile(AuthorizenetSubProfileBase):
         response = self.execute_controller(controller)
         return response
 
-    def _authorizenet_update_shipping_address(self, addr: customerAddressType) -> dict:
+    def _authorizenet_update_shipping_address(
+        self, addr: apicontractsv1.customerAddressType
+    ) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.updateCustomerShippingAddressRequest` using the Authorizenet API.
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         assert self.id, "'id' was not set."
-        addr.customerAddressId = self.id
 
+        addr.customerAddressId = self.id
         request = apicontractsv1.updateCustomerShippingAddressRequest(
             merchantAuthentication=self.merchantAuthentication,
             customerProfileId=self.customerProfileId,
@@ -75,10 +109,18 @@ class AddressProfile(AuthorizenetSubProfileBase):
             default=self.default,
         )
         controller = apicontrollers.updateCustomerShippingAddressController(request)
-        response = self.execute_controller(controller)
-        return response
+        return self.execute_controller(controller)
 
     def _authorizenet_delete_shipping_address(self) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerShippingAddressRequest` using the Authorizenet API.
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.deleteCustomerShippingAddressRequest(

terminusgps/authorizenet/profiles/base.py

@@ -1,81 +1,40 @@
 from abc import abstractmethod
+from typing import override
 
-from authorizenet.apicontractsv1 import merchantAuthenticationType
-from authorizenet.apicontrollersbase import APIOperationBase
+from authorizenet import apicontractsv1
 
-from ..auth import get_merchant_auth, get_environment, get_validation_mode
+from terminusgps.authorizenet.auth import get_merchant_auth, get_validation_mode
+from terminusgps.authorizenet.utils import ControllerExecutionMixin
 
 
-class AuthorizenetProfileBase:
+class AuthorizenetProfileBase(ControllerExecutionMixin):
     def __init__(
-        self, merchant_id: int | str, id: int | str | None = None, **kwargs
+        self, merchant_id: int | str, id: int | str | None = None, *args, **kwargs
     ) -> None:
         self._merchantCustomerId = merchant_id
-        self._id = str(id) if id else self.create(**kwargs)
+        self._id = int(id) if id else self.create(*args, **kwargs)
 
+    @override
     def __str__(self) -> str:
         return f"#{self.id}"
 
-    def execute_controller(self, controller: APIOperationBase) -> dict:
-        """
-        Executes an Authorize.NET controller and returns its response.
-
-        :param controller: An Authorize.NET API controller.
-        :raises ValueError: If the API call fails.
-        :returns: The Authorize.NET API response.
-        :rtype: :py:obj:`dict`
-
-        """
-        controller.setenvironment(self.environment)
-        controller.execute()
-        response = controller.getresponse()
-
-        if response.messages.resultCode != "Ok":
-            raise ValueError(response.messages.message[0]["text"].text)
-        return response
-
     @property
     def merchantCustomerId(self) -> str:
-        """
-        An internally designated customer id.
-
-        :type: :py:obj:`str`
-
-        """
+        """An internally designated customer id."""
         return str(self._merchantCustomerId)
 
     @property
     def id(self) -> str:
-        """
-        An Authorizenet generated id.
-
-        :type: :py:obj:`str`
-
-        """
+        """An Authorizenet generated id."""
         return str(self._id)
 
     @property
-    def merchantAuthentication(self) -> merchantAuthenticationType:
-        """
-        Merchant authentication for Authorizenet API calls.
-
-        :type: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`
-
-        """
+    def merchantAuthentication(self) -> apicontractsv1.merchantAuthenticationType:
+        """Merchant authentication for Authorizenet API calls."""
         return get_merchant_auth()
 
-    @property
-    def environment(self) -> str:
-        """
-        Environment for Authorizenet API calls to execute within.
-
-        :type: :py:obj:`str`
-
-        """
-        return get_environment()
-
     @abstractmethod
-    def create(self, **kwargs) -> int:
+    def create(self, *args, **kwargs) -> int:
         raise NotImplementedError("Subclasses must implement this method.")
 
     @abstractmethod
@@ -93,34 +52,19 @@ class AuthorizenetSubProfileBase(AuthorizenetProfileBase):
     ) -> None:
         self._customerProfileId = customer_profile_id
         self._default = default
-        return super().__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
     @property
     def validationMode(self) -> str:
-        """
-        The validation mode for Authorizenet API calls.
-
-        :type: :py:obj:`str`
-
-        """
+        """The validation mode for Authorizenet API calls."""
         return get_validation_mode()
 
     @property
     def default(self) -> str:
-        """
-        Whether or not the sub profile is set as default in Authorizenet.
-
-        :type: :py:obj:`str`
-
-        """
+        """Whether or not the sub profile is set as default in Authorizenet."""
         return str(self._default).lower()
 
     @property
     def customerProfileId(self) -> str:
-        """
-        An Authorizenet generated customer profile id.
-
-        :py:obj:`str`
-
-        """
+        """An Authorizenet generated customer profile id."""
         return str(self._customerProfileId)

terminusgps/authorizenet/profiles/customers.py

@@ -2,55 +2,119 @@ from authorizenet import apicontractsv1, apicontrollers
 from authorizenet.apicontractsv1 import customerProfileType
 
 from terminusgps.authorizenet.profiles.base import AuthorizenetProfileBase
+from terminusgps.authorizenet.utils import get_customer_profile_ids
 
 
 class CustomerProfile(AuthorizenetProfileBase):
-    def create(self, **kwargs) -> int:
+    """An Authorizenet customer profile."""
+
+    def create(self, email: str, desc: str | None = None) -> int:
         """
-        Creates the customer profile.
+        Creates a customer profile using the Authorizenet API and returns its id.
 
-        :param email: An email address for the customer profile.
+        :param email: An email address.
         :type email: :py:obj:`str`
-        :param desc: A description describing the customer profile. Optional.
+        :param desc: An optional description.
         :type desc: :py:obj:`str` | :py:obj:`None`
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
         :returns: The new customer profile id.
         :rtype: :py:obj:`int`
 
         """
-        if not kwargs.get("email"):
-            raise ValueError("'email' is required for creation.")
-
-        response = self._authorizenet_create_customer_profile(
-            email=kwargs["email"], desc=kwargs.get("desc", "")
-        )
+        response = self._authorizenet_create_customer_profile(email=email, desc=desc)
         return int(response.customerProfileId)
 
-    def update(self, email: str, desc: str = "") -> dict:
-        """Updates the customer profile."""
-        return self._authorizenet_update_customer_profile(email, desc)
+    def update(self, email: str, desc: str = "") -> None:
+        """
+        Updates the customer profile.
 
-    def delete(self) -> dict:
-        """Deletes the customer profile."""
-        return self._authorizenet_delete_customer_profile()
+        :param email: An email address.
+        :type email: :py:obj:`str`
+        :param desc: An optional description. Default is ``""``
+        :type desc: :py:obj:`str`
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self._authorizenet_update_customer_profile(email, desc)
+
+    def delete(self) -> None:
+        """
+        Deletes the customer profile.
+
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self._authorizenet_delete_customer_profile()
 
     def get_payment_profiles(self) -> list[dict] | None:
-        """Retrieves the customer profile's payment profiles list."""
-        profiles = self._authorizenet_get_customer_profile(issuer_info=False).get(
-            "paymentProfiles"
-        )
-        return profiles if profiles else None
+        """
+        Returns a list of the customer's payment profiles.
+
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: A list of customer payment profiles, if they exist.
+        :rtype: :py:obj:`list` | :py:obj:`None`
+
+        """
+        response = self._authorizenet_get_customer_profile(issuer_info=False)
+        return response.get("paymentProfiles") if response else None
+
+    def get_addresses(self) -> list[dict] | None:
+        """
+        Returns a list of the customer's address profiles.
+
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: A list of customer shipping addresses, if they exist.
+        :rtype: :py:obj:`list` | :py:obj:`None`
+
+        """
+        response = self._authorizenet_get_customer_profile(issuer_info=False)
+        return response.get("shipToList") if response else None
+
+    @property
+    def exists(self) -> bool:
+        """Whether or not the customer profile exists in Authorizenet."""
+        profile_ids = get_customer_profile_ids()
+        return int(self.id) in profile_ids if self.id is not None else False
+
+    def _authorizenet_get_customer_profile_ids(self) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerProfileIdsRequest` using the Authorizenet API.
+
+        `getCustomerProfileIdsRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile-ids>`_
 
-    def get_shipping_addresses(self) -> list[dict] | None:
-        """Retrieves the customer profile's shipping address list."""
-        addresses = self._authorizenet_get_customer_profile(issuer_info=False).get(
-            "shipToList"
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
+
+        """
+        request = apicontractsv1.getCustomerProfileIdsRequest(
+            merchantAuthentication=self.merchantAuthentication
         )
-        return addresses if addresses else None
+        controller = apicontrollers.getCustomerProfileIdsController(request)
+        return self.execute_controller(controller)
 
     def _authorizenet_create_customer_profile(
         self, email: str, desc: str = ""
-    ) -> dict[str, str]:
-        """Executes a :py:obj:`~authorizenet.apicontractsv1.createCustomerProfileRequest` using the Authorize.NET API."""
+    ) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.createCustomerProfileRequest` using the Authorizenet API.
+
+        `createCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile>`_
+
+        :param email: An email address.
+        :type email: :py:obj:`str`
+        :param desc: An optional description.
+        :type desc: :py:obj:`str`
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
+
+        """
         request = apicontractsv1.createCustomerProfileRequest(
             merchantAuthentication=self.merchantAuthentication,
             profile=customerProfileType(
@@ -60,11 +124,24 @@ class CustomerProfile(AuthorizenetProfileBase):
             ),
         )
         controller = apicontrollers.createCustomerProfileController(request)
-        response = self.execute_controller(controller)
-        return response
+        return self.execute_controller(controller)
+
+    def _authorizenet_get_customer_profile(
+        self, issuer_info: bool = True
+    ) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerProfileRequest` using the Authorizenet API.
 
-    def _authorizenet_get_customer_profile(self, issuer_info: bool = True) -> dict:
-        """Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerProfileRequest` using the Authorize.NET API."""
+        `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_
+
+        :param issuer_info: Whether or not to include issuer info in the response.
+        :type issuer_info: :py:obj:`bool`
+        :raises AssertionError: If :py:attr:`id` was not set.
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
+
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.getCustomerProfileRequest(
@@ -73,11 +150,26 @@ class CustomerProfile(AuthorizenetProfileBase):
             includeIssuerInfo=str(issuer_info).lower(),
         )
         controller = apicontrollers.getCustomerProfileController(request)
-        response = self.execute_controller(controller)
-        return response
+        return self.execute_controller(controller)
 
-    def _authorizenet_update_customer_profile(self, email: str, desc: str = "") -> dict:
-        """Executes an :py:obj:`~authorizenet.apicontractsv1.updateCustomerProfileRequest` using the Authorize.NET API."""
+    def _authorizenet_update_customer_profile(
+        self, email: str, desc: str = ""
+    ) -> dict | None:
+        """
+        Executes an :py:obj:`~authorizenet.apicontractsv1.updateCustomerProfileRequest` using the Authorizenet API.
+
+        `updateCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-profile>`_
+
+        :param email: An email address.
+        :type email: :py:obj:`str`
+        :param desc: An optional description.
+        :type desc: :py:obj:`str`
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
+
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.updateCustomerProfileRequest(
@@ -90,11 +182,20 @@ class CustomerProfile(AuthorizenetProfileBase):
             ),
         )
         controller = apicontrollers.updateCustomerProfileController(request)
-        response = self.execute_controller(controller)
-        return response
+        return self.execute_controller(controller)
+
+    def _authorizenet_delete_customer_profile(self) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerProfileRequest` using the Authorizenet API.
 
-    def _authorizenet_delete_customer_profile(self) -> dict:
-        """Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerProfileRequest` using the Authorize.NET API."""
+        `deleteCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-profile>`_
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
+
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.deleteCustomerProfileRequest(
@@ -102,5 +203,4 @@ class CustomerProfile(AuthorizenetProfileBase):
             customerProfileId=self.id,
         )
         controller = apicontrollers.deleteCustomerProfileController(request)
-        response = self.execute_controller(controller)
-        return response
+        return self.execute_controller(controller)

terminusgps/authorizenet/profiles/payments.py

@@ -1,63 +1,108 @@
 from authorizenet import apicontractsv1, apicontrollers
-from authorizenet.apicontractsv1 import (
-    customerAddressType,
-    customerPaymentProfileType,
-    paymentType,
-)
 
 from terminusgps.authorizenet.profiles.base import AuthorizenetSubProfileBase
 
 
 class PaymentProfile(AuthorizenetSubProfileBase):
-    def create(self, **kwargs) -> int:
+    """An Authorizenet customer payment profile."""
+
+    def create(
+        self,
+        billing_addr: apicontractsv1.customerAddressType,
+        payment: apicontractsv1.paymentType,
+    ) -> int:
         """
-        Creates an Authorize.NET payment profile.
+        Creates an Authorizenet payment profile and returns its id.
 
-        :param billing_addr: An Authorize.NET customer address.
+        :param billing_addr: A billing address.
         :type billing_addr: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
-        :param payment: An Authorize.NET API payment.
+        :param payment: A payment object.
         :type payment: :py:obj:`~authorizenet.apicontractsv1.paymentType`
         :returns: The new payment profile's id.
         :rtype: :py:obj:`int`
 
         """
-        billing_addr = kwargs.get("billing_addr")
-        payment = kwargs.get("payment")
-        if not billing_addr:
-            raise ValueError("'billing_addr' is required on creation.")
-        if not payment:
-            raise ValueError("'payment' is required on creation.")
-
-        if not isinstance(billing_addr, customerAddressType):
-            raise TypeError(
-                f"'billing_addr' must be customerAddressType, got '{type(billing_addr)}'"
-            )
-        if not isinstance(payment, paymentType):
-            raise TypeError(
-                f"'payment' must be customerAddressType, got '{type(payment)}'"
-            )
-
         response = self._authorizenet_create_payment_profile(billing_addr, payment)
         return int(response.customerPaymentProfileId)
 
-    def update(self, billing_addr: customerAddressType, payment: paymentType) -> dict:
-        """Updates the Authorize.NET payment profile."""
+    def update(
+        self,
+        billing_addr: apicontractsv1.customerAddressType,
+        payment: apicontractsv1.paymentType,
+    ) -> dict:
+        """Updates the Authorizenet payment profile."""
         return self._authorizenet_update_payment_profile(billing_addr, payment)
 
     def delete(self) -> dict:
-        """Deletes the Authorize.NET payment profile."""
+        """Deletes the Authorizenet payment profile."""
         return self._authorizenet_delete_payment_profile()
 
     def get_details(self, issuer_info: bool = False) -> dict:
         return self._authorizenet_get_payment_profile(issuer_info)
 
+    def _authorizenet_get_transaction_list_for_customer(
+        self,
+        limit: int = 100,
+        ordering: str = "submitTimeUTC",
+        offset: int = 1,
+        descending: bool = False,
+    ) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getTransactionListForCustomerRequest` using the Authorizenet API.
+
+        :param limit: Total number of transactions to retrieve. Default is ``100``.
+        :type limit: :py:obj:`int`
+        :param ordering: A field to order the transactions by. Default is ``"submitTimeUTC"``.
+        :type ordering: :py:obj:`str`
+        :param offset: Page of the response to retrieve.
+        :type offset: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param descending: Sort the results in descending order.
+        :type descending: :py:obj:`bool`
+        :raises ValueError: If ``ordering`` is invalid.
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
+        ordering_options: tuple[str, str] = ("id", "submitTimeUTC")
+        if ordering not in ordering_options:
+            raise ValueError(
+                f"'ordering' must be one of {ordering_options}, got '{ordering}'."
+            )
+
+        request = apicontractsv1.getTransactionListForCustomerRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            customerProfileId=self.customerProfileId,
+            customerPaymentProfileId=self.id,
+            sorting={"orderBy": ordering, "orderDescending": str(descending).lower()},
+            paging={"limit": str(limit), "offset": str(offset)},
+        )
+        controller = apicontrollers.getTransactionListForCustomerController(request)
+        response = self.execute_controller(controller)
+        return response
+
     def _authorizenet_create_payment_profile(
-        self, billing_addr: customerAddressType, payment: paymentType
+        self,
+        billing_addr: apicontractsv1.customerAddressType,
+        payment: apicontractsv1.paymentType,
     ) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.createCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        :param billing_addr: A customer address.
+        :type billing_addr: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param payment: A payment method.
+        :type payment: :py:obj:`~authorizenet.apicontractsv1.paymentType`
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises : If :py:attr:`id` wasn't set.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         request = apicontractsv1.createCustomerPaymentProfileRequest(
             customerProfileId=self.customerProfileId,
             merchantAuthentication=self.merchantAuthentication,
-            paymentProfile=customerPaymentProfileType(
+            paymentProfile=apicontractsv1.customerPaymentProfileType(
                 billTo=billing_addr, payment=payment, defaultPaymentProfile=self.default
             ),
             validationMode=self.validationMode,
@@ -67,6 +112,16 @@ class PaymentProfile(AuthorizenetSubProfileBase):
         return response
 
     def _authorizenet_get_payment_profile(self, issuer_info: bool = False) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        :param issuer_info: Whether or not to include issuer information in the response.
+        :type issuer_info: :py:obj:`bool`
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.getCustomerPaymentProfileRequest(
@@ -80,14 +135,28 @@ class PaymentProfile(AuthorizenetSubProfileBase):
         return response
 
     def _authorizenet_update_payment_profile(
-        self, billing_addr: customerAddressType, payment: paymentType
+        self,
+        billing_addr: apicontractsv1.customerAddressType,
+        payment: apicontractsv1.paymentType,
     ) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.validateCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        :param billing_addr: A customer address.
+        :type billing_addr: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param payment: A payment method.
+        :type payment: :py:obj:`~authorizenet.apicontractsv1.paymentType`
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.updateCustomerPaymentProfileRequest(
             merchantAuthentication=self.merchantAuthentication,
             customerProfileId=self.customerProfileId,
-            paymentProfile=customerPaymentProfileType(
+            paymentProfile=apicontractsv1.customerPaymentProfileType(
                 billTo=billing_addr,
                 payment=payment,
                 defaultPaymentProfile=self.default,
@@ -100,6 +169,14 @@ class PaymentProfile(AuthorizenetSubProfileBase):
         return response
 
     def _authorizenet_validate_payment_profile(self) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.validateCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.validateCustomerPaymentProfileRequest(
@@ -113,6 +190,14 @@ class PaymentProfile(AuthorizenetSubProfileBase):
         return response
 
     def _authorizenet_delete_payment_profile(self) -> dict:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerPaymentProfileRequest` using the Authorizenet API.
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :returns: An Authorizenet API response.
+        :rtype: :py:obj:`dict`
+
+        """
         assert self.id, "'id' was not set."
 
         request = apicontractsv1.deleteCustomerPaymentProfileRequest(

terminusgps/authorizenet/subscriptions.py

@@ -1,54 +1,28 @@
-from authorizenet import apicontractsv1, apicontrollers, apicontrollersbase
-from terminusgps.authorizenet.auth import get_merchant_auth, get_environment
+from authorizenet import apicontractsv1, apicontrollers
 
+from terminusgps.authorizenet.auth import get_merchant_auth
+from terminusgps.authorizenet.utils import ControllerExecutionMixin
 
-class Subscription:
-    def __init__(self, name: str, id: str | int | None = None, **kwargs) -> None:
-        if id is not None and isinstance(id, str) and not id.isdigit():
-            raise ValueError(f"'id' must be a digit, got '{id}'.")
-        self.name = name
-        self.id = str(id if id else self.create(**kwargs))
-
-    @property
-    def merchantAuthentication(self) -> apicontractsv1.merchantAuthenticationType:
-        return get_merchant_auth()
-
-    @property
-    def environment(self) -> str:
-        return get_environment()
-
-    def execute_controller(
-        self, controller: apicontrollersbase.APIOperationBase
-    ) -> dict:
-        """
-        Executes an Authorize.NET controller and returns its response.
-
-        :param controller: An Authorize.NET API controller.
-        :raises ValueError: If the API call fails.
-        :returns: The Authorize.NET API response.
-        :rtype: :py:obj:`dict`
 
-        """
-        controller.setenvironment(self.environment)
-        controller.execute()
-        response = controller.getresponse()
-
-        if response.messages.resultCode != "Ok":
-            raise ValueError(response.messages.message[0]["text"].text)
-        return response
+class Subscription(ControllerExecutionMixin):
+    def __init__(self, id: str | int | None = None, *args, **kwargs) -> None:
+        if id and isinstance(id, str) and not id.isdigit():
+            raise ValueError(f"'id' must be a digit, got '{id}'.")
+        self.id = int(id) if id else self.create(*args, **kwargs)
 
     def create(
         self,
-        schedule: apicontractsv1.paymentScheduleType,
+        name: str,
         amount: str,
+        schedule: apicontractsv1.paymentScheduleType,
         payment: apicontractsv1.paymentType,
         address: apicontractsv1.customerAddressType,
         trial_amount: str = "0.00",
     ) -> int:
         request = apicontractsv1.ARBCreateSubscriptionRequest(
-            merchantAuthentication=self.merchantAuthentication,
+            merchantAuthentication=get_merchant_auth(),
             subscription=apicontractsv1.ARBSubscriptionType(
-                name=self.name,
+                name=name,
                 paymentSchedule=schedule,
                 amount=amount,
                 trialAmount=trial_amount,

terminusgps/authorizenet/utils.py

@@ -0,0 +1,61 @@
+from authorizenet import apicontractsv1, apicontrollers
+from authorizenet.apicontrollersbase import APIOperationBase
+
+from .auth import get_environment, get_merchant_auth
+
+
+class ControllerExecutionError(Exception):
+    """Raised when an Authorizenet API controller fails to execute."""
+
+    def __init__(self, message: str, code: str, *args, **kwargs) -> None:
+        self.code = code
+        super().__init__(message, *args, **kwargs)
+
+    def __str__(self) -> str:
+        return f"{self.code}: {self.message}"
+
+
+class ControllerExecutionMixin:
+    @staticmethod
+    def execute_controller(controller: APIOperationBase) -> dict | None:
+        """
+        Executes an Authorizenet controller and returns its response.
+
+        :param controller: An Authorizenet API controller.
+        :type controller: :py:obj:`~authorizenet.apicontrollersbase.APIOperationBase`
+        :raises ControllerExecutionError: If the API call fails.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
+
+        """
+        controller.setenvironment(get_environment())
+        controller.execute()
+        response = controller.getresponse()
+
+        if response is not None and response.messages.resultCode != "Ok":
+            raise ControllerExecutionError(
+                message=response.messages.message[0]["text"].text,
+                code=response.messages.message[0]["code"].text,
+            )
+        return response
+
+
+def get_customer_profile_ids() -> list[int]:
+    """
+    Returns a list of all customer profile ids in Authorizenet.
+
+    :raises ValueError: If something goes wrong calling the Authorizenet API.
+    :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)
+    controller.execute()
+    response = controller.getresponse()
+
+    if response is not None and response.messages.resultCode != "Ok":
+        raise ValueError(response.messages.message["text"].text)
+    return [int(id) for id in response.ids.getchildren()]

terminusgps/aws/secrets.py

@@ -1,6 +1,7 @@
-import boto3
 import json
 
+import boto3
+
 
 def get_secret(name: str, region: str = "us-east-1") -> dict[str, str]:
     """Logs into the default AWS CLI session and returns a secret value."""

terminusgps/settings.py

@@ -1,6 +1,8 @@
 import os
+import pathlib
 
 DEBUG = True
+BASE_DIR = pathlib.Path(__file__).resolve().parent
 MERCHANT_AUTH_LOGIN_ID = os.getenv("MERCHANT_AUTH_LOGIN_ID")
 MERCHANT_AUTH_TRANSACTION_KEY = os.getenv("MERCHANT_AUTH_TRANSACTION_KEY")
 SECRET_KEY = "xem*6no%8d9%^qzt2f3x3ar-uq4_+7h9myc$t0!+4%bj5us6f)"

terminusgps/wialon/session.py

@@ -1,7 +1,6 @@
 import dataclasses
 import datetime
 import logging
-import threading
 import typing
 
 from django.conf import settings
@@ -80,7 +79,7 @@ class WialonSession:
         :type host: :py:obj:`str`
         :param port: Wialon API host port. Default is ``443``.
         :type port: :py:obj:`int`
-        :param log_level: Severity level at which log messages should be handled. Default is ``20`` (logging.INFO).
+        :param log_level: Logging severity level. Default is ``20`` (logging.INFO).
         :type log_level: :py:obj:`int`
         :returns: Nothing.
         :rtype: :py:obj:`None`
@@ -106,7 +105,7 @@ class WialonSession:
         self.login(self.token)
         return self
 
-    def __exit__(self, *args, **kwargs) -> None:
+    def __exit__(self, exc_type, exc_value, exc_traceback) -> None:
         """Logs out of the session by calling :py:meth:`logout`."""
         self.logout()
 
@@ -324,23 +323,3 @@ class WialonSession:
         self._username = login_response.get("au")
         self._video_service_url = login_response.get("video_service_url")
         self._wsdk_version = login_response.get("wsdk_version")
-
-
-class WialonSessionManager:
-    _instance = None
-    _lock = threading.Lock()
-    _session = None
-
-    def __new__(cls) -> "WialonSessionManager":
-        with cls._lock:
-            if not cls._instance:
-                cls._instance = super().__new__(cls)
-        return cls._instance
-
-    def get_session(
-        self, sid: str | None = None, log_level: int = logging.INFO
-    ) -> WialonSession:
-        with self._lock:
-            if not self._session:
-                self._session = WialonSession(sid=sid, log_level=log_level)
-        return self._session

terminusgps/wialon/utils.py

@@ -2,7 +2,7 @@ import secrets
 import string
 import typing
 
-from terminusgps.wialon import items, flags
+from terminusgps.wialon import flags, items
 from terminusgps.wialon.items.base import WialonBase
 from terminusgps.wialon.session import WialonSession
 
@@ -15,7 +15,7 @@ def get_hw_type_id(name: str, session: WialonSession) -> int | None:
     :type name: :py:obj:`str`
     :param session: A valid Wialon API session.
     :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
-    :raises WialonError: If something goes wrong with Wialon.
+    :raises WialonError: If something goes wrong during a Wialon API call.
     :returns: A Wialon hardware type id, if it was found.
     :rtype: :py:obj:`int` | :py:obj:`None`
 
@@ -34,18 +34,22 @@ def get_hw_type_id(name: str, session: WialonSession) -> int | None:
 
 def get_id_from_imei(imei: str, session: WialonSession) -> str | None:
     """
-    Takes a Wialon unit's IMEI # and returns its unit id, if it exists.
+    Takes a Wialon unit's IMEI # and returns its unit id.
 
-    :param iccid: A unique id.
-    :type iccid: :py:obj:`str`
+    :param imei: A Wialon unit's IMEI #.
+    :type imei: :py:obj:`str`
     :param session: A valid Wialon API session.
     :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
-    :raises WialonError: If something goes wrong with Wialon.
+    :raises ValueError: If ``imei`` contains non-digit characters.
+    :raises WialonError: If something goes wrong during a Wialon API call.
     :returns: A Wialon object id, if it was found.
     :rtype: :py:obj:`str` | :py:obj:`None`
 
     """
-    response = session.wialon_api.core_search_items(
+    if not imei.isdigit():
+        raise ValueError(f"'imei' must be a digit, got '{imei}'.")
+
+    results = session.wialon_api.core_search_items(
         **{
             "spec": {
                 "itemsType": "avl_unit",
@@ -62,8 +66,8 @@ def get_id_from_imei(imei: str, session: WialonSession) -> str | None:
         }
     )
 
-    if response.get("totalItemsCount", 0) == 1:
-        return response["items"][0].get("id")
+    if results.get("totalItemsCount", 0) == 1:
+        return results["items"][0].get("id")
 
 
 def get_id_from_iccid(iccid: str, session: WialonSession) -> str | None:
@@ -76,7 +80,7 @@ def get_id_from_iccid(iccid: str, session: WialonSession) -> str | None:
     :type iccid: :py:obj:`str`
     :param session: A valid Wialon API session.
     :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
-    :raises WialonError: If something goes wrong with Wialon.
+    :raises WialonError: If something goes wrong during a Wialon API call.
     :returns: A Wialon object id, if it was found.
     :rtype: :py:obj:`str` | :py:obj:`None`
 
@@ -96,16 +100,15 @@ def get_wialon_cls(items_type: str) -> typing.Type[WialonBase]:
     """
     match items_type:
         case "user":
-            wialon_cls = items.WialonUser
+            return items.WialonUser
         case "avl_unit":
-            wialon_cls = items.WialonUnit
+            return items.WialonUnit
         case "avl_unit_group":
-            wialon_cls = items.WialonUnitGroup
+            return items.WialonUnitGroup
         case "avl_resource":
-            wialon_cls = items.WialonResource
+            return items.WialonResource
         case _:
-            raise ValueError(f"Invalid items_type '{items_type}'")
-    return wialon_cls
+            raise ValueError(f"Invalid items_type, got '{items_type}'.")
 
 
 def get_vin_info(vin_number: str, session: WialonSession) -> dict:
@@ -123,7 +126,6 @@ def get_vin_info(vin_number: str, session: WialonSession) -> dict:
     response = session.wialon_api.unit_get_vin_info(**{"vin": vin_number}).get(
         "vin_lookup_result"
     )
-
     return (
         {field.get("n"): field.get("v") for field in response.get("pflds")}
         if "error" not in response.keys()
@@ -135,31 +137,38 @@ def is_unique(value: str, session: WialonSession, items_type: str = "avl_unit")
     """
     Determines if the value is unique among Wialon objects of type 'items_type'.
 
-    :param value: A value whose uniqueness is unknown.
+    :param value: A Wialon object name.
     :type value: :py:obj:`str`
     :param session: A valid Wialon API session.
     :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
-    :param items_type: The type of Wialon objects to validate the value against. Default is ``"avl_unit"``.
+    :param items_type: Type of Wialon objects to validate the value against. Default is ``"avl_unit"``.
     :type items_type: :py:obj:`str`
+    :raises WialonError: If something goes wrong during a Wialon API call.
     :returns: Whether or not the value is unique among 'items_type'.
     :rtype: :py:obj:`bool`
 
     """
-    result = session.wialon_api.core_check_unique(
-        **{"type": items_type, "value": value.strip()}
-    ).get("result")
-    return not bool(result)
+    return not bool(
+        session.wialon_api.core_check_unique(
+            **{"type": items_type, "value": value.strip()}
+        ).get("result")
+    )
 
 
 def generate_wialon_password(length: int = 32) -> str:
     """
-    Generates a Wialon compliant password of random characters.
+    Generates a Wialon compliant password between ``8`` and ``64`` characters.
+
+    The generated password will contain:
 
-    Password length can be between ``8`` and ``64`` characters.
+        - At least one uppercase letter.
+        - At least one lowercase letter.
+        - At least one special symbol.
+        - At least three digits.
 
     :param length: Length of the generated password. Default is ``32``.
     :type length: :py:obj:`int`
-    :raises ValueError: If the provided length is invalid.
+    :raises ValueError: If :py:length is less than ``8`` or greater than ``64``.
     :returns: A Wialon compliant password.
     :rtype: :py:obj:`str`
 

terminusgps/opencv/barcodes.py

@@ -1,31 +0,0 @@
-import cv2 as cv
-from pyzbar.pyzbar import decode
-
-
-def read_barcode(filepath: str) -> None:
-    img = cv.imread(filepath)
-    barcodes = decode(img)
-
-    if not barcodes:
-        raise ValueError("No barcodes detected.")
-
-    for barcode in barcodes:
-        (x, y, w, h) = barcode.rect
-        cv.rectangle(img, (x - 10, y - 10), (x + w + 10, y + h + 10), (255, 0, 0), 2)
-
-        print(f"{barcode.data = }")
-        print(f"{barcode.type = }")
-
-    cv.imshow("Image", img)
-    cv.waitKey(0)
-    cv.destroyAllWindows()
-
-
-def main() -> None:
-    filepath = "/home/blake/sift_keypoints.jpg"
-    read_barcode(filepath)
-    return
-
-
-if __name__ == "__main__":
-    main()