python-terminusgps 45.7.0__py3-none-any.whl → 45.9.0__py3-none-any.whl

{python_terminusgps-45.7.0.dist-info → python_terminusgps-45.9.0.dist-info}/METADATA

@@ -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.dist-info → python_terminusgps-45.9.0.dist-info}/RECORD

@@ -3,14 +3,14 @@ terminusgps/default_settings.py,sha256=7GLW3RlkuTbpj82KSWjcbgf-unEmrPvKCyLci14LG
 terminusgps/mixins.py,sha256=Q9ZJuzpk3d9lDnlVA8ZTVvnZWxB13p08EQ8yVJcztn4,1034
 terminusgps/validators.py,sha256=Mf0c7ku_wTQ7uv4hcLRyz0r2eRjvznIL77LLTE5uJ6E,9152
 terminusgps/authorizenet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/authorizenet/constants.py,sha256=--3DNOw3_gjh2BIEqP3Jel5TvZsdoptYV17B4sg9bK0,2131
-terminusgps/authorizenet/service.py,sha256=MKtudM2vwmBytCneZsQ9PDAX-RO4Ma2sPL6ZwEcHDms,4198
+terminusgps/authorizenet/constants.py,sha256=Bat87PXB-g5_FM0pkAwX2dTHLJ05UAf_xLery4eKmr0,2723
+terminusgps/authorizenet/service.py,sha256=uPqP3Q0-tQ6VqLereF5BNtljmIcChDqL9QfOM4Zzk8U,4216
 terminusgps/authorizenet/api/__init__.py,sha256=VXR4Yco1yz5R-R7vgaH2zTP9VFqzfvvGy_XJVjyb3i0,154
 terminusgps/authorizenet/api/address_profiles.py,sha256=VouUN6dIxlnuE3qEiacFqqDBi_VtwvSbsELqTqFZ0BE,4746
 terminusgps/authorizenet/api/customer_profiles.py,sha256=oya9KMRE10nKLjECTIdanfV_P8-gnNZLE0sYmRYVkgM,4505
 terminusgps/authorizenet/api/payment_profiles.py,sha256=s-telQZXdq6bu5TxWVYv5xBNHWq81ve_hQVrRlqoBb0,8089
 terminusgps/authorizenet/api/subscriptions.py,sha256=VAXKjOHLOfifrixObK6XbiJCmPobkYBzXJQrjtos9LE,4542
-terminusgps/authorizenet/api/transactions.py,sha256=YS674zn_oumWlK5zZrF8Isu0On_MAL8xBU9zUVEGx8E,3686
+terminusgps/authorizenet/api/transactions.py,sha256=zwbUXGxI1wkTXSPG4L4O5Y2fdNgxOrNaak1jwcC9PeM,8531
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/constants.py,sha256=p2BhopeE6lXzjzdzb4ZKOz0rhJQIMUbXLrBy1Yzf57s,13730
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
@@ -27,7 +27,7 @@ terminusgps/wialon/items/route.py,sha256=9hmRBEFRJF3lKukv_y3blZxqxv75YgFCcRALrU6
 terminusgps/wialon/items/unit.py,sha256=B5iuGEghu89SL8KzYLUytYNRa8cogsVtf-bJ_RybPTA,5522
 terminusgps/wialon/items/unit_group.py,sha256=MIR0x5IlTjcnwx8Y9wXLNTql-wwVVj7NCe7dL2vOw4c,2131
 terminusgps/wialon/items/user.py,sha256=CRSICiJ-qzybEO_gXuKyzW5oa2RQeIp0SzX9ARcdME4,5151
-python_terminusgps-45.7.0.dist-info/METADATA,sha256=Algwc2rwWNixwYnpupTI7AaSXiVT9S86s8GGOlqTb5o,938
-python_terminusgps-45.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-45.7.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-45.7.0.dist-info/RECORD,,
+python_terminusgps-45.9.0.dist-info/METADATA,sha256=50tjsYUAHYrQ5ErJf3rdF7r5sjDHadt0MWKL228eTos,938
+python_terminusgps-45.9.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-45.9.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-45.9.0.dist-info/RECORD,,

terminusgps/authorizenet/api/transactions.py

@@ -4,36 +4,35 @@ from authorizenet import apicontractsv1, apicontrollers
 from authorizenet.apicontrollersbase import APIOperationBase
 from lxml.objectify import ObjectifiedElement
 
-__all__ = []
+__all__ = [
+    "charge_credit_card",
+    "authorize_credit_card",
+    "capture_authorized_amount",
+    "refund_credit_card",
+]
 
 
-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,
+def build_transaction(
+    amount: Decimal, **kwargs
 ) -> 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
+    """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(
@@ -42,17 +41,45 @@ def charge_credit_card(
     address: apicontractsv1.customerAddressType,
     order: apicontractsv1.orderType | None = None,
     customer_data: apicontractsv1.customerDataType | None = None,
-    settings: apicontractsv1.settingType | 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()
-    request.transactionRequest = build_transaction_request(
-        transaction_type="authCaptureTransaction",
+    payment = apicontractsv1.paymentType()
+    payment.creditCard = credit_card
+    request.transactionRequest = build_transaction(
         amount=amount,
-        payment=apicontractsv1.paymentType(creditCard=credit_card),
+        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
 
@@ -63,17 +90,45 @@ def authorize_credit_card(
     address: apicontractsv1.customerAddressType,
     order: apicontractsv1.orderType | None = None,
     customer_data: apicontractsv1.customerDataType | None = None,
-    settings: apicontractsv1.settingType | 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()
-    request.transactionRequest = build_transaction_request(
-        transaction_type="authOnlyTransaction",
+    payment = apicontractsv1.paymentType()
+    payment.creditCard = credit_card
+    request.transactionRequest = build_transaction(
         amount=amount,
-        payment=apicontractsv1.paymentType(creditCard=credit_card),
+        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
 
@@ -81,9 +136,19 @@ def authorize_credit_card(
 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_request(
-        transaction_type="priorAuthCaptureTransaction", amount=amount
+    request.transactionRequest = build_transaction(amount)
+    request.transactionRequest.transactionType = (
+        apicontractsv1.transactionTypeEnum.priorAuthCaptureTransaction
     )
     return request, apicontrollers.createTransactionController
 
@@ -91,10 +156,46 @@ def capture_authorized_amount(
 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()
-    request.transactionRequest = build_transaction_request(
-        transaction_type="refundTransaction",
-        amount=amount,
-        payment=apicontractsv1.paymentType(creditCard=credit_card),
+    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

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."""

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.",