python-terminusgps 26.0.0__py3-none-any.whl → 27.0.0__py3-none-any.whl

{python_terminusgps-26.0.0.dist-info → python_terminusgps-27.0.0.dist-info}/METADATA

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

{python_terminusgps-26.0.0.dist-info → python_terminusgps-27.0.0.dist-info}/RECORD

@@ -13,7 +13,6 @@ terminusgps/authorizenet/subscriptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JC
 terminusgps/authorizenet/subscriptions/subscriptions.py,sha256=yg0rZw0Zzm3v7daLPR0PsdfCWBU6RyoE_gNPDBMkCjM,1621
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
-terminusgps/aws/ses.py,sha256=sDca2GjMaZvUt3kUPtGCpcqHiOkij9lMV1ogZofgYUU,2372
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
 terminusgps/twilio/caller.py,sha256=TiQ4f0TDDC35he1M1iSsBM2vutdGriwtV4pc17T--6I,3552
 terminusgps/twilio/validators.py,sha256=nn7CCBTktNjcln6M4MR0ACxEsClgioSu89LRLgIiBZk,1112
@@ -24,14 +23,14 @@ terminusgps/wialon/logger.py,sha256=nUBsaLMaffSaAHGHAM6mFXDzix9hbNecVtA3INVtii8,
 terminusgps/wialon/session.py,sha256=THl88yfVBfRH8daKh1lmLSR8ro8TbyOokHx1Cev-En8,9638
 terminusgps/wialon/utils.py,sha256=QXBksDJlC0_khuJ6n9HEYlUQB9ArM-Pvh-K0xHORvDs,6917
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
-terminusgps/wialon/items/base.py,sha256=5UssVqdAJEReITjh0RKjQ419IS1QA3htjWZAxLXmRbQ,6915
-terminusgps/wialon/items/resource.py,sha256=qmQKEakJa9LH5YkI9-iBDA0hsotc5ctcwdb7kZuXdfQ,14549
-terminusgps/wialon/items/retranslator.py,sha256=8q9EDc92w92MElnHIeEzH3Ra4kiPXrx4t9V5nPDZuRU,3728
-terminusgps/wialon/items/route.py,sha256=PTJx1gmT_PGz7nlSSUS2VzjYD-aAuvkEOIdIFneUSSQ,1148
-terminusgps/wialon/items/unit.py,sha256=Kn2lq6SJNcvlIjKeRIfZfvGNsHZ1xVVwiyI9WKMzE1M,9164
-terminusgps/wialon/items/unit_group.py,sha256=Stp-WfCGbOqcnxV6FU1AKtV7KIxIwCHa0NwhNJfgRoM,5032
-terminusgps/wialon/items/user.py,sha256=INwAibQVmjNNelepQXMfDevgJqMvIjHHgEjAMLRvhB0,7082
-python_terminusgps-26.0.0.dist-info/METADATA,sha256=4sdznR0fg1dw8e55_cdmsmmREF9Ul3KzG3Wggo-yBVo,946
-python_terminusgps-26.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-26.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-26.0.0.dist-info/RECORD,,
+terminusgps/wialon/items/base.py,sha256=GCSzhDc3bk-jltWYNL60BEYCeSNRsPWos5aeFvgye8Y,7208
+terminusgps/wialon/items/resource.py,sha256=vNR6hJmf23RxsqXpDhM0dODbQB8KKTKcy6ncjpEZty8,14610
+terminusgps/wialon/items/retranslator.py,sha256=vauuaLoEdKQF0FnOvJfksmLKsIlxvGZxt80dLTh3SVs,3789
+terminusgps/wialon/items/route.py,sha256=8SzlqNmpYVdt-ZAY--B_KHoDIHgN0Zb7KBsBWAzoz3s,1209
+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.0.0.dist-info/METADATA,sha256=z36oD2rqxZYskS3SuUT3pqdXzt8ZWmIjVL3MUOBhmZs,946
+python_terminusgps-27.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-27.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-27.0.0.dist-info/RECORD,,

terminusgps/wialon/items/base.py

@@ -75,57 +75,49 @@ class WialonBase:
 
         :param new_name: A new name.
         :type new_name: :py:obj:`str`
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.item_update_name(
             **{"itemId": self.id, "name": new_name}
         )
 
-    def add_afield(self, field: tuple[str, str]) -> None:
+    def add_afield(self, key: str, value: str) -> None:
         """
         Adds an admin field to the Wialon object.
 
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
+        :param key: A key (name) for the admin field.
+        :type key: :py:obj:`str`
+        :param value: A value for the admin field.
+        :type value: :py:obj:`str`
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.item_update_admin_field(
-            **{
-                "itemId": self.id,
-                "id": 0,
-                "callMode": "create",
-                "n": field[0],
-                "v": field[1],
-            }
+            **{"itemId": self.id, "id": 0, "callMode": "create", "n": key, "v": value}
         )
 
-    def update_afield(self, field_id: int, field: tuple[str, str]) -> None:
+    def update_afield(self, id: int, key: str, value: str) -> None:
         """
-        Updates an admin field by id to the Wialon object.
+        Updates an admin field by id.
 
-        :param field_id: The admin field id.
-        :type field_id: :py:obj:`int`
-        :param field: A tuple containing the name of the field and the value of the field.
-        :type field: :py:obj:`tuple`
+        :param id: The admin field id.
+        :type id: :py:obj:`int`
+        :param key: A key (name) for the admin field.
+        :type key: :py:obj:`str`
+        :param value: A value for the admin field.
+        :type value: :py:obj:`str`
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.item_update_admin_field(
-            **{
-                "itemId": self.id,
-                "id": field_id,
-                "callMode": "update",
-                "n": field[0],
-                "v": field[1],
-            }
+            **{"itemId": self.id, "id": id, "callMode": "update", "n": key, "v": value}
         )
 
     def add_cfield(self, key: str, value: str) -> None:
@@ -136,11 +128,11 @@ class WialonBase:
         :type key: :py:obj:`str`
         :param value: A value for the custom field.
         :type value: :py:obj:`str`
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.item_update_custom_field(
             **{"itemId": self.id, "id": 0, "callMode": "create", "n": key, "v": value}
         )
@@ -155,6 +147,7 @@ class WialonBase:
         :type field: :py:obj:`str`
         :param field: A value for the custom field.
         :type field: :py:obj:`str`
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -171,6 +164,7 @@ class WialonBase:
         :type key: :py:obj:`str`
         :param value: A value for the custom property.
         :type value: :py:obj:`str`
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
@@ -187,6 +181,7 @@ class WialonBase:
         :type key: :py:obj:`str`
         :param value: A value for the profile field.
         :type value: :py:obj:`str`
+        :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 

terminusgps/wialon/items/resource.py

@@ -34,7 +34,11 @@ class WialonResource(WialonBase):
                 "skipCreatorCheck": int(skip_creator_check),
             }
         )
-        return int(response.get("item", {}).get("id")) if response.get("item") else None
+        return (
+            int(response.get("item", {}).get("id"))
+            if response and response.get("item")
+            else None
+        )
 
     def delete(self) -> None:
         """

terminusgps/wialon/items/retranslator.py

@@ -30,7 +30,11 @@ class WialonRetranslator(WialonBase):
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return int(response.get("item", {}).get("id")) if response.get("item") else None
+        return (
+            int(response.get("item", {}).get("id"))
+            if response and response.get("item")
+            else None
+        )
 
     def update_config(self, new_config: dict) -> None:
         """

terminusgps/wialon/items/route.py

@@ -27,4 +27,8 @@ class WialonRoute(WialonBase):
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return int(response.get("item", {}).get("id")) if response.get("item") else None
+        return (
+            int(response.get("item", {}).get("id"))
+            if response and response.get("item")
+            else None
+        )

terminusgps/wialon/items/unit.py

@@ -36,7 +36,11 @@ class WialonUnit(WialonBase):
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return int(response.get("item", {}).get("id")) if response.get("item") else None
+        return (
+            int(response.get("item", {}).get("id"))
+            if response and response.get("item")
+            else None
+        )
 
     def populate(self) -> None:
         super().populate()
@@ -54,11 +58,16 @@ class WialonUnit(WialonBase):
             self._active = item.get("act", False)
             self._image_uri = item.get("uri")
 
-    def get_position(self) -> dict:
+    def get_position(self) -> dict | None:
         return self.session.wialon_api.core_search_item(
             **{"id": self.id, "flags": flags.DATAFLAG_UNIT_POSITION}
         )
 
+    @property
+    def position(self) -> dict | None:
+        """Current GPS position of the unit."""
+        return self.get_position()
+
     @property
     def exists(self) -> bool:
         """Whether or not the unit exists in Wialon."""
@@ -118,7 +127,6 @@ class WialonUnit(WialonBase):
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.unit_exec_cmd(
             **{
                 "itemId": self.id,
@@ -141,7 +149,6 @@ class WialonUnit(WialonBase):
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.unit_update_access_password(
             **{"itemId": self.id, "accessPassword": password}
         )
@@ -155,7 +162,6 @@ class WialonUnit(WialonBase):
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.unit_set_active(
             **{"itemId": self.id, "active": int(True)}
         )
@@ -169,7 +175,6 @@ class WialonUnit(WialonBase):
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.unit_set_active(
             **{"itemId": self.id, "active": int(False)}
         )
@@ -185,7 +190,6 @@ class WialonUnit(WialonBase):
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.unit_update_phone(
             **{"itemId": self.id, "phoneNumber": quote_plus(phone)}
         )
@@ -201,7 +205,6 @@ class WialonUnit(WialonBase):
         :rtype: :py:obj:`list`
 
         """
-
         phone_numbers: list[str] = []
         phones_0: list[str] | None = self._get_driver_phone_numbers()
         phones_1: list[str] | None = self._get_cfield_phone_numbers()

terminusgps/wialon/items/unit_group.py

@@ -17,7 +17,6 @@ class WialonUnitGroup(WialonBase):
         :rtype: :py:obj:`int` | :py:obj:`None`
 
         """
-
         if isinstance(creator_id, str) and not creator_id.isdigit():
             raise ValueError(f"'creator_id' must be a digit, got '{creator_id}'.")
 
@@ -28,7 +27,11 @@ class WialonUnitGroup(WialonBase):
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return int(response.get("item", {}).get("id")) if response.get("item") else None
+        return (
+            int(response.get("item", {}).get("id"))
+            if response and response.get("item")
+            else None
+        )
 
     def set_items(self, new_items: list[str]) -> None:
         """
@@ -41,7 +44,6 @@ class WialonUnitGroup(WialonBase):
         :rtype: :py:obj:`None`
 
         """
-
         self.session.wialon_api.unit_group_update_units(
             **{"itemId": self.id, "units": new_items}
         )
@@ -115,39 +117,3 @@ class WialonUnitGroup(WialonBase):
             }
         )
         return [unit_id for unit_id in response.get("items")[0].get("u", [])]
-
-
-def main() -> None:
-    import logging
-
-    from django.conf import settings
-    from django.utils import timezone
-
-    from terminusgps.wialon.items import WialonUnit
-    from terminusgps.wialon.session import WialonSession
-    from terminusgps.wialon.utils import get_hw_type_id
-
-    timestamp = f"{timezone.now():%Y_%m_%d_%H:%M:%S}"
-    with WialonSession(log_level=logging.DEBUG) as session:
-        unit = WialonUnit(
-            id=None,
-            session=session,
-            creator_id=settings.WIALON_ADMIN_ID,
-            name=f"test_unit_{timestamp}",
-            hw_type_id=get_hw_type_id("Test HW", session=session),
-        )
-        group = WialonUnitGroup(
-            id=None,
-            session=session,
-            creator_id=settings.WIALON_ADMIN_ID,
-            name=f"test_group_{timestamp}",
-        )
-        group.add_item(unit)
-        print(f"{group.items = }")
-        unit.delete()
-        group.delete()
-    return
-
-
-if __name__ == "__main__":
-    main()

terminusgps/wialon/items/user.py

@@ -32,7 +32,11 @@ class WialonUser(WialonBase):
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return int(response.get("item", {}).get("id")) if response.get("item") else None
+        return (
+            int(response.get("item", {}).get("id"))
+            if response and response.get("item")
+            else None
+        )
 
     def _get_access_response(self, hw_type: str) -> dict:
         """

terminusgps/aws/ses.py

@@ -1,72 +0,0 @@
-import boto3
-import json
-
-
-class SESEmailTemplate:
-    def __init__(self, template_name: str, region_name: str = "us-east-1") -> None:
-        self.name = template_name
-        self.region = region_name
-        self.client = boto3.Session().client(service_name="ses")
-
-    def send(
-        self,
-        from_addr: str,
-        recipients: list[str],
-        replyto_list: list[str],
-        data: dict[str, str],
-        cc_list: list[str] | None = None,
-        bcc_list: list[str] | None = None,
-    ) -> None:
-        destination = self._get_destination(recipients, cc_list, bcc_list)
-        self.client.send_templated_email(
-            **{
-                "Source": from_addr,
-                "Destination": destination,
-                "ReplyToAddresses": replyto_list,
-                "Template": self.name,
-                "TemplateData": json.dumps(data),
-            }
-        )
-
-    def create(self, subject: str, text_content: str, html_content: str) -> None:
-        self.client.create_template(
-            **{
-                "Template": {
-                    "TemplateName": self.name,
-                    "SubjectPart": subject,
-                    "TextPart": text_content,
-                    "HtmlPart": html_content,
-                }
-            }
-        )
-
-    def update(self, subject: str, text_content: str, html_content: str) -> None:
-        self.client.update_template(
-            **{
-                "Template": {
-                    "TemplateName": self.name,
-                    "SubjectPart": subject,
-                    "TextPart": text_content,
-                    "HtmlPart": html_content,
-                }
-            }
-        )
-
-    def test_render(self, data: dict[str, str]) -> str:
-        response = self.client.test_render_template(
-            **{"TemplateName": self.name, "TemplateData": json.dumps(data)}
-        )
-        return response.get("RenderedTemplate")
-
-    def _get_destination(
-        self,
-        recipients: list[str],
-        cc_list: list[str] | None,
-        bcc_list: list[str] | None,
-    ) -> dict[str, list[str]]:
-        destination: dict[str, list[str]] = {"ToAddresses": recipients}
-        if cc_list is not None:
-            destination.update({"CcAddresses": cc_list})
-        if bcc_list is not None:
-            destination.update({"BccAddresses": bcc_list})
-        return destination