python-terminusgps 45.7.0__tar.gz → 45.9.0__tar.gz

{python_terminusgps-45.7.0 → python_terminusgps-45.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 45.7.0
+Version: 45.9.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-45.7.0 → python_terminusgps-45.9.0}/docs/source/authorizenet/index.rst

@@ -28,4 +28,3 @@ Most `Authorizenet API endpoints <https://developer.authorize.net/api/reference/
     constants.rst
     api.rst
     service.rst
-    usage.rst

{python_terminusgps-45.7.0 → python_terminusgps-45.9.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 = "45.6.1"
+release = "45.9.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{python_terminusgps-45.7.0 → python_terminusgps-45.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "45.7.0"
+version = "45.9.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-45.9.0/terminusgps/authorizenet/api/transactions.py

@@ -0,0 +1,201 @@
+from decimal import Decimal
+
+from authorizenet import apicontractsv1, apicontrollers
+from authorizenet.apicontrollersbase import APIOperationBase
+from lxml.objectify import ObjectifiedElement
+
+__all__ = [
+    "charge_credit_card",
+    "authorize_credit_card",
+    "capture_authorized_amount",
+    "refund_credit_card",
+]
+
+
+def build_transaction(
+    amount: Decimal, **kwargs
+) -> apicontractsv1.transactionRequestType:
+    """Returns a transaction element for a transaction request."""
+    transaction_request = apicontractsv1.transactionRequestType()
+    transaction_request.amount = amount
+
+    if payment := kwargs.get("payment"):
+        transaction_request.payment = payment
+    if address := kwargs.get("address"):
+        transaction_request.billTo = address
+    if order := kwargs.get("order"):
+        transaction_request.order = order
+    if customer_data := kwargs.get("customer_data"):
+        transaction_request.customerData = customer_data
+    if settings := kwargs.get("settings"):
+        transaction_request.transactionSettings = settings
+    if line_items := kwargs.get("line_items"):
+        transaction_request.lineItems = line_items
+
+    return transaction_request
+
+
+def charge_credit_card(
+    amount: Decimal,
+    credit_card: apicontractsv1.creditCardType,
+    address: apicontractsv1.customerAddressType,
+    order: apicontractsv1.orderType | None = None,
+    customer_data: apicontractsv1.customerDataType | None = None,
+    settings: apicontractsv1.ArrayOfSetting | None = None,
+    line_items: apicontractsv1.ArrayOfLineItem | None = None,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    """
+    `Charges a credit card <https://developer.authorize.net/api/reference/index.html#payment-transactions-charge-a-credit-card>`_.
+
+    :param amount: Dollar amount to charge.
+    :type amount: ~decimal.Decimal
+    :param credit_card: A credit card.
+    :type credit_card: ~authorizenet.apicontractsv1.creditCardType
+    :param address: A customer address.
+    :type address: ~authorizenet.apicontractsv1.customerAddressType
+    :param order: Order information. Default is :py:obj:`None`.
+    :type order: ~authorizenet.apicontractsv1.orderType | None
+    :param customer_data: Customer data. Default is :py:obj:`None`.
+    :type customer_data: ~authorizenet.apicontractsv1.customerDataType | None
+    :param settings: Transaction settings. Default is :py:obj:`None`.
+    :type settings: ~authorizenet.apicontractsv1.ArrayOfSetting | None
+    :param line_items: An array of line items. Default is :py:obj:`None`.
+    :type line_items: ~authorizenet.apicontractsv1.ArrayOfLineItem | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
+
+    """
+    request = apicontractsv1.createTransactionRequest()
+    payment = apicontractsv1.paymentType()
+    payment.creditCard = credit_card
+    request.transactionRequest = build_transaction(
+        amount=amount,
+        payment=payment,
+        address=address,
+        order=order,
+        customer_data=customer_data,
+        settings=settings,
+        line_items=line_items,
+    )
+
+    request.transactionRequest.transactionType = (
+        apicontractsv1.transactionTypeEnum.authCaptureTransaction
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def authorize_credit_card(
+    amount: Decimal,
+    credit_card: apicontractsv1.creditCardType,
+    address: apicontractsv1.customerAddressType,
+    order: apicontractsv1.orderType | None = None,
+    customer_data: apicontractsv1.customerDataType | None = None,
+    settings: apicontractsv1.ArrayOfSetting | None = None,
+    line_items: apicontractsv1.ArrayOfLineItem | None = None,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    """
+    `Authorizes a credit card <https://developer.authorize.net/api/reference/index.html#payment-transactions-authorize-a-credit-card>`_.
+
+    :param amount: Dollar amount to authorize.
+    :type amount: ~decimal.Decimal
+    :param credit_card: A credit card.
+    :type credit_card: ~authorizenet.apicontractsv1.creditCardType
+    :param address: A customer address.
+    :type address: ~authorizenet.apicontractsv1.customerAddressType
+    :param order: Additional order information. Default is :py:obj:`None`.
+    :type order: ~authorizenet.apicontractsv1.orderType | None
+    :param customer_data: Additional customer data. Default is :py:obj:`None`.
+    :type customer_data: ~authorizenet.apicontractsv1.customerDataType | None
+    :param settings: Transaction settings. Default is :py:obj:`None`.
+    :type settings: ~authorizenet.apicontractsv1.ArrayOfSetting | None
+    :param line_items: An array of line items. Default is :py:obj:`None`.
+    :type line_items: ~authorizenet.apicontractsv1.ArrayOfLineItem | None
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
+
+    """
+    request = apicontractsv1.createTransactionRequest()
+    payment = apicontractsv1.paymentType()
+    payment.creditCard = credit_card
+    request.transactionRequest = build_transaction(
+        amount=amount,
+        payment=payment,
+        address=address,
+        order=order,
+        customer_data=customer_data,
+        settings=settings,
+        line_items=line_items,
+    )
+
+    request.transactionRequest.transactionType = (
+        apicontractsv1.transactionTypeEnum.authOnlyTransaction
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def capture_authorized_amount(
+    amount: Decimal,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    """
+    `Captures a previously authorized amount <https://developer.authorize.net/api/reference/index.html#payment-transactions-capture-a-previously-authorized-amount>`_.
+
+    :param amount: Dollar amount to capture.
+    :type amount: ~decimal.Decimal
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
+
+    """
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = build_transaction(amount)
+    request.transactionRequest.transactionType = (
+        apicontractsv1.transactionTypeEnum.priorAuthCaptureTransaction
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def refund_credit_card(
+    amount: Decimal, credit_card: apicontractsv1.creditCardType
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    """
+    `Refunds a credit card <https://developer.authorize.net/api/reference/index.html#payment-transactions-refund-a-transaction>`_.
+
+    :param amount: Dollar amount to refund.
+    :type amount: ~decimal.Decimal
+    :param credit_card: Destination credit card.
+    :type credit_card: ~authorizenet.apicontractsv1.creditCardType
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
+
+    """
+    request = apicontractsv1.createTransactionRequest()
+    payment = apicontractsv1.paymentType()
+    payment.creditCard = credit_card
+    request.transactionRequest = build_transaction(
+        amount=amount, payment=payment
+    )
+
+    request.transactionRequest.transactionType = (
+        apicontractsv1.transactionTypeEnum.refundTransaction
+    )
+    return request, apicontrollers.createTransactionController
+
+
+def void_transaction(
+    reference_id: str,
+) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
+    """
+    `Voids a transaction <https://developer.authorize.net/api/reference/index.html#payment-transactions-void-a-transaction>`_.
+
+    :param reference_id: Transaction reference id.
+    :type reference_id: str
+    :returns: A tuple containing an Authorizenet API request element and controller class.
+    :rtype: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
+
+    """
+    request = apicontractsv1.createTransactionRequest()
+    request.transactionRequest = apicontractsv1.transactionRequestType()
+    request.transactionRequest.refTransId = reference_id
+    request.transactionRequest.transactionType = (
+        apicontractsv1.transactionTypeEnum.voidTransaction
+    )
+    return request, apicontrollers.createTransactionController

{python_terminusgps-45.7.0 → python_terminusgps-45.9.0}/terminusgps/authorizenet/constants.py

@@ -4,6 +4,21 @@ from django.db import models
 from django.utils.translation import gettext_lazy as _
 
 
+class CreditCardType(models.TextChoices):
+    AMEX = apicontractsv1.cardTypeEnum.AmericanExpress, _("American Express")
+    """American express card."""
+    DINERS = apicontractsv1.cardTypeEnum.DinersClub, _("Diners Club")
+    """Diners club card."""
+    DISCOVER = apicontractsv1.cardTypeEnum.Discover, _("Discover")
+    """Disover card."""
+    JCB = apicontractsv1.cardTypeEnum.JCB, _("JCB")
+    """JCB card."""
+    MASTERCARD = apicontractsv1.cardTypeEnum.MasterCard, _("Mastercard")
+    """Mastercard card."""
+    VISA = apicontractsv1.cardTypeEnum.Visa, _("Visa")
+    """Visa card."""
+
+
 class CurrencyCode(models.TextChoices):
     USD = "USD", _("United States Dollar")
     """US dollar."""

{python_terminusgps-45.7.0 → python_terminusgps-45.9.0}/terminusgps/authorizenet/service.py

@@ -52,8 +52,7 @@ class AuthorizenetService:
 
     def call_api(
         self,
-        request: ObjectifiedElement,
-        controller_cls: type[APIOperationBase],
+        request_tuple: tuple[ObjectifiedElement, type[APIOperationBase]],
         reference_id: str | None = None,
     ) -> ObjectifiedElement:
         """
@@ -61,10 +60,8 @@ class AuthorizenetService:
 
         If ``reference_id`` was provided, it is added to the request before execution.
 
-        :param request: An Authorizenet API request element.
-        :type request: ~lxml.objectify.ObjectifiedElement
-        :param controller_cls: An Authorizenet controller class.
-        :type controller_cls: type[~authorizenet.apicontrollersbase.APIOperationBase]
+        :param request_tuple: A tuple containing an Authorizenet API request contract and a controller class to execute it with.
+        :type request_tuple: tuple[~lxml.objectify.ObjectifiedElement, type[~authorizenet.apicontrollersbase.APIOperationBase]]
         :param reference_id: An optional reference id string for the API call. Default is :py:obj:`None`.
         :type reference_id: str | None
         :raises AuthorizenetControllerExecutionError: If the API call failed.
@@ -72,6 +69,7 @@ class AuthorizenetService:
         :rtype: ~lxml.objectify.ObjectifiedElement
 
         """
+        request, controller_cls = request_tuple[0], request_tuple[1]
         request.merchantAuthentication = self.merchantAuthentication
         if reference_id is not None:
             request.refId = reference_id
@@ -79,8 +77,8 @@ class AuthorizenetService:
         controller = controller_cls(request)
         controller.setenvironment(self.environment)
         controller.execute()
+        response = controller.getresponse()
 
-        response: ObjectifiedElement | None = controller.getresponse()
         if response is None:
             raise AuthorizenetControllerExecutionError(
                 message="No response from the Authorizenet API controller.",

{python_terminusgps-45.7.0 → python_terminusgps-45.9.0}/uv.lock

@@ -142,7 +142,7 @@ wheels = [
 
 [[package]]
 name = "django-stubs"
-version = "5.2.2"
+version = "5.2.5"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "django" },
@@ -150,22 +150,22 @@ dependencies = [
     { name = "types-pyyaml" },
     { name = "typing-extensions" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/bc/27/ab9813da817a29ae69ec92af31ad8fc58ce3c904f23ea604bd3bdd9adc37/django_stubs-5.2.2.tar.gz", hash = "sha256:2a04b510c7a812f88223fd7e6d87fb4ea98717f19c8e5c8b59691d83ad40a8a6", size = 243049 }
+sdist = { url = "https://files.pythonhosted.org/packages/e1/8e/286150f593481c33f54d14efb58d72178f159d57d31043529d38bbc98e2f/django_stubs-5.2.5.tar.gz", hash = "sha256:fc78384e28d8c5292d60983075a5934f644f7c304c25ae2793fc57aa66d5018b", size = 247794 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/55/cb/bb387a1d40691ad54fec2be9e5093becebd63cca0ccb9348cbb27602e1d1/django_stubs-5.2.2-py3-none-any.whl", hash = "sha256:79bd0fdbc78958a8f63e0b062bd9d03f1de539664476c0be62ade5f063c9e41e", size = 485188 },
+    { url = "https://files.pythonhosted.org/packages/2f/02/cdbf7652ef2c9a7a1fed7c279484b7f3806f15b1bb34aec9fef8e8cfacbf/django_stubs-5.2.5-py3-none-any.whl", hash = "sha256:223c1a3324cd4873b7629dec6e9adbe224a94508284c1926b25fddff7a92252b", size = 490196 },
 ]
 
 [[package]]
 name = "django-stubs-ext"
-version = "5.2.2"
+version = "5.2.5"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "django" },
     { name = "typing-extensions" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/fc/06/5e94715d103e6cc72380cb0d0b6682a7d5ad2c366cee478c94d77aad777d/django_stubs_ext-5.2.2.tar.gz", hash = "sha256:d9d151b919fe2438760f5bd938f03e1cb08c84d0651f9e5917f1313907e42683", size = 6244 }
+sdist = { url = "https://files.pythonhosted.org/packages/16/94/c9b8f4c47084a0fa666da9066c36771098101932688adf2c17a40fab79c2/django_stubs_ext-5.2.5.tar.gz", hash = "sha256:ecc628df29d36cede638567c4e33ff485dd7a99f1552ad0cece8c60e9c3a8872", size = 6489 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/4e/38/2903676f97f7902ee31984a06756b0e8836e897f4b617e1a03be4a43eb4f/django_stubs_ext-5.2.2-py3-none-any.whl", hash = "sha256:8833bbe32405a2a0ce168d3f75a87168f61bd16939caf0e8bf173bccbd8a44c5", size = 8816 },
+    { url = "https://files.pythonhosted.org/packages/e0/fe/a85a105fddffadb4a8d50e500caeee87d836b679d51a19d52dfa0cc6c660/django_stubs_ext-5.2.5-py3-none-any.whl", hash = "sha256:9b4b8ac9d32f7e6c304fd05477f8688fae6ed57f6a0f9f4d074f9e55b5a3da14", size = 9310 },
 ]
 
 [[package]]
@@ -298,7 +298,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "45.7.0"
+version = "45.9.0"
 source = { editable = "." }
 dependencies = [
     { name = "authorizenet" },

python_terminusgps-45.7.0/docs/source/authorizenet/usage.rst

@@ -1,6 +0,0 @@
-Usage
-=====
-
-Check the Authorizenet API documentation for expected attributes in each response.
-
-TODO

python_terminusgps-45.7.0/terminusgps/authorizenet/api/transactions.py

@@ -1,100 +0,0 @@
-from decimal import Decimal
-
-from authorizenet import apicontractsv1, apicontrollers
-from authorizenet.apicontrollersbase import APIOperationBase
-from lxml.objectify import ObjectifiedElement
-
-__all__ = []
-
-
-def build_transaction_request(
-    transaction_type: str,
-    amount: Decimal,
-    payment: apicontractsv1.paymentType | None = None,
-    order: apicontractsv1.orderType | None = None,
-    address: apicontractsv1.customerAddressType | None = None,
-    customer_data: apicontractsv1.customerDataType | None = None,
-    settings: apicontractsv1.settingType | None = None,
-    line_items: apicontractsv1.ArrayOfLineItem | None = None,
-) -> apicontractsv1.transactionRequestType:
-    request = apicontractsv1.transactionRequestType()
-    request.transactionType = transaction_type
-    request.amount = amount
-
-    if payment is not None:
-        request.payment = payment
-    if order is not None:
-        request.order = order
-    if address is not None:
-        request.billTo = address
-    if customer_data is not None:
-        request.customer = customer_data
-    if settings is not None:
-        request.transactionSettings = settings
-    if line_items is not None:
-        request.lineItems = line_items
-    return request
-
-
-def charge_credit_card(
-    amount: Decimal,
-    credit_card: apicontractsv1.creditCardType,
-    address: apicontractsv1.customerAddressType,
-    order: apicontractsv1.orderType | None = None,
-    customer_data: apicontractsv1.customerDataType | None = None,
-    settings: apicontractsv1.settingType | None = None,
-) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
-    request = apicontractsv1.createTransactionRequest()
-    request.transactionRequest = build_transaction_request(
-        transaction_type="authCaptureTransaction",
-        amount=amount,
-        payment=apicontractsv1.paymentType(creditCard=credit_card),
-        address=address,
-        order=order,
-        customer_data=customer_data,
-        settings=settings,
-    )
-    return request, apicontrollers.createTransactionController
-
-
-def authorize_credit_card(
-    amount: Decimal,
-    credit_card: apicontractsv1.creditCardType,
-    address: apicontractsv1.customerAddressType,
-    order: apicontractsv1.orderType | None = None,
-    customer_data: apicontractsv1.customerDataType | None = None,
-    settings: apicontractsv1.settingType | None = None,
-) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
-    request = apicontractsv1.createTransactionRequest()
-    request.transactionRequest = build_transaction_request(
-        transaction_type="authOnlyTransaction",
-        amount=amount,
-        payment=apicontractsv1.paymentType(creditCard=credit_card),
-        address=address,
-        order=order,
-        customer_data=customer_data,
-        settings=settings,
-    )
-    return request, apicontrollers.createTransactionController
-
-
-def capture_authorized_amount(
-    amount: Decimal,
-) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
-    request = apicontractsv1.createTransactionRequest()
-    request.transactionRequest = build_transaction_request(
-        transaction_type="priorAuthCaptureTransaction", amount=amount
-    )
-    return request, apicontrollers.createTransactionController
-
-
-def refund_credit_card(
-    amount: Decimal, credit_card: apicontractsv1.creditCardType
-) -> tuple[ObjectifiedElement, type[APIOperationBase]]:
-    request = apicontractsv1.createTransactionRequest()
-    request.transactionRequest = build_transaction_request(
-        transaction_type="refundTransaction",
-        amount=amount,
-        payment=apicontractsv1.paymentType(creditCard=credit_card),
-    )
-    return request, apicontrollers.createTransactionController