python-terminusgps 1.16.0__py3-none-any.whl → 1.18.0__py3-none-any.whl

{python_terminusgps-1.16.0.dist-info → python_terminusgps-1.18.0.dist-info}/METADATA

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

@@ -14,21 +14,22 @@ terminusgps/aws/ses.py,sha256=sDca2GjMaZvUt3kUPtGCpcqHiOkij9lMV1ogZofgYUU,2372
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
 terminusgps/twilio/caller.py,sha256=nHCIwUulo-C_v2orsp6OY0nuJA6YetSkxpMTwrRQ-uA,1831
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/wialon/constants.py,sha256=gaYo_OA2ZYkwTaizmU3cw0e1tVFrHFQbNk-_J_fkGCU,3072
+terminusgps/wialon/constants.py,sha256=upk4Jb3b4BviaMIBTnDbFgYCSTZi-HnjhMfAJkKwfLI,1638
 terminusgps/wialon/errors.py,sha256=Fl8A0peF5HpDdR3y0r3g86-iQ4kQgye3FYQZKGe3T7Y,984
 terminusgps/wialon/flags.py,sha256=-OoH-eZM54yjRqxsAXL8VImdQu_7C0OAxCrFqaCEuko,13510
-terminusgps/wialon/session.py,sha256=VwX-pzqXfe6JNQ9Pn_CXdk9zbrbAER16IkbpeDtYKyQ,11156
-terminusgps/wialon/utils.py,sha256=hJJmH3qYAPXMWVDXnihNNKqm8mLsZ0sSvemOXxWOquI,5974
-terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
-terminusgps/wialon/items/base.py,sha256=-h01V-_Ti8wKi1NF6ooPR_L6VyS474DeSp01oCRzbqw,7075
-terminusgps/wialon/items/notification.py,sha256=wC-KXxW4LhjSLJVzBGPfu5hz1vcIGKnYFMxQQ1JzX0g,1058
-terminusgps/wialon/items/resource.py,sha256=0OWEtbHG4OZEh6aC7Z7ml6W6-Qxwb_HGHspEb3ReG9A,9252
-terminusgps/wialon/items/retranslator.py,sha256=zsQXqOhH1zFe5_e8DROPu60z3v6xPWOEPyMCi2IqJAo,3861
-terminusgps/wialon/items/route.py,sha256=qOHPN_rejwiGqvwWzlwmUIAIyc3lKavCalf8ki66rx0,760
-terminusgps/wialon/items/unit.py,sha256=ufdLnumJ8T2LVbCPYOkzf3z0AiMahQ-y_dI42LiUAT0,7452
-terminusgps/wialon/items/unit_group.py,sha256=XJgdHdMKVdBynOQRfTuZWA7VbCt0WVNDihRl_WHrOCY,4007
-terminusgps/wialon/items/user.py,sha256=CfkM6TRVQArXjCHqjc9qeKCTcu69yA8n9vcQhle6LBw,7094
-python_terminusgps-1.16.0.dist-info/METADATA,sha256=lN1Gw51GXdnEkjuURu8wjTFDZIAJYHNBhKOh2ww0a34,912
-python_terminusgps-1.16.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-1.16.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-1.16.0.dist-info/RECORD,,
+terminusgps/wialon/session.py,sha256=zCM3VXzRn8OhR34_3E45I2dPD9NtmFfKJOwKZzxerOs,10857
+terminusgps/wialon/utils.py,sha256=KeZmV-MEdGOHXrsyn6IIoyX0EgVYiWYjvacXyZVr1u8,6501
+terminusgps/wialon/items/__init__.py,sha256=cfUC5sfVsTwmpgsR-w9wA4ay6_EZYAPgEeuw2k06RJM,256
+terminusgps/wialon/items/base.py,sha256=EAtzlnCvB7WTu3iX1bV1-S9TvwXc-Eez7e0X4TMiK9U,6943
+terminusgps/wialon/items/geofence.py,sha256=auT3QDe3Vmuky9A2gsaMQUbqNqRX8HJGwl1nBXX41zk,1661
+terminusgps/wialon/items/notification.py,sha256=6IrswN6fdEkJErIqtMq45bTl9xVARQw8nokDsy3x1MA,97
+terminusgps/wialon/items/resource.py,sha256=79SwbCyE1zlaoeBfU0erEqvqBAYUC4KAKs8AOLJqflU,9652
+terminusgps/wialon/items/retranslator.py,sha256=8q9EDc92w92MElnHIeEzH3Ra4kiPXrx4t9V5nPDZuRU,3728
+terminusgps/wialon/items/route.py,sha256=PTJx1gmT_PGz7nlSSUS2VzjYD-aAuvkEOIdIFneUSSQ,1148
+terminusgps/wialon/items/unit.py,sha256=PwF7xlpDWI5MpM_u6TmYZjNHWk6TSKM4rJ4OB9CIn4A,7533
+terminusgps/wialon/items/unit_group.py,sha256=xc7zYitPE59_WYS-G857jeIQnQcUAxLBH3X6Y1VDg_8,4089
+terminusgps/wialon/items/user.py,sha256=INwAibQVmjNNelepQXMfDevgJqMvIjHHgEjAMLRvhB0,7082
+python_terminusgps-1.18.0.dist-info/METADATA,sha256=jK5eBo6X_WVCvAoo-CIjkt1qaub2WlN8TXTV5zCALTw,912
+python_terminusgps-1.18.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-1.18.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-1.18.0.dist-info/RECORD,,

terminusgps/wialon/constants.py

@@ -1,42 +1,6 @@
-from django.db import models
-from django.utils.translation import gettext_lazy as _
-
 from terminusgps.wialon import flags
 
-
-class WialonCommandName(models.TextChoices):
-    SUB_BASIC = "Basic", _("Basic Subscription")
-    SUB_STANDARD = "Standard", _("Standard Subscription")
-    SUB_PREMIUM = "Premium", _("Premium Subscription")
-    STARTER_DISABLED = "Starter Disable On", _("Disable Starter")
-    STARTER_ENABLED = "Starter Disable Off", _("Enable Starter")
-    ENABLE = "On", _("Enable")
-    DISABLE = "Off", _("Disable")
-
-
-class WialonCommandType(models.TextChoices):
-    ENGINE_BLOCK = "block_engine", _("Block Engine")
-    ENGINE_UNBLOCK = "unblock_engine", _("Unblock Engine")
-    CUSTOM_MSG = "custom_msg", _("Custom Message")
-    DRIVER_MSG = "driver_msg", _("Message to Driver")
-    DOWNLOAD_MSG = "download_msgs", _("Download messages")
-    QUERY_POS = "query_pos", _("Query Position")
-    QUERY_PHOTO = "query_photo", _("Query Snapshot")
-    OUTPUT_ON = "output_on", _("Activate Output")
-    OUTPUT_OFF = "output_off", _("Deactive Output")
-    SEND_POS = "send_position", _("Send Coordinates")
-    SET_REPORT_INT = "set_report_interval", _("Set Data Transfer Interval")
-    UPLOAD_CFG = "upload_cfg", _("Upload Configuration")
-    UPLOAD_SW = "upload_sw", _("Upload Firmware")
-
-
-class WialonCommandLink(models.TextChoices):
-    AUTO = "", _("Auto")
-    TCP = "tcp", _("TCP")
-    UDP = "udp", _("UDP")
-    VRT = "vrt", _("Virtual")
-    GSM = "gsm", _("SMS")
-
+ACCESSMASK_UNIT_FULL: int = flags.ACCESSFLAG_FULL_ACCESS
 
 ACCESSMASK_UNIT_BASIC: int = sum(
     [
@@ -74,7 +38,6 @@ ACCESSMASK_UNIT_SUPER: int = sum(
     ]
 )
 
-ACCESSMASK_UNIT_FULL: int = flags.ACCESSFLAG_FULL_ACCESS
 
 ACCESSMASK_UNIT_MIGRATION: int = sum(
     [

terminusgps/wialon/items/__init__.py

@@ -1,3 +1,4 @@
+from .notification import WialonNotification
 from .resource import WialonResource
 from .retranslator import WialonRetranslator
 from .route import WialonRoute

terminusgps/wialon/items/base.py

@@ -7,18 +7,13 @@ from terminusgps.wialon.session import WialonSession
 
 class WialonBase:
     def __init__(
-        self,
-        id: str | int | None = None,
-        session: WialonSession | None = None,
-        **kwargs,
+        self, id: str | int | None, session: WialonSession, *args, **kwargs
     ) -> None:
-        if session is None:
-            raise ValueError("A valid Wialon API session is required.")
         if isinstance(id, str) and not id.isdigit():
             raise ValueError(f"'id' must be a digit. Got '{id}'.")
 
         self._session = session
-        self._id = str(id if id else self.create(**kwargs))
+        self._id = str(id if id else self.create(*args, **kwargs))
         self.populate()
 
     def __str__(self) -> str:

terminusgps/wialon/items/geofence.py

@@ -0,0 +1,57 @@
+from django.db import models
+
+from terminusgps.wialon.items.base import WialonBase
+
+
+class WialonGeofence(WialonBase):
+    class WialonGeofenceShape(models.IntegerChoices):
+        LINE = 1
+        POLYGON = 2
+        CIRCLE = 3
+
+    class WialonGeofenceColor(models.IntegerChoices):
+        RED = int("ff0000", 16)
+        ORANGE = int("ff7b00", 16)
+        YELLOW = int("fffb00", 16)
+        GREEN = int("20ff00", 16)
+        BLUE = int("0090ff", 16)
+        PURPLE = int("7000ff", 16)
+        WHITE = int("f3f3f3", 16)
+        BLACK = int("030303", 16)
+
+    def create(
+        self,
+        resource_id: str | int,
+        name: str,
+        xpos: float,
+        ypos: float,
+        desc: str | None = None,
+        shape: int = WialonGeofenceShape.CIRCLE,
+        width: int = 100,
+        flags: int = 0x04,
+        color: int = WialonGeofenceColor.GREEN,
+        text_color: int = WialonGeofenceColor.BLACK,
+        text_size: int = 12,
+        min_zoom: int = 2,
+        max_zoom: int = 19,
+    ) -> int | None:
+        response = self.session.wialon_api.resource_update_zone(
+            **{
+                "itemId": resource_id,
+                "id": 0,
+                "callMode": "create",
+                "n": name,
+                "d": desc if desc else name,
+                "t": shape,
+                "w": width,
+                "f": flags,
+                "c": color,
+                "tc": text_color,
+                "ts": text_size,
+                "min": min_zoom,
+                "max": max_zoom,
+                "p": [{"x": xpos, "y": ypos, "r": width}],
+            }
+        )
+        if response:
+            return int(response[0])

terminusgps/wialon/items/notification.py

@@ -1,33 +1,4 @@
 from terminusgps.wialon.items.base import WialonBase
 
 
-class WialonNotification(WialonBase):
-    def create(
-        self,
-        resource_id: str | int,
-        name: str,
-        activation_time: int,
-        deactivation_time: int,
-        text: str | None = None,
-        max_alarms: int = 0,
-        interval: int = 0,
-        lang: str = "en",
-    ) -> int | None:
-        if isinstance(resource_id, str) and not resource_id.isdigit():
-            raise ValueError(f"'resource_id' must be a digit, got '{resource_id}'.")
-
-        response = self.session.wialon_api.resource_update_notification(
-            **{
-                "itemId": resource_id,
-                "id": 0,
-                "callMode": "create",
-                "n": name,
-                "txt": text if text else name,
-                "ta": activation_time,
-                "td": deactivation_time,
-                "ma": max_alarms,
-                "mmtd": interval,
-                "la": lang,
-            }
-        )
-        return int(response[0].get("id")) if response else None
+class WialonNotification(WialonBase): ...

terminusgps/wialon/items/resource.py

@@ -3,22 +3,31 @@ from terminusgps.wialon.items.base import WialonBase
 
 
 class WialonResource(WialonBase):
-    def create(self, **kwargs) -> int | None:
-        if not kwargs.get("creator_id"):
-            raise ValueError("'creator_id' is required for creation.")
-        if not kwargs.get("name"):
-            raise ValueError("'name' is required for creation.")
-        if not kwargs.get("flags"):
-            kwargs["flags"] = flags.DATAFLAG_UNIT_BASE
+    def create(self, creator_id: str | int, name: str) -> int | None:
+        """
+        Creates a new Wialon resource.
+
+        :param creator_id: A Wialon user id.
+        :type creator_id: :py:obj:`int` | :py:obj:`str`
+        :param name: A name for the resource.
+        :type name: :py:obj:`str`
+        :raises ValueError: If ``creator_id`` is not a digit.
+        :raises WialonError: If something goes wrong with Wialon.
+        :returns: The Wialon id for the new resource, if it was created.
+        :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}'.")
 
         response = self.session.wialon_api.core_create_resource(
             **{
-                "creatorId": kwargs["creator_id"],
-                "name": kwargs["name"],
-                "dataFlags": kwargs["flags"],
+                "creatorId": creator_id,
+                "name": name,
+                "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return response.get("item", {}).get("id")
+        return int(response.get("item", {}).get("id")) if response.get("item") else None
 
     def delete(self) -> None:
         """
@@ -61,7 +70,7 @@ class WialonResource(WialonBase):
         response = self.session.wialon_api.core_search_item(
             **{"id": self.id, "flags": flags.DATAFLAG_RESOURCE_BILLING_PROPERTIES}
         )
-        return response.get("item", {}).get("bact") == self.id
+        return int(response.get("item", {}).get("bact")) == self.id
 
     def is_migrated(self, unit: WialonBase) -> bool:
         """

terminusgps/wialon/items/retranslator.py

@@ -3,13 +3,13 @@ from terminusgps.wialon.items.base import WialonBase
 
 
 class WialonRetranslator(WialonBase):
-    def create(self, **kwargs) -> int | None:
+    def create(self, creator_id: str | int, name: str, config: dict) -> int | None:
         """
         Creates a Wialon retranslator.
 
-        :param creator_id: A Wialon user that will create the retranslator.
-        :type creator_id: :py:obj:`str`
-        :param name: A name for the new retranslator.
+        :param creator_id: A Wialon user id.
+        :type creator_id: :py:obj:`str` | :py:obj:`int`
+        :param name: A name for the retranslator.
         :type name: :py:obj:`str`
         :param config: A Wialon retranslator configuration object.
         :type config: :py:obj:`dict`
@@ -19,22 +19,18 @@ class WialonRetranslator(WialonBase):
         :rtype: :py:obj:`None`
 
         """
-        if not kwargs.get("creator_id"):
-            raise ValueError("'creator_id' is required on creation.")
-        if not kwargs.get("name"):
-            raise ValueError("'name' is required on creation.")
-        if not kwargs.get("config"):
-            raise ValueError("'config' is required on creation.")
+        if isinstance(creator_id, str) and not creator_id.isdigit():
+            raise ValueError(f"'creator_id' must be a digit, got '{creator_id}'.")
 
         response = self.session.wialon_api.core_create_retranslator(
             **{
-                "creatorId": kwargs["creator_id"],
-                "name": kwargs["name"],
-                "config": kwargs["config"],
+                "creatorId": creator_id,
+                "name": name,
+                "config": config,
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return response.get("item", {}).get("id")
+        return int(response.get("item", {}).get("id")) if response.get("item") else None
 
     def update_config(self, new_config: dict) -> None:
         """

terminusgps/wialon/items/route.py

@@ -3,19 +3,28 @@ from terminusgps.wialon.items.base import WialonBase
 
 
 class WialonRoute(WialonBase):
-    def create(self, **kwargs) -> int | None:
-        if not kwargs.get("creator_id"):
-            raise ValueError("'creator_id' is required on creation.")
-        if not kwargs.get("name"):
-            raise ValueError("'name' is required on creation.")
-        if not kwargs.get("flags"):
-            kwargs["flags"] = flags.DATAFLAG_UNIT_BASE
+    def create(self, creator_id: str | int, name: str) -> int | None:
+        """
+        Creates a new Wialon route.
+
+        :param creator_id: A Wialon user id.
+        :type creator_id: :py:obj:`str` | :py:obj:`int`
+        :param name: A name for the route.
+        :type name: :py:obj:`str`
+        :raises ValueError: If ``creator_id`` is not a digit.
+        :raises WialonError: If something goes wrong with Wialon.
+        :returns: The Wialon id for the new route, if it was created.
+        :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}'.")
 
         response = self.session.wialon_api.core_create_route(
             **{
-                "creatorId": kwargs["creator_id"],
-                "name": kwargs["name"],
-                "dataFlags": kwargs["flags"],
+                "creatorId": creator_id,
+                "name": name,
+                "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return response.get("item", {}).get("id")
+        return int(response.get("item", {}).get("id")) if response.get("item") else None

terminusgps/wialon/items/unit.py

@@ -5,36 +5,36 @@ from terminusgps.wialon.items.base import WialonBase
 
 
 class WialonUnit(WialonBase):
-    def create(self, **kwargs) -> int | None:
+    def create(
+        self, creator_id: str | int, name: str, hw_type_id: str | int
+    ) -> int | None:
         """
         Creates a new Wialon unit.
 
         :param creator_id: A Wialon user id.
-        :type creator_id: :py:obj:`int`
-        :param name: A new name for the unit.
+        :type creator_id: :py:obj:`str` | :py:obj:`int`
+        :param name: A name for the unit.
         :type name: :py:obj:`str`
         :param hw_type_id: A Wialon hardware type ID.
-        :type hw_type_id: :py:obj:`str`
+        :type hw_type_id: :py:obj:`str` | :py:obj:`int`
         :returns: The Wialon id for the new unit.
         :rtype: :py:obj:`int` | :py:obj:`None`
 
         """
-        if not kwargs.get("creator_id"):
-            raise ValueError("'creator_id' is required on creation.")
-        if not kwargs.get("name"):
-            raise ValueError("'name' is required on creation.")
-        if not kwargs.get("hw_type_id"):
-            raise ValueError("'hw_type_id' is required on creation.")
+        if isinstance(creator_id, str) and not creator_id.isdigit():
+            raise ValueError(f"'creator_id' must be a digit, got '{creator_id}'.")
+        if isinstance(hw_type_id, str) and not hw_type_id.isdigit():
+            raise ValueError(f"'hw_type_id' must be a digit, got '{hw_type_id}'.")
 
         response = self.session.wialon_api.core_create_unit(
             **{
-                "creatorId": kwargs["creator_id"],
-                "name": kwargs["name"],
-                "hwTypeId": kwargs["hw_type_id"],
+                "creatorId": creator_id,
+                "name": name,
+                "hwTypeId": hw_type_id,
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return response.get("item", {}).get("id")
+        return int(response.get("item", {}).get("id")) if response.get("item") else None
 
     @property
     def available_commands(self) -> dict:

terminusgps/wialon/items/unit_group.py

@@ -4,33 +4,32 @@ from terminusgps.wialon.items.base import WialonBase
 
 
 class WialonUnitGroup(WialonBase):
-    def create(self, **kwargs) -> int | None:
+    def create(self, creator_id: str | int, name: str) -> int | None:
         """
         Creates a new Wialon unit group.
 
         :param creator_id: A Wialon user id.
-        :type creator_id: :py:obj:`int`
+        :type creator_id: :py:obj:`str` | :py:obj:`int`
         :param name: A name for the group.
         :type name: :py:obj:`str`
+        :raises ValueError: If ``creator_id`` is not a digit.
         :raises WialonError: If something goes wrong with Wialon.
-        :returns: The Wialon id for the new group.
+        :returns: The Wialon id for the new group, if it was created.
         :rtype: :py:obj:`int` | :py:obj:`None`
 
         """
 
-        if not kwargs.get("creator_id"):
-            raise ValueError("'creator_id' is required on creation.")
-        if not kwargs.get("name"):
-            raise ValueError("'name' is required on creation.")
+        if isinstance(creator_id, str) and not creator_id.isdigit():
+            raise ValueError(f"'creator_id' must be a digit, got '{creator_id}'.")
 
         response = self.session.wialon_api.core_create_unit_group(
             **{
-                "creatorId": kwargs["creator_id"],
-                "name": kwargs["name"],
+                "creatorId": creator_id,
+                "name": name,
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return response.get("item", {}).get("id")
+        return int(response.get("item", {}).get("id")) if response.get("item") else None
 
     def set_items(self, new_items: list[str]) -> None:
         """

terminusgps/wialon/items/user.py

@@ -5,37 +5,34 @@ from terminusgps.wialon.items.base import WialonBase
 
 
 class WialonUser(WialonBase):
-    def create(self, **kwargs) -> int | None:
+    def create(self, creator_id: str | int, name: str, password: str) -> int | None:
         """
         Creates a new Wialon user.
 
         :param creator_id: A Wialon user id.
-        :type creator_id: :py:obj:`int`
+        :type creator_id: :py:obj:`str` | :py:obj:`int`
         :param name: A name for the user.
         :type name: :py:obj:`str`
-        :param name: A password for the user.
-        :type name: :py:obj:`str`
+        :param password: A password for the user.
+        :type password: :py:obj:`str`
+        :raises ValueError: If ``creator_id`` is not a digit.
         :raises WialonError: If something goes wrong with Wialon.
-        :returns: The Wialon id for the new user.
+        :returns: The Wialon id for the new user, if it was created.
         :rtype: :py:obj:`int` | :py:obj:`None`
 
         """
-        if not kwargs.get("creator_id"):
-            raise ValueError("'creator_id' is required on creation.")
-        if not kwargs.get("name"):
-            raise ValueError("'name' is required on creation.")
-        if not kwargs.get("password"):
-            raise ValueError("'password' is required on creation.")
+        if isinstance(creator_id, str) and not creator_id.isdigit():
+            raise ValueError(f"'creator_id' must be a digit, got '{creator_id}'.")
 
         response = self.session.wialon_api.core_create_user(
             **{
-                "creatorId": kwargs["creator_id"],
-                "name": kwargs["name"],
-                "password": kwargs["password"],
+                "creatorId": creator_id,
+                "name": name,
+                "password": password,
                 "dataFlags": flags.DATAFLAG_UNIT_BASE,
             }
         )
-        return response.get("item", {}).get("id")
+        return int(response.get("item", {}).get("id")) if response.get("item") else None
 
     def _get_access_response(self, hw_type: str) -> dict:
         """

terminusgps/wialon/session.py

@@ -367,16 +367,3 @@ class WialonSessionManager:
             if not self._session:
                 self._session = WialonSession(sid=sid, log_level=log_level)
         return self._session
-
-
-def main() -> None:
-    from terminusgps.wialon.items import WialonUnit
-
-    with WialonSession(log_level=logging.DEBUG) as session:
-        unit = WialonUnit(id="28082258", session=session)
-        unit.add_cfield(("to_number", "+17133049421"))
-    return
-
-
-if __name__ == "__main__":
-    main()

terminusgps/wialon/utils.py

@@ -91,6 +91,29 @@ def get_wialon_cls(items_type: str) -> typing.Type[WialonBase]:
     return wialon_cls
 
 
+def get_vin_info(vin_number: str, session: WialonSession) -> dict:
+    """
+    Retrieves vehicle data from a VIN number.
+
+    :param value: A vehicle's VIN number.
+    :type value: :py:obj:`str`
+    :param session: A valid Wialon API session.
+    :type session: :py:obj:`~terminusgps.wialon.session.WialonSession`
+    :returns: A dictionary of vehicle information, if any was found.
+    :rtype: :py:obj:`dict`
+
+    """
+    response = session.wialon_api.unit_get_vin_info(**{"vin": vin_number}).get(
+        "vin_lookup_result"
+    )
+
+    return (
+        {field.get("n"): field.get("v") for field in response.get("pflds")}
+        if "error" not in response.keys()
+        else {}
+    )
+
+
 def is_unique(value: str, session: WialonSession, items_type: str = "avl_unit") -> bool:
     """
     Determines if the value is unique among Wialon objects of type 'items_type'.
@@ -104,7 +127,6 @@ def is_unique(value: str, session: WialonSession, items_type: str = "avl_unit")
     :returns: Whether or not the value is unique among 'items_type'.
     :rtype: :py:obj:`bool`
 
-
     """
     result = session.wialon_api.core_check_unique(
         **{"type": items_type, "value": value.strip()}
@@ -173,13 +195,3 @@ def gen_wialon_password(length: int = 32) -> str:
         stacklevel=2,
     )
     return generate_wialon_password(length)
-
-
-__all__ = [
-    "get_hw_type_id",
-    "get_id_from_iccid",
-    "get_wialon_cls",
-    "is_unique",
-    "generate_wialon_password",
-    "gen_wialon_password",
-]