python-terminusgps 30.0.0__py3-none-any.whl → 31.0.0__py3-none-any.whl

{python_terminusgps-30.0.0.dist-info → python_terminusgps-31.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 30.0.0
+Version: 31.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-30.0.0.dist-info → python_terminusgps-31.0.0.dist-info}/RECORD

@@ -1,7 +1,4 @@
 terminusgps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/mixins.py,sha256=jzs_dH_YDmohH86I3uPnN-66C9OPVXaDPVdRHXA6vdk,940
-terminusgps/settings.py,sha256=vY5yNjyMu-7Ya0bIPWUvrrSLERtxHGdkfeoY4Ul6cP0,613
-terminusgps/utils.py,sha256=SYDQyHA5tTuVwdpZGsCtf0LpTTD0ilRKoxa8StfSTpQ,156
 terminusgps/authorizenet/__init__.py,sha256=LiGLlWNNiqS7RSOP4Apabx-b9EBYyNbxRY_a0mvJoaE,466
 terminusgps/authorizenet/auth.py,sha256=ICxPPzoUc64VbsIIemEWKrn8xjHGwbNdo2VbtaFCFss,1107
 terminusgps/authorizenet/errors.py,sha256=HG5NwVxQCtOYidVl30y49PC0Ovw5VYdsy9wTgUFMw9M,949
@@ -15,25 +12,29 @@ terminusgps/authorizenet/profiles/subscriptions.py,sha256=N4_0kbBBJ0FtKdIydN8FLn
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/connect.py,sha256=TWf2bVz6LqSNQfVD7FKRn3K71VuLOwBj05Gs-9BsROg,693
 terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
+terminusgps/django/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+terminusgps/django/mixins.py,sha256=jzs_dH_YDmohH86I3uPnN-66C9OPVXaDPVdRHXA6vdk,940
+terminusgps/django/settings.py,sha256=vY5yNjyMu-7Ya0bIPWUvrrSLERtxHGdkfeoY4Ul6cP0,613
+terminusgps/django/utils.py,sha256=SYDQyHA5tTuVwdpZGsCtf0LpTTD0ilRKoxa8StfSTpQ,156
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
 terminusgps/twilio/caller.py,sha256=TiQ4f0TDDC35he1M1iSsBM2vutdGriwtV4pc17T--6I,3552
 terminusgps/twilio/validators.py,sha256=nn7CCBTktNjcln6M4MR0ACxEsClgioSu89LRLgIiBZk,1112
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/wialon/constants.py,sha256=5Yj5YflagDaqIYrF2k8QOqyFgmNkXM05647omBTZeDc,5467
+terminusgps/wialon/constants.py,sha256=-fRrvtQuSAJ6hpBJzp_Xa4GDI4LuQbqZ1z1L_QFzZiE,5609
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
 terminusgps/wialon/logger.py,sha256=nUBsaLMaffSaAHGHAM6mFXDzix9hbNecVtA3INVtii8,968
-terminusgps/wialon/session.py,sha256=UUPJFwoN4sUnB9Q7i18pjmBaKFt3wdZ1MZdj68ieO_0,9640
-terminusgps/wialon/utils.py,sha256=E_5OCC9wHhrKEwJv4hkTOqplJ_KmnQ5KlSPOhuXbhcg,8423
+terminusgps/wialon/session.py,sha256=emB0XHJjFObtb6WbttsXZXTeRaPztcbjAV212B_Ssek,9781
+terminusgps/wialon/utils.py,sha256=iRZi4uLk-qqNUXdEIbL-4ibfXh9xvEjXWmdoML9CubQ,10051
 terminusgps/wialon/validators.py,sha256=NNqMhoXn1M_f4Edm6oD8I7lzzXKZSqyZ6n7fR3obWj8,4241
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
-terminusgps/wialon/items/base.py,sha256=EmuTVxI7GdlCCJIwFrw0v55gDuYUWNYZ39O2Yl8K2Mc,7876
+terminusgps/wialon/items/base.py,sha256=4TAsmSQ-pw4mqiuL4_clN_Kvplcze4lZwL9oO1p7gkk,8001
 terminusgps/wialon/items/resource.py,sha256=wfUxACO4OdzT2IdCF9oBmU_7nYiH3Xvs6BripPD5IMI,14622
 terminusgps/wialon/items/retranslator.py,sha256=sVEWrp8q1I-tO_rMTCH7TeQDDbZryIq8d9KVnhYyhH0,3795
 terminusgps/wialon/items/route.py,sha256=amNPKZqgl8pEzKA_XJudnvBPzEsfHTmrC7uF15sZVI4,1216
 terminusgps/wialon/items/unit.py,sha256=ChONjm3wlFSlbNz-yEXziNbbs4LJ70F9-MI2c-p905k,10638
 terminusgps/wialon/items/unit_group.py,sha256=QV2ZZgICaN3n6W1pFIyMLyNKB6KYBsLyKG64i-qXoOg,4113
 terminusgps/wialon/items/user.py,sha256=N30wdejdG7LXrgafdKZH74YArGkX3xpZfTucn3m3aqM,7155
-python_terminusgps-30.0.0.dist-info/METADATA,sha256=vXR-HgsmbNNrCtIUUUVdg-piU6D81zbNRMnL3WSg1Rg,1061
-python_terminusgps-30.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-30.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-30.0.0.dist-info/RECORD,,
+python_terminusgps-31.0.0.dist-info/METADATA,sha256=y4fXM6pCMkZ0znIWvVqoAOzitHrjZDbrhSDPIy06qcE,1061
+python_terminusgps-31.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-31.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-31.0.0.dist-info/RECORD,,

terminusgps/wialon/constants.py

@@ -1,4 +1,5 @@
 import enum
+from typing import override
 
 from . import flags
 
@@ -108,6 +109,10 @@ class WialonItemProperty(enum.StrEnum):
     UNIQUE_ID = "sys_unique_id"
     """Object unique id."""
 
+    @override
+    def __add__(self, other: str) -> str:
+        return ",".join([super().__str__(), str(other)])
+
 
 ACCESSMASK_RESOURCE_BASIC: int = sum(
     [

terminusgps/wialon/items/base.py

@@ -21,10 +21,13 @@ class WialonBase:
     def __str__(self) -> str:
         return str(self.id)
 
+    def __repr__(self) -> str:
+        return f"{type(self).__name__}(id={self.id}, session={self.session.id})"
+
     def populate(self) -> None:
         """Retrieves and saves the latest data for the item from Wialon."""
         response = self.session.wialon_api.core_search_item(
-            **{"id": str(self.id), "flags": flags.DataFlag.UNIT_BASE.value}
+            **{"id": str(self.id), "flags": flags.DataFlag.UNIT_BASE}
         )
         if response is not None:
             item = response.get("item", {})
@@ -106,6 +109,7 @@ class WialonBase:
         self.session.wialon_api.item_update_name(
             **{"itemId": self.id, "name": new_name}
         )
+        self._name = new_name
 
     def add_afield(self, key: str, value: str) -> None:
         """
@@ -228,7 +232,7 @@ class WialonBase:
     def cfields(self) -> dict[str, str]:
         """Custom fields for the Wialon object."""
         response = self.session.wialon_api.core_search_item(
-            **{"id": self.id, "flags": flags.DataFlag.UNIT_CUSTOM_FIELDS.value}
+            **{"id": self.id, "flags": flags.DataFlag.UNIT_CUSTOM_FIELDS}
         )
         fields = response.get("item", {}).get("flds") if response is not None else {}
         return {field["n"]: field["v"] for field in fields.values()} if fields else {}
@@ -237,7 +241,7 @@ class WialonBase:
     def afields(self) -> dict[str, str]:
         """Admin fields for the Wialon object."""
         response = self.session.wialon_api.core_search_item(
-            **{"id": self.id, "flags": flags.DataFlag.UNIT_ADMIN_FIELDS.value}
+            **{"id": self.id, "flags": flags.DataFlag.UNIT_ADMIN_FIELDS}
         )
         fields = response.get("item", {}).get("aflds") if response is not None else {}
         return {field["n"]: field["v"] for field in fields.values()} if fields else {}

terminusgps/wialon/session.py

@@ -98,6 +98,12 @@ class WialonSession:
             logging.getLogger(self.__class__.__name__), level=log_level
         ).get_logger()
 
+    def __str__(self) -> str:
+        return str(self.id)
+
+    def __repr__(self) -> str:
+        return f"{self.__class__}(sid={self.id})"
+
     def __enter__(self) -> "WialonSession":
         """Logs into the Wialon API using a token set in :py:meth:`__init__`."""
         assert self.token, "Wialon API token was not set"

terminusgps/wialon/utils.py

@@ -3,79 +3,119 @@ import string
 import typing
 
 from terminusgps.wialon import constants, flags
+from terminusgps.wialon.items import WialonUnit
+from terminusgps.wialon.items.resource import WialonResource
 from terminusgps.wialon.session import WialonSession
 
 
-def get_units_by_carrier(carrier_name: str, session: WialonSession) -> list[str]:
+def get_carrier_names(session: WialonSession) -> list[str]:
     """
-    Returns a list of all unit ids by telecommunications carrier company name.
+    Returns a list of all telecommunication carrier company names present in Wialon.
+
+    :param session: A valid Wialon API session.
+    :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
+    :returns: A list of telecommunication carrier company names.
+    :rtype: :py:obj:`list`
+
+    """
+    afname: str = constants.WialonItemProperty.ADMIN_FIELD_NAME
+    afval: str = constants.WialonItemProperty.ADMIN_FIELD_VALUE
+    results: dict = session.wialon_api.core_search_items(
+        **{
+            "spec": {
+                "itemsType": constants.WialonItemsType.UNIT,
+                "propName": ",".join([afname, afval]),
+                "propValueMask": "carrier,*",
+                "sortType": ",".join([afname, afval]),
+            },
+            "force": 0,
+            "flags": flags.DataFlag.UNIT_BASE + flags.DataFlag.UNIT_ADMIN_FIELDS,
+            "from": 0,
+            "to": 0,
+        }
+    )
+    carrier_names: list[str] = [
+        field["v"]
+        for item in results.get("items", [{}])
+        for field in item.get("aflds", {}).values()
+        if field["n"] == "carrier" and field["v"]
+    ]
+    return sorted(list(frozenset(carrier_names)))
+
+
+def get_units_by_carrier(
+    carrier_name: str, session: WialonSession
+) -> list[WialonUnit] | None:
+    """
+    Returns a list of all units by telecommunications carrier company name.
 
     :param carrier_name: A telecommunications carrier company name, e.g. ``"US Cell"`` or ``"Conetixx"``.
     :type carrier_name: :py:obj:`str`
     :param session: A valid Wialon API session.
     :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
-    :returns: A list of unit ids.
+    :returns: A list of units, if any were found.
     :rtype: :py:obj:`list`
 
     """
-    property: str = constants.WialonItemProperty.ADMIN_FIELD_NAME_VALUE.value
     results = session.wialon_api.core_search_items(
         **{
             "spec": {
                 "itemsType": "avl_unit",
-                "propName": property,
+                "propName": constants.WialonItemProperty.ADMIN_FIELD_NAME_VALUE,
                 "propValueMask": f"carrier:{carrier_name}",
-                "sortType": property,
+                "sortType": constants.WialonItemProperty.ADMIN_FIELD_NAME_VALUE,
             },
             "force": 0,
-            "flags": flags.DataFlag.UNIT_BASE.value,
+            "flags": flags.DataFlag.UNIT_BASE,
             "from": 0,
             "to": 0,
         }
     )
-    return [item.get("id") for item in results.get("items", [])]
+    if results:
+        return [
+            WialonUnit(id=item.get("id"), session=session)
+            for item in results.get("items", [])
+        ]
 
 
-def get_unit_by_iccid(iccid: str, session: WialonSession) -> str | None:
+def get_unit_by_iccid(iccid: str, session: WialonSession) -> WialonUnit | None:
     """
-    Returns a unit id by iccid (SIM card #).
+    Returns a unit by iccid (SIM card #).
 
     :param iccid: A SIM card #.
     :type iccid: :py:obj:`str`
     :param session: A valid Wialon API session.
     :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
-    :returns: The unit id, if it was found.
-    :rtype: :py:obj:`str` | :py:obj:`None`
+    :returns: The unit, if it was found.
+    :rtype: :py:obj:`~terminusgps.wialon.items.WialonUnit` | :py:obj:`None`
 
     """
-    property: str = constants.WialonItemProperty.ADMIN_FIELD_NAME_VALUE.value
     results = session.wialon_api.core_search_items(
         **{
             "spec": {
                 "itemsType": "avl_unit",
-                "propName": property,
+                "propName": constants.WialonItemProperty.ADMIN_FIELD_NAME_VALUE,
                 "propValueMask": f"iccid:{iccid}",
-                "sortType": property,
+                "sortType": constants.WialonItemProperty.ADMIN_FIELD_NAME_VALUE,
             },
             "force": 0,
-            "flags": flags.DataFlag.UNIT_BASE.value,
+            "flags": flags.DataFlag.UNIT_BASE,
             "from": 0,
             "to": 0,
         }
     )
-    if results.get("totalItemsCount") != 1:
-        raise ValueError(results)
-    return results.get("items", [{}])[0].get("id")
+    if results:
+        return WialonUnit(id=results.get("items", [{}])[0].get("id"), session=session)
 
 
-def get_resources(session: WialonSession) -> list[int] | None:
+def get_resources(session: WialonSession) -> list[WialonResource] | None:
     """
-    Returns a list of all resource ids in Wialon.
+    Returns a list of all resources in Wialon.
 
     :param session: A valid Wialon API session.
     :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
-    :returns: A list of account ids.
-    :rtype: :py:obj:`list`
+    :returns: A list of resources, if found.
+    :rtype: :py:obj:`list` | :py:obj:`None`
 
     """
     results = session.wialon_api.core_search_items(
@@ -95,7 +135,10 @@ def get_resources(session: WialonSession) -> list[int] | None:
         }
     )
     if results:
-        return [int(item.get("id")) for item in results.get("items", [])]
+        return [
+            WialonResource(id=item.get("id"), session=session)
+            for item in results.get("items", [])
+        ]
 
 
 def get_hw_type_id(name: str, session: WialonSession) -> int | None:
@@ -123,7 +166,7 @@ def get_hw_type_id(name: str, session: WialonSession) -> int | None:
     return int(hw_types.get(name)) if name in hw_types.keys() else None
 
 
-def get_unit_by_imei(imei: str, session: WialonSession) -> str | None:
+def get_unit_by_imei(imei: str, session: WialonSession) -> WialonUnit | None:
     """
     Takes a Wialon unit's IMEI # and returns its unit id.
 
@@ -158,7 +201,7 @@ def get_unit_by_imei(imei: str, session: WialonSession) -> str | None:
     )
 
     if results and results.get("totalItemsCount", 0) == 1:
-        return results["items"][0].get("id")
+        return WialonUnit(id=results["items"][0].get("id"), session=session)
 
 
 def get_vin_info(vin_number: str, session: WialonSession) -> dict: