python-terminusgps 36.3.1__py3-none-any.whl → 36.4.1__py3-none-any.whl

{python_terminusgps-36.3.1.dist-info → python_terminusgps-36.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 36.3.1
+Version: 36.4.1
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://docs.terminusgps.com
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-36.3.1.dist-info → python_terminusgps-36.4.1.dist-info}/RECORD

@@ -35,13 +35,13 @@ terminusgps/django/tests/test_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJ
 terminusgps/twilio/__init__.py,sha256=dYo41F2jft_eHDWSUtSpKGSRG1bewq_qClqilUJZkYM,33
 terminusgps/twilio/caller.py,sha256=RQax2iZ6SYHiuCvBxXkrooRWQ9J8DwKGAjxa8RYjrLI,5023
 terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/wialon/constants.py,sha256=Ju2XL2A4DPFD-w8NjYqEfnnqregl1luPT0XGhGSUnO8,6316
+terminusgps/wialon/constants.py,sha256=05pLc_0S-x0tT87cQcxOmr8plesjOQxoXfUdjIHwI90,7732
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
 terminusgps/wialon/session.py,sha256=BN8GBfYNIJcjvev9-qOam2Sbkf7EyCoQXTudRrmA3vc,10533
 terminusgps/wialon/utils.py,sha256=SwpcxLPBLy0u3AT84G-Co4wxmhRrPFyW3jo_9O6ICvk,11008
 terminusgps/wialon/validators.py,sha256=j5vrtcfClAzRdRkWTvRRAmrne1t0R6cKkmYdE7fAkSs,4247
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
-terminusgps/wialon/items/base.py,sha256=YpOPxghLYDZmWQZRb64CjwCq_0rTmm83cIYZm2oN5LY,9344
+terminusgps/wialon/items/base.py,sha256=ZhndkcVWTOjsEKe5L0NQsLvvXj2Fs0Xv-qBjjm1Xmpk,10421
 terminusgps/wialon/items/resource.py,sha256=DDnyL_Y5P3DxiirUkQb9y4cokMXZVq3xnfn16Vx8sxk,16992
 terminusgps/wialon/items/retranslator.py,sha256=sVEWrp8q1I-tO_rMTCH7TeQDDbZryIq8d9KVnhYyhH0,3795
 terminusgps/wialon/items/route.py,sha256=amNPKZqgl8pEzKA_XJudnvBPzEsfHTmrC7uF15sZVI4,1216
@@ -52,7 +52,7 @@ terminusgps/wialon/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 terminusgps/wialon/tests/test_items.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/tests/test_session.py,sha256=9mBlYchMo9NeqRIZsmxYzrM1zBHorqu4ooxqSNppLpI,1336
 terminusgps/wialon/tests/test_utils.py,sha256=SK4PxJQGECFnzx_EQeRAQfsQ5_3FLaVcis2W9u_ibuI,1730
-python_terminusgps-36.3.1.dist-info/METADATA,sha256=nT2MtI0nkBDU3LxZHkQ4WjAxpq_0q0bEEFe3gP4s3Cs,1616
-python_terminusgps-36.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-36.3.1.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-36.3.1.dist-info/RECORD,,
+python_terminusgps-36.4.1.dist-info/METADATA,sha256=MoYb6Vwu-FQT8KvAoeNbClAfe1JI4MM5HwFTdfOLPIY,1616
+python_terminusgps-36.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-36.4.1.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-36.4.1.dist-info/RECORD,,

terminusgps/wialon/constants.py

@@ -4,6 +4,56 @@ from typing import override
 from . import flags
 
 
+class WialonProfileField(enum.StrEnum):
+    """
+    Valid profile ids for Wialon objects.
+
+    `Profile field reference <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/item/update_profile_field>`_.
+
+    """
+
+    VEHICLE_CLASS = "vehicle_class"
+    """`Vehicle Type <https://sdk.wialon.com/wiki/en/sidebar/remoteapi/apiref/file/type_library>`_."""
+    VIN = "vin"
+    """Vin number."""
+    REGISTRATION_PLATE = "registration_plate"
+    """Registration plate."""
+    BRAND = "brand"
+    """Brand."""
+    MODEL = "model"
+    """Model."""
+    YEAR = "year"
+    """Year."""
+    COLOR = "color"
+    """Color."""
+    ENGINE_MODEL = "engine_model"
+    """Engine model."""
+    ENGINE_POWER = "engine_power"
+    """Engine power, in kW."""
+    ENGINE_DISPLACEMENT = "engine_displacement"
+    """Engine displacement, in cm."""
+    PRIMARY_FUEL_TYPE = "primary_fuel_type"
+    """Primary fuel type."""
+    CARGO_TYPE = "cargo_type"
+    """Cargo type."""
+    CARRYING_CAPACITY = "carrying_capacity"
+    """Carrying capacity, in tons."""
+    WIDTH = "width"
+    """Width, in mm."""
+    HEIGHT = "height"
+    """Height, in mm."""
+    DEPTH = "depth"
+    """Depth, in mm."""
+    EFFECTIVE_CAPACITY = "effective_capacity"
+    """Effective capacity."""
+    GROSS_VEHICLE_WEIGHT = "gross_vehicle_weight"
+    """Gross vehicle weight."""
+    AXLES = "axles"
+    """Axles."""
+    VEHICLE_TYPE = "vehicle_type"
+    """Comment."""
+
+
 class WialonGeofenceType(enum.IntEnum):
     """
     A type of Wialon geofence.

terminusgps/wialon/items/base.py

@@ -212,6 +212,23 @@ class WialonBase:
             if field["n"] == key:
                 return int(field["id"])
 
+    def update_pfield(self, key: constants.WialonProfileField, value: str) -> None:
+        """
+        Updates a profile field by key.
+
+        :param key: A profile field key (name).
+        :type key: :py:obj:`~terminusgps.wialon.constants.WialonProfileField`
+        :param value: A string.
+        :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_profile_field(
+            **{"itemId": self.id, "n": key.value, "v": value}
+        )
+
     def update_afield(self, key: str, value: str) -> None:
         """
         Updates an admin field by key.
@@ -299,3 +316,17 @@ class WialonBase:
         )
         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 {}
+
+    @property
+    def pfields(self) -> dict[str, str]:
+        """
+        Profile fields for the Wialon object.
+
+        :type: :py:obj:`dict`
+
+        """
+        response = self.session.wialon_api.core_search_item(
+            **{"id": self.id, "flags": flags.DataFlag.UNIT_PROFILE_FIELDS}
+        )
+        fields = response.get("item", {}).get("pflds") if response is not None else {}
+        return {field["n"]: field["v"] for field in fields.values()} if fields else {}