python-terminusgps 1.17.1__tar.gz → 1.18.0__tar.gz

{python_terminusgps-1.17.1 → python_terminusgps-1.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 1.17.1
+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.17.1 → python_terminusgps-1.18.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-terminusgps"
-version = "1.17.1"
+version = "1.18.0"
 description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
 readme = "README.md"
 authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]

{python_terminusgps-1.17.1 → python_terminusgps-1.18.0}/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(
     [

{python_terminusgps-1.17.1 → python_terminusgps-1.18.0}/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:

python_terminusgps-1.18.0/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])

{python_terminusgps-1.17.1 → python_terminusgps-1.18.0}/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:
         """

{python_terminusgps-1.17.1 → python_terminusgps-1.18.0}/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:
         """

python_terminusgps-1.18.0/terminusgps/wialon/items/route.py

@@ -0,0 +1,30 @@
+from terminusgps.wialon import flags
+from terminusgps.wialon.items.base import WialonBase
+
+
+class WialonRoute(WialonBase):
+    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": creator_id,
+                "name": name,
+                "dataFlags": flags.DATAFLAG_UNIT_BASE,
+            }
+        )
+        return int(response.get("item", {}).get("id")) if response.get("item") else None

{python_terminusgps-1.17.1 → python_terminusgps-1.18.0}/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:

{python_terminusgps-1.17.1 → python_terminusgps-1.18.0}/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:
         """

{python_terminusgps-1.17.1 → python_terminusgps-1.18.0}/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:
         """

{python_terminusgps-1.17.1 → python_terminusgps-1.18.0}/uv.lock

@@ -504,7 +504,7 @@ wheels = [
 
 [[package]]
 name = "python-terminusgps"
-version = "1.17.1"
+version = "1.18.0"
 source = { editable = "." }
 dependencies = [
     { name = "argparse" },

python_terminusgps-1.17.1/terminusgps/wialon/items/route.py

@@ -1,21 +0,0 @@
-from terminusgps.wialon import flags
-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
-
-        response = self.session.wialon_api.core_create_route(
-            **{
-                "creatorId": kwargs["creator_id"],
-                "name": kwargs["name"],
-                "dataFlags": kwargs["flags"],
-            }
-        )
-        return response.get("item", {}).get("id")