layrz-sdk 4.0.11__py3-none-any.whl → 4.1.8__py3-none-any.whl

layrz_sdk/entities/telemetry/assetmessage.py

@@ -1,13 +1,10 @@
-"""Asset message"""
-
 from __future__ import annotations
 
-import json
 from datetime import datetime, timedelta
 from typing import Any, Self, cast
 
 from geopy.distance import geodesic
-from pydantic import BaseModel, Field, field_serializer
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 from shapely.geometry import MultiPoint
 
 from layrz_sdk.constants import UTC
@@ -21,15 +18,17 @@ from layrz_sdk.entities.telemetry.devicemessage import DeviceMessage
 class AssetMessage(BaseModel):
   """Asset message model"""
 
-  model_config = {
-    'json_encoders': {
-      datetime: lambda v: v.timestamp(),
-      timedelta: lambda v: v.total_seconds(),
-      Position: lambda v: json.loads(v.model_dump_json(exclude_none=True)),
-    }
-  }
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
 
-  pk: int | None = Field(default=None, description='Message ID', alias='id')
+  pk: int | None = Field(
+    default=None,
+    description='Message ID',
+    alias='id',
+  )
   asset_id: int = Field(..., description='Asset ID')
 
   position: dict[str, float | int] = Field(
@@ -62,7 +61,7 @@ class AssetMessage(BaseModel):
     description='Timestamp when the message was received',
   )
 
-  @field_serializer('received_at')
+  @field_serializer('received_at', when_used='always')
   def serialize_received_at(self: Self, value: datetime) -> float:
     """Serialize received_at to a timestamp."""
     return value.timestamp()
@@ -72,7 +71,7 @@ class AssetMessage(BaseModel):
     description='Elapsed time since the last message',
   )
 
-  @field_serializer('elapsed_time')
+  @field_serializer('elapsed_time', when_used='always')
   def serialize_elapsed_time(self: Self, value: timedelta) -> float:
     """Serialize elapsed_time to total seconds."""
     return value.total_seconds()
@@ -153,7 +152,7 @@ class AssetMessage(BaseModel):
   def to_message(self: Self) -> Message:
     """Convert the asset message to a Message object."""
     return Message(
-      id=self.pk if self.pk is not None else 0,
+      id=self.pk if self.pk is not None else 0,  # ty: ignore
       asset_id=self.asset_id,
       position=Position.model_validate(self.position),
       payload=self.payload,

layrz_sdk/entities/telemetry/devicemessage.py

@@ -1,12 +1,9 @@
-"""Device message"""
-
 from __future__ import annotations
 
-import json
 from datetime import datetime
 from typing import Any, Self
 
-from pydantic import BaseModel, Field, field_serializer
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from layrz_sdk.constants import REJECTED_KEYS, UTC
 from layrz_sdk.entities.device import Device
@@ -17,7 +14,16 @@ from layrz_sdk.entities.position import Position
 class DeviceMessage(BaseModel):
   """Device message model"""
 
-  pk: int | None = Field(default=None, description='Device message ID', alias='id')
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+  pk: int | None = Field(
+    default=None,
+    description='Device message ID',
+    alias='id',
+  )
   ident: str = Field(..., description='Device identifier')
   device_id: int = Field(..., description='Device ID')
   protocol_id: int = Field(..., description='Protocol ID')
@@ -37,7 +43,7 @@ class DeviceMessage(BaseModel):
     description='Timestamp when the message was received',
   )
 
-  @field_serializer('received_at')
+  @field_serializer('received_at', when_used='always')
   def serialize_received_at(self: Self, value: datetime) -> float:
     """Serialize received_at to a timestamp."""
     return value.timestamp()
@@ -69,6 +75,9 @@ class DeviceMessage(BaseModel):
   @classmethod
   def parse_from_dict(cls, *, raw_payload: dict[str, Any], device: Device) -> DeviceMessage:
     """Format a DeviceMessage from a dictionary."""
+    if not device.protocol_id:
+      raise ValueError('Device protocol_id is required to parse DeviceMessage')
+
     received_at: datetime
     position: dict[str, float | int] = {}
     payload: dict[str, Any] = {}
@@ -80,7 +89,8 @@ class DeviceMessage(BaseModel):
 
     for key, value in raw_payload.items():
       if key.startswith('position.'):
-        position[key[9:]] = value
+        if isinstance(value, (float, int)):
+          position[key[9:]] = value
 
       if key not in REJECTED_KEYS:
         payload[key] = value
@@ -88,7 +98,7 @@ class DeviceMessage(BaseModel):
     return cls(
       ident=device.ident,
       device_id=device.pk,
-      protocol_id=device.protocol_id,  # type: ignore
+      protocol_id=device.protocol_id,
       position=position,
       payload=payload,
       received_at=received_at,
@@ -97,7 +107,7 @@ class DeviceMessage(BaseModel):
   def to_message(self: Self) -> Message:
     """Convert the asset message to a Message object."""
     return Message(
-      id=self.pk if self.pk is not None else 0,
+      id=self.pk if self.pk is not None else 0,  # ty: ignore
       asset_id=self.device_id if self.device_id is not None else 0,
       position=Position.model_validate(self.position),
       payload=self.payload,

layrz_sdk/entities/text_alignment.py

@@ -1,5 +1,3 @@
-"""Text alignment"""
-
 from enum import StrEnum
 from typing import Self
 

layrz_sdk/entities/timezone.py

@@ -1,11 +1,19 @@
-"""Timezone entity"""
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class Timezone(BaseModel):
   """Timezone entity"""
 
-  pk: int = Field(..., description='Defines the primary key of the timezone', alias='id')
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  pk: int = Field(
+    ...,
+    description='Defines the primary key of the timezone',
+    alias='id',
+  )
   name: str = Field(..., description='Defines the name of the timezone')
   offset: int = Field(..., description='Defines the offset of the timezone in seconds from UTC')

layrz_sdk/entities/trigger.py

@@ -3,7 +3,7 @@
 from datetime import time, timedelta
 from typing import Any
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
 
 from .trigger_kind import TriggerCaseKind, TriggerCommentPattern, TriggerGeofenceKind, TriggerKind
 from .weekday import Weekday
@@ -12,18 +12,16 @@ from .weekday import Weekday
 class Trigger(BaseModel):
   """Trigger entity"""
 
-  model_config = {
-    'json_encoders': {
-      timedelta: lambda v: v.total_seconds(),
-      TriggerCaseKind: lambda v: v.value,
-      TriggerGeofenceKind: lambda v: v.value,
-      TriggerKind: lambda v: v.value,
-      TriggerCommentPattern: lambda v: v.value,
-      Weekday: lambda v: v.value,
-    },
-  }
-
-  pk: int = Field(description='Defines the primary key of the trigger', alias='id')
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  pk: int = Field(
+    description='Defines the primary key of the trigger',
+    alias='id',
+  )
   name: str = Field(description='Defines the name of the trigger')
   code: str = Field(description='Defines the code of the trigger')
 
@@ -32,27 +30,48 @@ class Trigger(BaseModel):
     description='Defines the cooldown time of the trigger',
   )
 
+  @field_serializer('cooldown_time', when_used='always')
+  def serialize_cooldown_time(self, value: timedelta) -> float:
+    """Serialize cooldown_time to total seconds."""
+    return value.total_seconds()
+
   type_: TriggerKind | None = Field(
     default=None,
     description='Defines the kind of the trigger',
     alias='type',
   )
 
+  @field_serializer('type_', when_used='always')
+  def serialize_type(self, value: TriggerKind | None) -> str | None:
+    return value.value if value else None
+
   presence_type: TriggerGeofenceKind | None = Field(
     default=None,
     description='Defines the geofence kind of the trigger',
   )
 
+  @field_serializer('presence_type', when_used='always')
+  def serialize_presence_type(self, value: TriggerGeofenceKind | None) -> str | None:
+    return value.value if value else None
+
   case_type: TriggerCaseKind | None = Field(
     default=None,
     description='Defines the case kind of the trigger',
   )
 
+  @field_serializer('case_type', when_used='always')
+  def serialize_case_type(self, value: TriggerCaseKind | None) -> str | None:
+    return value.value if value else None
+
   case_comment_pattern: TriggerCommentPattern | None = Field(
     default=None,
     description='Defines the comment pattern of the trigger',
   )
 
+  @field_serializer('case_comment_pattern', when_used='always')
+  def serialize_case_comment_pattern(self, value: TriggerCommentPattern | None) -> str | None:
+    return value.value if value else None
+
   case_comment_value: str | None = Field(
     default=None,
     description='Defines the comment pattern value of the trigger',
@@ -72,6 +91,10 @@ class Trigger(BaseModel):
     description='Defines the weekdays of the trigger',
   )
 
+  @field_serializer('weekdays', when_used='always')
+  def serialize_weekdays(self, value: list[Weekday]) -> list[str]:
+    return [day.value for day in value]
+
   is_plain_crontab: bool = Field(
     default=False,
     description='Defines if the trigger is a plain crontab',
@@ -94,10 +117,7 @@ class Trigger(BaseModel):
 
   @field_validator('manual_action_fields', mode='before')
   def validate_manual_action_fields(cls, value: Any) -> list[dict[str, Any]]:
-    """Ensure manual_action_fields is a list of dictionaries."""
-    if isinstance(value, list):
-      return value
-    return []
+    return value if isinstance(value, list) else []
 
   formula: str | None = Field(
     default=None,
@@ -145,8 +165,73 @@ class Trigger(BaseModel):
     default=None,
     description='Defines the care protocol ID of the trigger',
   )
+  has_case_expirity: bool = Field(
+    default=False,
+    description='Defines if the trigger has case expiry',
+  )
+
+  when_case_expires_delta: timedelta | None = Field(
+    default=None,
+    description='Defines when the trigger expires delta',
+  )
+
+  @field_serializer('when_case_expires_delta', when_used='always')
+  def serialize_when_case_expires_delta(self, value: timedelta | None) -> float | None:
+    return value.total_seconds() if value else None
+
+  should_stack: bool = Field(
+    default=False,
+    description='Defines if the trigger cases should stack',
+  )
+  stack_upper_limit: int | None = Field(
+    default=None,
+    description='Defines the stack upper limit of the trigger cases. None means no limit',
+  )
 
   owner_id: int | None = Field(
     default=None,
     description='Owner ID',
   )
+
+  search_time_delta: timedelta | None = Field(
+    default=None,
+    description='Defines the search time delta of the trigger',
+  )
+
+  @field_serializer('search_time_delta', when_used='always')
+  def serialize_search_time_delta(self, value: timedelta | None) -> float | None:
+    return value.total_seconds() if value else None
+
+  is_paused: bool = Field(
+    default=False,
+    description='Defines if the trigger is paused',
+  )
+
+  should_generate_locator: bool = Field(
+    default=False,
+    description='Defines if the trigger should generate a locator',
+  )
+
+  locator_expires_delta: timedelta | None = Field(
+    default=None,
+    description='Defines the locator expires delta of the trigger',
+  )
+
+  @field_serializer('locator_expires_delta', when_used='always')
+  def serialize_locator_expires_delta(self, value: timedelta | None) -> float | None:
+    return value.total_seconds() if value else None
+
+  locator_expires_triggers_ids: list[int] = Field(
+    default_factory=list,
+    description='Defines the locator expires triggers IDs of the trigger',
+  )
+
+  locator_geofences_ids: list[int] = Field(
+    default_factory=list,
+    description='Defines the locator geofences IDs of the trigger',
+  )
+
+  locator_customization_id: int | None = Field(
+    default=None,
+    description='Defines the locator customization ID of the trigger',
+  )

layrz_sdk/entities/trigger_kind.py

@@ -1,13 +1,9 @@
-"""Asset Operation Mode"""
-
 from enum import StrEnum
 from typing import Self
 
 
 class TriggerKind(StrEnum):
-  """
-  Trigger Kind definition
-  """
+  """Trigger Kind definition"""
 
   PRESENCE_IN_GEOFENCE = 'PRESENCEINGEOFENCE'
   EXACT_TIME = 'EXACTTIME'
@@ -18,6 +14,7 @@ class TriggerKind(StrEnum):
   BHS_SPEEDING = 'BHS_SPEEDING'
   BHS_PRESENCE = 'BHS_PRESENCE'
   MANUAL_ACTION = 'MANUAL_ACTION'
+  NESTED = 'NESTED_TRIGGERS'
 
   def __str__(self: Self) -> str:
     """Readable property"""

layrz_sdk/entities/user.py

@@ -1,10 +1,17 @@
-"""User entity"""
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class User(BaseModel):
   """User entity"""
 
-  pk: int = Field(description='Defines the primary key of the user', alias='id')
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  pk: int = Field(
+    description='Defines the primary key of the user',
+    alias='id',
+  )
   name: str = Field(description='Defines the name of the user')

layrz_sdk/entities/waypoint.py

@@ -1,9 +1,7 @@
-"""Waypoint entity"""
-
 from datetime import datetime, timedelta
 from enum import StrEnum
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from .geofence import Geofence
 
@@ -25,17 +23,30 @@ class WaypointKind(StrEnum):
 class Waypoint(BaseModel):
   """Waypoint entity definition"""
 
-  model_config = {
-    'json_encoders': {
-      datetime: lambda v: v.timestamp(),
-    },
-  }
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
 
-  pk: int = Field(description='Waypoint ID', alias='id')
+  pk: int = Field(
+    description='Waypoint ID',
+    alias='id',
+  )
   geofence: Geofence | None = Field(default=None, description='Geofence object')
   geofence_id: int | None = Field(default=None, description='Geofence ID')
   start_at: datetime | None = Field(default=None, description='Waypoint start date')
+
+  @field_serializer('start_at', when_used='always')
+  def serialize_start_at(self, value: datetime | None) -> float | None:
+    return value.timestamp() if value else None
+
   end_at: datetime | None = Field(default=None, description='Waypoint end date')
+
+  @field_serializer('end_at', when_used='always')
+  def serialize_end_at(self, value: datetime | None) -> float | None:
+    return value.timestamp() if value else None
+
   sequence_real: int = Field(..., description='Real sequence number')
   sequence_ideal: int = Field(..., description='Ideal sequence number')
 
@@ -43,20 +54,31 @@ class Waypoint(BaseModel):
 class WaypointRef(BaseModel):
   """Waypoint reference entity definition"""
 
-  model_config = {
-    'json_encoders': {
-      timedelta: lambda v: v.total_seconds(),
-      datetime: lambda v: v.timestamp(),
-    },
-  }
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
 
-  pk: int = Field(description='Waypoint ID', alias='id')
+  pk: int = Field(
+    description='Waypoint ID',
+    alias='id',
+  )
   geofence_id: int = Field(description='Geofence ID')
   time: timedelta = Field(
     default_factory=lambda: timedelta(seconds=0),
     description='Time offset from the start of the checkpoint',
   )
+
+  @field_serializer('time', when_used='always')
+  def serialize_time(self, value: timedelta) -> float:
+    return value.total_seconds()
+
   kind: WaypointKind = Field(
     ...,
     description='Defines the kind of waypoint',
   )
+
+  @field_serializer('kind', when_used='always')
+  def serialize_kind(self, value: WaypointKind) -> str:
+    return value.value

layrz_sdk/entities/weekday.py

@@ -3,9 +3,7 @@ from typing import Self
 
 
 class Weekday(StrEnum):
-  """
-  Weekday definition
-  """
+  """Weekday definition"""
 
   MONDAY = 'MON'
   TUESDAY = 'TUE'

layrz_sdk/helpers/color.py

@@ -10,11 +10,7 @@ def convert_to_rgba(hex_color: str) -> Color:
   Convert Hex (or Hexa) color to RGB (or RGBA) color
 
   :param hex_color: Hex color
-  :type hex_color: str
-
   :return: RGB or RGBA color
-  :rtype: tuple
-
   :raises ValueError: If the color is invalid
   """
 
@@ -33,10 +29,9 @@ def use_black(color: str) -> bool:
   Use black
   Will return when the background color works well with black text color.
   Note: This method is not 100% accurate and will not work with alpha channel (Hexa color)
+
   :param color: Hex color
-  :type color: str
   :return: True if the color works well with black text color
-  :rtype: bool
   :raises ValueError: If the color is invalid
   """
   rgb = convert_to_rgba(color)

layrz_sdk/lcl/core.py

@@ -1,6 +1,5 @@
 """Layrz Compute Language SDK"""
 
-# ruff: noqa: ANN401
 from typing import Any, Optional, Self, cast
 
 PATTERN_INVALID = 'Pattern should be string, received {received}'

{layrz_sdk-4.0.11.dist-info → layrz_sdk-4.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.11
+Version: 4.1.8
 Summary: Layrz SDK for Python
 Author-email: "Golden M, Inc." <software@goldenm.com>
 Maintainer-email: Kenny Mochizuki <kenny@goldenm.com>, Luis Reyes <lreyes@goldenm.com>, Kasen Li <kli@goldenm.com>, Miguel Zauzich <miguel@goldenm.com>, Angel Prieto <aprieto@goldenm.com>
@@ -18,7 +18,7 @@ Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: xlsxwriter<4.0.0,>=3.2.5
-Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pydantic>=2.12.3
 Requires-Dist: geopy>=2.4.1
 Requires-Dist: shapely>=2.1.1
 Requires-Dist: strenum>=0.4.15