python-terminusgps 37.0.0__tar.gz → 37.1.0__tar.gz

{python_terminusgps-37.0.0 → python_terminusgps-37.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 37.0.0
+Version: 37.1.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
@@ -20,6 +20,8 @@ Requires-Dist: django>=5.1.5
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: matplotlib>=3.10.1
 Requires-Dist: pandas>=2.2.3
+Requires-Dist: pillow-heif>=0.22.0
+Requires-Dist: pillow>=11.2.1
 Requires-Dist: python-wialon>=1.2.4
 Requires-Dist: pyzbar>=0.1.9
 Requires-Dist: twilio>=9.4.5

{python_terminusgps-37.0.0 → python_terminusgps-37.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "37.0.0"
+version = "37.1.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" } ]
@@ -21,6 +21,8 @@ dependencies = [
     "loguru>=0.7.3",
     "matplotlib>=3.10.1",
     "pandas>=2.2.3",
+    "pillow-heif>=0.22.0",
+    "pillow>=11.2.1",
     "python-wialon>=1.2.4",
     "pyzbar>=0.1.9",
     "twilio>=9.4.5",

{python_terminusgps-37.0.0 → python_terminusgps-37.1.0}/terminusgps/authorizenet/controllers.py

@@ -1,3 +1,5 @@
+import typing
+
 from authorizenet.apicontrollersbase import APIOperationBase
 
 from .auth import get_environment
@@ -7,7 +9,9 @@ class AuthorizenetControllerExecutor:
     """Allows objects to use :py:meth:`execute_controller` to execute Authorizenet API controllers."""
 
     @staticmethod
-    def execute_controller(controller: APIOperationBase) -> dict | None:
+    def execute_controller(
+        controller: APIOperationBase,
+    ) -> dict[str, typing.Any] | None:
         """
         Executes an Authorizenet API controller and returns its response.
 

python_terminusgps-37.1.0/terminusgps/authorizenet/items/address_profiles.py

@@ -0,0 +1,126 @@
+import typing
+
+from authorizenet import apicontractsv1, apicontrollers
+
+from .base import AuthorizenetBase
+
+
+class AuthorizenetAddressProfile(AuthorizenetBase):
+    """An Authorizenet address profile."""
+
+    def __init__(self, customerProfileId: int | str, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        if isinstance(customerProfileId, str) and not customerProfileId.isdigit():
+            raise ValueError(
+                f"'customerProfileId' can only contain digits, got '{customerProfileId}'."
+            )
+        self.customerProfileId = customerProfileId
+
+    def _authorizenet_create_customer_shipping_address(
+        self, address: apicontractsv1.customerAddressType, default: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.createCustomerShippingAddressRequest` using the Authorizenet API.
+
+        `createCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-shipping-address>`_
+
+        :param address: A customer address object.
+        :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param default: Whether or not to set the address profile as default.
+        :type default: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: 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.createCustomerShippingAddressRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.address = address
+        request.defaultShippingAddress = str(default).lower()
+
+        return self.execute_controller(
+            apicontrollers.createCustomerShippingAddressController(request)
+        )
+
+    def _authorizenet_get_customer_shipping_address(
+        self,
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerShippingAddressRequest` using the Authorizenet API.
+
+        `getCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-shipping-address>`_
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises AuthorizenetControllerExecutionError: 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, "Address profile id wasn't set."
+
+        request = apicontractsv1.getCustomerShippingAddressRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.customerAddressId = self.id
+
+        return self.execute_controller(
+            apicontrollers.getCustomerShippingAddressController(request)
+        )
+
+    def _authorizenet_update_customer_shipping_address(
+        self, address: apicontractsv1.customerAddressType, default: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.updateCustomerShippingAddress` using the Authorizenet API.
+
+        `updateCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-shipping-address>`_
+
+        :param address: A customer address object.
+        :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
+        :param default: Whether or not to set the address profile as default.
+        :type default: :py:obj:`bool`
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises AuthorizenetControllerExecutionError: 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.updateCustomerShippingAddressRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.address = address
+        request.address.customerAddressId = self.id
+        request.defaultShippingAddress = str(default).lower()
+
+        return self.execute_controller(
+            apicontrollers.updateCustomerShippingAddressController(request)
+        )
+
+    def _authorizenet_delete_customer_shipping_address(
+        self,
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerShippingAddress` using the Authorizenet API.
+
+        `deleteCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-shipping-address>`_
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises AuthorizenetControllerExecutionError: 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, "Address profile id wasn't set."
+
+        request = apicontractsv1.deleteCustomerShippingAddressRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.customerProfileId
+        request.customerAddressId = self.id
+
+        return self.execute_controller(
+            apicontrollers.deleteCustomerShippingAddressController(request)
+        )

python_terminusgps-37.1.0/terminusgps/authorizenet/items/base.py

@@ -0,0 +1,68 @@
+from authorizenet import apicontractsv1
+
+from terminusgps.authorizenet.auth import get_merchant_auth, get_validation_mode
+from terminusgps.authorizenet.controllers import AuthorizenetControllerExecutor
+
+
+class AuthorizenetBase(AuthorizenetControllerExecutor):
+    """Base class for Authorizenet objects."""
+
+    def __init__(self, id: int | str | None = None, *args, **kwargs) -> None:
+        """
+        Sets :py:attr:`id` if provided.
+
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self.id = id
+
+    def __str__(self) -> str:
+        """Returns the object in format: '#<ID>' if :py:attr:`id` is set."""
+        return f"#{self.id}" if self.id else ""
+
+    @property
+    def id(self) -> str | None:
+        """
+        An Authorizenet generated id.
+
+        :type: :py:obj:`str` | :py:obj:`None`
+
+        """
+        return self._id
+
+    @id.setter
+    def id(self, other: int | str | None) -> None:
+        """
+        Sets :py:attr:`id` to ``other``.
+
+        :raises ValueError: If ``other`` was provided as a string containing non-digit characters.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        if isinstance(other, str) and not other.isdigit():
+            raise ValueError(f"'id' can only contain digit characters, got '{other}'.")
+        self._id = str(other) if other is not None else None
+
+    @property
+    def merchantAuthentication(self) -> apicontractsv1.merchantAuthenticationType:
+        """
+        Current merchant authentication object to authenticate Authorizenet API calls.
+
+        :returns: A merchant authentication object.
+        :rtype: :py:obj:`~authorizenet.apicontractsv1.merchantAuthenticationType`
+
+        """
+        return get_merchant_auth()
+
+    @property
+    def validationMode(self) -> str:
+        """
+        Current Authorizenet API validation mode.
+
+        :returns: An Authorizenet API validation mode string.
+        :rtype: :py:obj:`str`
+
+        """
+        return get_validation_mode()

python_terminusgps-37.1.0/terminusgps/authorizenet/items/customer_profiles.py

@@ -0,0 +1,227 @@
+import typing
+
+from authorizenet import apicontractsv1, apicontrollers
+
+from .base import AuthorizenetBase
+
+
+class AuthorizenetCustomerProfile(AuthorizenetBase):
+    """An Authorizenet customer profile."""
+
+    def __init__(self, email: str, merchant_id: str, *args, **kwargs) -> None:
+        """
+        Sets :py:attr:`_email` and :py:attr:`_merchant_id`.
+
+        :param email: An email address.
+        :type email: :py:obj:`str`
+        :param merchant_id: A merchant designated id string.
+        :type merchant_id: :py:obj:`str`
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        super().__init__(*args, **kwargs)
+        self._email = email
+        self._merchant_id = merchant_id
+
+    @property
+    def email(self) -> str:
+        """An email address assigned to the customer profile."""
+        return str(self._email)
+
+    @property
+    def merchant_id(self) -> str:
+        """A merchant designated id assigned to the customer profile."""
+        return str(self._merchant_id)
+
+    @email.setter
+    def email(self, other: str) -> None:
+        """Sets :py:attr:`email` to ``other``."""
+        self._email = str(other)
+
+    @merchant_id.setter
+    def merchant_id(self, other: str) -> None:
+        """Sets :py:attr:`merchant_id` to ``other``."""
+        self._merchant_id = str(other)
+
+    def create(self, desc: str | None = None, validate: bool = False) -> int:
+        """
+        Creates an Authorizenet customer profile and returns its id as an integer.
+
+        If successfully created, sets :py:attr:`id` to the new customer profile id.
+
+        :param desc: An optional customer profile description. Default is :py:obj:`None`
+        :type desc: :py:obj:`str` | :py:obj:`None`
+        :param validate: Whether or not to validate a payment on the new customer profile. Default is :py:obj:`False`.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: A customer profile id integer.
+        :rtype: :py:obj:`int`
+
+        """
+
+        profile = apicontractsv1.customerProfileType()
+        profile.merchantCustomerId = self.merchant_id
+        if desc:
+            profile.description = desc
+
+        response = self._authorizenet_create_customer_profile(profile, validate)
+        profile_id = int(response.customerProfileId)
+        self.id = profile_id
+
+        return profile_id
+
+    def delete(self) -> None:
+        """
+        Deletes the Authorizenet customer profile.
+
+        If successfully deleted, sets :py:attr:`id` to :py:obj:`None`.
+
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+
+        if self.id:
+            self._authorizenet_delete_customer_profile()
+            self._id = None
+
+    def update(self, desc: str | None = None, validate: bool = False) -> None:
+        """
+        Updates the Authorizenet customer profile if :py:attr:`id` is set.
+
+        :param desc: An optional customer profile description. Default is :py:obj:`None`
+        :type desc: :py:obj:`str` | :py:obj:`None`
+        :param validate: Whether or not to validate a payment on the customer profile. Default is :py:obj:`False`.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+
+        if self.id:
+            profile = apicontractsv1.customerProfileExType()
+            profile.customerProfileId = self.id
+            profile.merchantCustomerId = self.merchant_id
+            profile.email = self.email
+            if desc is not None:
+                profile.description = desc
+
+            self._authorizenet_update_customer_profile(profile, validate)
+
+    def _authorizenet_get_customer_profile(
+        self, issuer_info: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.getCustomerProfileRequest` using the Authorizenet API.
+
+        `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_
+
+        :param issuer_info: Whether or not to include issuer information in the response. Default is :py:obj:`False`.
+        :type issuer_info: :py:obj:`bool`
+        :raises AssertionError: If none of :py:attr:`id`, :py:attr:`email` or :py:attr:`merchant_id` were set.
+        :raises AuthorizenetControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: An Authorizenet API response, if any.
+        :rtype: :py:obj:`dict` | :py:obj:`None`
+
+        """
+
+        assert any([self.id, self.email, self.merchant_id]), (
+            "At least one of 'id', 'email' or 'merchant_id' must be set."
+        )
+
+        request = apicontractsv1.getCustomerProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.includeIssuerInfo = str(issuer_info).lower()
+
+        if self.id:
+            request.customerProfileId = self.id
+        if self.email:
+            request.email = self.email
+        if self.merchant_id:
+            request.customerMerchantId = self.merchant_id
+
+        return self.execute_controller(
+            apicontrollers.getCustomerProfileController(request)
+        )
+
+    def _authorizenet_create_customer_profile(
+        self, profile: apicontractsv1.customerProfileType, validate: bool = False
+    ) -> dict[str, typing.Any] | 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 profile: A customer profile object.
+        :type profile: :py:obj:`~authorizenet.apicontractsv1.customerProfileType`
+        :param validate: Whether or not to validate a payment profile for the customer profile. Default is :py:obj:`False`.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: If ``validate`` was :py:obj:`True` but validation was forbidden.
+        :raises AuthorizenetControllerExecutionError: 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()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.profile = profile
+        if validate:
+            request.validationMode = self.validationMode
+
+        return self.execute_controller(
+            apicontrollers.createCustomerProfileController(request)
+        )
+
+    def _authorizenet_update_customer_profile(
+        self, profile: apicontractsv1.customerProfileExType, validate: bool = False
+    ) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.updateCustomerProfileRequest` using the Authorizenet API.
+
+        `updateCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-profile>`_
+
+        :param profile: A customer profile ex object.
+        :type profile: :py:obj:`~authorizenet.apicontractsv1.customerProfileExType`
+        :param validate: Whether or not to validate a payment profile for the customer profile. Default is :py:obj:`False`.
+        :type validate: :py:obj:`bool`
+        :raises AuthorizenetControllerExecutionError: 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.updateCustomerProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.profile = profile
+        if validate:
+            request.validationMode = self.validationMode
+
+        return self.execute_controller(
+            apicontrollers.updateCustomerProfileController(request)
+        )
+
+    def _authorizenet_delete_customer_profile(self) -> dict[str, typing.Any] | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.deleteCustomerProfileRequest` using the Authorizenet 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 AuthorizenetControllerExecutionError: 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, "Customer profile id wasn't set."
+
+        request = apicontractsv1.deleteCustomerProfileRequest()
+        request.merchantAuthentication = self.merchantAuthentication
+        request.customerProfileId = self.id
+
+        return self.execute_controller(
+            apicontrollers.deleteCustomerProfileController(request)
+        )