python-terminusgps 27.3.2__py3-none-any.whl → 28.1.0__py3-none-any.whl

{python_terminusgps-27.3.2.dist-info → python_terminusgps-28.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 27.3.2
+Version: 28.1.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

{python_terminusgps-27.3.2.dist-info → python_terminusgps-28.1.0.dist-info}/RECORD

@@ -4,13 +4,12 @@ terminusgps/authorizenet/__init__.py,sha256=LiGLlWNNiqS7RSOP4Apabx-b9EBYyNbxRY_a
 terminusgps/authorizenet/auth.py,sha256=ICxPPzoUc64VbsIIemEWKrn8xjHGwbNdo2VbtaFCFss,1107
 terminusgps/authorizenet/errors.py,sha256=HG5NwVxQCtOYidVl30y49PC0Ovw5VYdsy9wTgUFMw9M,949
 terminusgps/authorizenet/utils.py,sha256=RQ_R9YEoNGYQNV7vePmNxbYyhf_DImumATyROckX66I,2770
-terminusgps/authorizenet/profiles/__init__.py,sha256=QKjMKcXpCSCEhv6LBCz0yGP8t0VxAyKyYRS4_HLYnxQ,114
+terminusgps/authorizenet/profiles/__init__.py,sha256=IG4XCEEYtHKqXOatlZlob6J3ukAgF7cFR-RXxOSMS1c,161
 terminusgps/authorizenet/profiles/addresses.py,sha256=7yrOrb9kIsiiazgWbeH8v_YUBiWG3Y61g46R3S5DD-k,6592
 terminusgps/authorizenet/profiles/base.py,sha256=TOUHr22QRQBLErdysOkfcpJBusTjrUTqOmWEyNvMacA,2240
 terminusgps/authorizenet/profiles/customers.py,sha256=-F8IsQEn2CyHpfxyVZjKayHSuVe4ENNUj_ck7SE8LO0,8568
 terminusgps/authorizenet/profiles/payments.py,sha256=ohhZrs9MB7GkCi7jQvPVvELNKnR9BwzMd607jJmT4n4,11316
-terminusgps/authorizenet/subscriptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/authorizenet/subscriptions/subscriptions.py,sha256=t1yNGMnfVEhSLMerZmEr479XDgOY-ksqvCn3FNcymVE,1609
+terminusgps/authorizenet/profiles/subscriptions.py,sha256=10Jlt19k-4c2GkG7lfKcRnYk0KUKZsSCgxpdDQQ5RHw,12426
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
@@ -30,7 +29,7 @@ terminusgps/wialon/items/route.py,sha256=8SzlqNmpYVdt-ZAY--B_KHoDIHgN0Zb7KBsBWAz
 terminusgps/wialon/items/unit.py,sha256=i7sQiRu3N0XxyTHVN2RnmjYy9X48KdnZLSB18ic37w8,9363
 terminusgps/wialon/items/unit_group.py,sha256=YsYh34l2DjSKcv5SIZkEVi5FSjveGB1gxU2fwdLyvl4,4101
 terminusgps/wialon/items/user.py,sha256=PFYBie04F16YE2B5364PLxkmlTmQr4sZXpItvRBxsDc,7143
-python_terminusgps-27.3.2.dist-info/METADATA,sha256=yrW36bhrccaYkwU8d1LfDfbEF0wZoW2BdP3IRpu78dI,946
-python_terminusgps-27.3.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-27.3.2.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-27.3.2.dist-info/RECORD,,
+python_terminusgps-28.1.0.dist-info/METADATA,sha256=kEqWCNoPiDseRB3diJNYEnRlLq1cLagusBQTkPtezHc,946
+python_terminusgps-28.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-28.1.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-28.1.0.dist-info/RECORD,,

terminusgps/authorizenet/profiles/__init__.py

@@ -1,3 +1,4 @@
 from .addresses import AddressProfile
 from .customers import CustomerProfile
 from .payments import PaymentProfile
+from .subscriptions import SubscriptionProfile

terminusgps/authorizenet/profiles/subscriptions.py

@@ -0,0 +1,276 @@
+import decimal
+
+from authorizenet import apicontractsv1, apicontrollers
+
+from ..auth import get_merchant_auth
+from ..utils import ControllerExecutionMixin
+
+
+class SubscriptionProfile(ControllerExecutionMixin):
+    """An Authorizenet subscription profile."""
+
+    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,
+        name: str,
+        amount: decimal.Decimal,
+        schedule: apicontractsv1.paymentScheduleType,
+        profile_id: int | str,
+        payment_id: int | str,
+        address_id: int | str,
+        trial_amount: decimal.Decimal = decimal.Decimal(
+            0.00, context=decimal.Context(prec=2, rounding=decimal.ROUND_HALF_UP)
+        ),
+    ) -> int:
+        """
+        Creates a subscription in Authorizenet.
+
+        :param name: A name for the subscription.
+        :type name: :py:obj:`str`
+        :param amount: An amount of money paid per occurrence of the subscription.
+        :type amount: :py:obj:`~decimal.Decimal`
+        :param schedule: A payment schedule for the subscription.
+        :type amount: :py:obj:`~authorizenet.apicontractsv1.paymentScheduleType`
+        :param profile_id: An Authoriznet customer profile id.
+        :type profile_id: :py:obj:`int` | :py:obj:`str`
+        :param payment_id: An Authoriznet customer payment profile id.
+        :type payment_id: :py:obj:`int` | :py:obj:`str`
+        :param address_id: An Authoriznet customer address profile id.
+        :type address_id: :py:obj:`int` | :py:obj:`str`
+        :param trial_amount: Trial amount for the subscription. Default is ``0.00``.
+        :type trial_amount: :py:obj:`~decimal.Decimal`
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :raises ValueError: If ``profile_id`` wasn't a digit.
+        :raises ValueError: If ``payment_id`` wasn't a digit.
+        :raises ValueError: If ``address_id`` wasn't a digit.
+        :raises ValueError: If the Authorizenet API response was not retrieved.
+        :returns: An Authorizenet subscription id.
+        :rtype: :py:obj:`int`
+
+        """
+        if isinstance(profile_id, str) and not profile_id.isdigit():
+            raise ValueError(f"'profile_id' must be a digit, got '{profile_id}'.")
+        if isinstance(payment_id, str) and not payment_id.isdigit():
+            raise ValueError(f"'payment_id' must be a digit, got '{payment_id}'.")
+        if isinstance(address_id, str) and not address_id.isdigit():
+            raise ValueError(f"'address_id' must be a digit, got '{address_id}'.")
+
+        subscription: apicontractsv1.ARBSubscriptionType = (
+            apicontractsv1.ARBSubscriptionType(
+                name=name,
+                paymentSchedule=schedule,
+                amount=amount,
+                trialAmount=trial_amount,
+                profile=apicontractsv1.customerProfileIdType(
+                    customerProfileId=str(profile_id),
+                    customerPaymentProfileId=str(payment_id),
+                    customerAddressId=str(address_id),
+                ),
+            )
+        )
+        response = self._authorizenet_create_subscription(subscription)
+        if response is None:
+            raise ValueError("Failed to retrieve Authorizenet API response.")
+        return int(response.subscriptionId)
+
+    def cancel(self) -> None:
+        """
+        Cancels the subscription.
+
+        :raises AssertionError: If :py:attr:`id` wasn't set.
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
+        """
+        self._authorizenet_cancel_subscription()
+
+    def update(
+        self,
+        name: str,
+        amount: decimal.Decimal,
+        schedule: apicontractsv1.paymentScheduleType,
+        profile_id: int | str,
+        payment_id: int | str,
+        address_id: int | str,
+        trial_amount: decimal.Decimal = decimal.Decimal(
+            0.00, context=decimal.Context(prec=2, rounding=decimal.ROUND_HALF_UP)
+        ),
+    ) -> None:
+        """
+        Updates a subscription in Authorizenet.
+
+        :param name: A name for the subscription.
+        :type name: :py:obj:`str`
+        :param amount: An amount of money paid per occurrence of the subscription.
+        :type amount: :py:obj:`~decimal.Decimal`
+        :param schedule: A payment schedule for the subscription.
+        :type amount: :py:obj:`~authorizenet.apicontractsv1.paymentScheduleType`
+        :param profile_id: An Authoriznet customer profile id.
+        :type profile_id: :py:obj:`int` | :py:obj:`str`
+        :param payment_id: An Authoriznet customer payment profile id.
+        :type payment_id: :py:obj:`int` | :py:obj:`str`
+        :param address_id: An Authoriznet customer address profile id.
+        :type address_id: :py:obj:`int` | :py:obj:`str`
+        :param trial_amount: Trial amount for the subscription. Default is ``0.00``.
+        :type trial_amount: :py:obj:`~decimal.Decimal`
+        :raises ControllerExecutionError: If something goes wrong during an Authorizenet API call.
+        :raises ValueError: If ``profile_id`` wasn't a digit.
+        :raises ValueError: If ``payment_id`` wasn't a digit.
+        :raises ValueError: If ``address_id`` wasn't a digit.
+        :raises ValueError: If the Authorizenet API response was not retrieved.
+        :returns: An Authorizenet subscription id.
+        :rtype: :py:obj:`int`
+
+        """
+        if isinstance(profile_id, str) and not profile_id.isdigit():
+            raise ValueError(f"'profile_id' must be a digit, got '{profile_id}'.")
+        if isinstance(payment_id, str) and not payment_id.isdigit():
+            raise ValueError(f"'payment_id' must be a digit, got '{payment_id}'.")
+        if isinstance(address_id, str) and not address_id.isdigit():
+            raise ValueError(f"'address_id' must be a digit, got '{address_id}'.")
+
+        subscription: apicontractsv1.ARBSubscriptionType = (
+            apicontractsv1.ARBSubscriptionType(
+                name=name,
+                paymentSchedule=schedule,
+                amount=amount,
+                trialAmount=trial_amount,
+                profile=apicontractsv1.customerProfileIdType(
+                    customerProfileId=str(profile_id),
+                    customerPaymentProfileId=str(payment_id),
+                    customerAddressId=str(address_id),
+                ),
+            )
+        )
+        self._authorizenet_update_subscription(subscription)
+
+    @property
+    def merchantAuthentication(self) -> apicontractsv1.merchantAuthenticationType:
+        """Merchant authentication for API calls."""
+        return get_merchant_auth()
+
+    @property
+    def status(self) -> str | None:
+        """Current status of the subscription."""
+        response: dict | None = self._authorizenet_get_subscription_status()
+        return str(response.status) if response else None
+
+    @property
+    def transactions(self) -> list | None:
+        """Transactions for the subscription."""
+        response = self._authorizenet_get_subscription(include_transactions=True)
+        return response.arbTransactions.getchildren() if response else None
+
+    def _authorizenet_create_subscription(
+        self, subscription: apicontractsv1.ARBSubscriptionType
+    ) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.ARBCreateSubscriptionRequest` using the Authorizenet API.
+
+        `ARBCreateSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-create-a-subscription-from-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`
+
+        """
+        request = apicontractsv1.ARBCreateSubscriptionRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            subscription=subscription,
+        )
+        controller = apicontrollers.ARBCreateSubscriptionController(request)
+        return self.execute_controller(controller)
+
+    def _authorizenet_get_subscription(
+        self, include_transactions: bool = False
+    ) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.ARBGetSubscriptionRequest` using the Authorizenet API.
+
+        `ARBGetSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-get-subscription>`_
+
+        :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.ARBGetSubscriptionRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            subscriptionId=self.id,
+            includeTransactions=str(include_transactions).lower(),
+        )
+        controller = apicontrollers.ARBGetSubscriptionController(request)
+        return self.execute_controller(controller)
+
+    def _authorizenet_get_subscription_status(self) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.ARBGetSubscriptionStatusRequest` using the Authorizenet API.
+
+        `ARBGetSubscriptionStatusRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-get-subscription-status>`_
+
+        :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.ARBGetSubscriptionStatusRequest(
+            merchantAuthentication=self.merchantAuthentication, subscriptionId=self.id
+        )
+        controller = apicontrollers.ARBGetSubscriptionStatusController(request)
+        return self.execute_controller(controller)
+
+    def _authorizenet_update_subscription(
+        self, subscription: apicontractsv1.ARBSubscriptionType
+    ) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.ARBUpdateSubscriptionRequest` using the Authorizenet API.
+
+        `ARBUpdateSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-update-a-subscription>`_
+
+        :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.ARBUpdateSubscriptionRequest(
+            merchantAuthentication=self.merchantAuthentication,
+            subscriptionId=self.id,
+            subscription=subscription,
+        )
+        controller = apicontrollers.ARBUpdateSubscriptionController(request)
+        return self.execute_controller(controller)
+
+    def _authorizenet_cancel_subscription(self) -> dict | None:
+        """
+        Executes a :py:obj:`~authorizenet.apicontractsv1.ARBCancelSubscriptionRequest` using the Authorizenet API.
+
+        `ARBCancelSubscriptionRequest <https://developer.authorize.net/api/reference/index.html#recurring-billing-cancel-a-subscription>`_
+
+        :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.ARBCancelSubscriptionRequest(
+            merchantAuthentication=self.merchantAuthentication, subscriptionId=self.id
+        )
+        controller = apicontrollers.ARBCancelSubscriptionController(request)
+        return self.execute_controller(controller)

terminusgps/authorizenet/subscriptions/subscriptions.py

@@ -1,41 +0,0 @@
-from authorizenet import apicontractsv1, apicontrollers
-
-from ..auth import get_merchant_auth
-from ..utils import ControllerExecutionMixin
-
-
-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,
-        name: str,
-        amount: str,
-        schedule: apicontractsv1.paymentScheduleType,
-        profile_id: int | str,
-        payment_id: int | str,
-        address_id: int | str,
-        trial_amount: str = "0.00",
-    ) -> int:
-        request = apicontractsv1.ARBCreateSubscriptionRequest(
-            merchantAuthentication=get_merchant_auth(),
-            subscription=apicontractsv1.ARBSubscriptionType(
-                name=name,
-                paymentSchedule=schedule,
-                amount=amount,
-                trialAmount=trial_amount,
-                profile=apicontractsv1.customerProfileIdType(
-                    customerProfileId=str(profile_id),
-                    customerPaymentProfileId=str(payment_id),
-                    customerAddressId=str(address_id),
-                ),
-            ),
-        )
-        controller = apicontrollers.ARBCreateSubscriptionController(request)
-        response = self.execute_controller(controller)
-        if response is None:
-            raise ValueError("Failed to retrieve Authorizenet API response.")
-        return int(response.subscriptionId)