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

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

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

@@ -19,21 +19,21 @@ terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkY
 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=TKUYPs-0-nn-TeeYoARREizOZEBNvbDEzQPxt4kg_6I,9605
 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=99fw7FAHszWkdEzHKbo56z3kQfJJzhPrd6tsANc4fQ8,7986
 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-30.1.0.dist-info/METADATA,sha256=UO4P_9gRSmHL1gV8cKAvDUt3FFEHV5fK1RMbt2JNQCU,1061
+python_terminusgps-30.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-30.1.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-30.1.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,6 +21,9 @@ 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})"
+
     def populate(self) -> None:
         """Retrieves and saves the latest data for the item from Wialon."""
         response = self.session.wialon_api.core_search_item(

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

@@ -6,6 +6,41 @@ from terminusgps.wialon import constants, flags
 from terminusgps.wialon.session import WialonSession
 
 
+def get_carrier_names(session: WialonSession) -> list[str]:
+    """
+    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[str]:
     """
     Returns a list of all unit ids by telecommunications carrier company name.
@@ -18,17 +53,16 @@ def get_units_by_carrier(carrier_name: str, session: WialonSession) -> list[str]
     :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,
         }
@@ -36,7 +70,7 @@ def get_units_by_carrier(carrier_name: str, session: WialonSession) -> list[str]
     return [item.get("id") 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) -> int | None:
     """
     Returns a unit id by iccid (SIM card #).
 
@@ -45,27 +79,24 @@ def get_unit_by_iccid(iccid: str, session: WialonSession) -> str | None:
     :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`
+    :rtype: :py:obj:`int` | :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")
+    return int(results.get("items", [{}])[0].get("id"))
 
 
 def get_resources(session: WialonSession) -> list[int] | None: