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

layrz_sdk/entities/report_col.py

@@ -1,9 +1,7 @@
-"""Report col"""
-
 import warnings
 from typing import Any, Optional, Self
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
 
 from .report_data_type import ReportDataType
 from .text_alignment import TextAlignment
@@ -12,11 +10,27 @@ from .text_alignment import TextAlignment
 class ReportCol(BaseModel):
   """Report column entity"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   content: Any = Field(description='Column content')
   color: str = Field(description='Column color', default='#ffffff')
   text_color: Optional[str] = Field(description='Column text color', default=None)
   align: TextAlignment = Field(description='Column text alignment', default=TextAlignment.LEFT)
+
+  @field_serializer('align', when_used='always')
+  def serialize_align(self, align: TextAlignment) -> str:
+    return align.value
+
   data_type: ReportDataType = Field(description='Column data type', default=ReportDataType.STR)
+
+  @field_serializer('data_type', when_used='always')
+  def serialize_data_type(self, data_type: ReportDataType) -> str:
+    return data_type.value
+
   datetime_format: str = Field(description='Datetime format', default='%Y-%m-%d %H:%M:%S')
   currency_symbol: str = Field(description='Currency symbol', default='')
   bold: bool = Field(description='Bold text', default=False)

layrz_sdk/entities/report_configuration.py

@@ -1,8 +1,14 @@
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class ReportConfiguration(BaseModel):
   """Report configuration entity"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   title: str = Field(description='Report title')
   pages_count: int = Field(description='Number of pages in the report')

layrz_sdk/entities/report_data_type.py

@@ -3,9 +3,7 @@ from typing import Self
 
 
 class ReportDataType(StrEnum):
-  """
-  Report date type
-  """
+  """Report date type"""
 
   STR = 'str'
   INT = 'int'

layrz_sdk/entities/report_format.py

@@ -1,13 +1,9 @@
-"""Report formats"""
-
 from enum import StrEnum
 from typing import Self
 
 
 class ReportFormat(StrEnum):
-  """
-  Report format definition.
-  """
+  """Report format definition."""
 
   MICROSOFT_EXCEL = 'MICROSOFT_EXCEL'
   JSON = 'JSON'

layrz_sdk/entities/report_header.py

@@ -1,9 +1,7 @@
-"""Report header"""
-
 import warnings
 from typing import Any, Optional
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
 
 from .text_alignment import TextAlignment
 
@@ -11,33 +9,18 @@ from .text_alignment import TextAlignment
 class ReportHeader(BaseModel):
   """Report header entity"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   content: Any = Field(description='Header content')
   color: str = Field(description='Header color', default='#ffffff')
-  text_color: Optional[str] = Field(description='Header text color', default=None)
   align: TextAlignment = Field(description='Header text alignment', default=TextAlignment.CENTER)
+
+  @field_serializer('align', when_used='always')
+  def serialize_align(self, align: TextAlignment) -> str:
+    return align.value
+
   bold: bool = Field(description='Bold text', default=False)
-  width: Optional[float] = Field(description='Header width', default=None)
-
-  @field_validator('text_color', mode='before')
-  def _validate_text_color(cls, value: Any) -> Any:
-    """Validate text color"""
-    if value is not None:
-      warnings.warn(
-        'text_color is deprecated, the algorithm will calculate the rigth text color instead',
-        DeprecationWarning,
-        stacklevel=2,
-      )
-
-    return value
-
-  @field_validator('width', mode='before')
-  def _validate_width(cls, value: Any) -> Any:
-    """Validate width"""
-    if value is not None:
-      warnings.warn(
-        'width is deprecated, the algorithm will calculate the rigth width instead',
-        DeprecationWarning,
-        stacklevel=2,
-      )
-
-    return value

layrz_sdk/entities/report_page.py

@@ -1,6 +1,4 @@
-"""Report page"""
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from .report_header import ReportHeader
 from .report_row import ReportRow
@@ -9,6 +7,12 @@ from .report_row import ReportRow
 class ReportPage(BaseModel):
   """Report page definition"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   name: str = Field(description='Name of the page. Length should be less than 60 characters')
   headers: list[ReportHeader] = Field(description='List of report headers', default_factory=list)
   rows: list[ReportRow] = Field(description='List of report rows', default_factory=list)

layrz_sdk/entities/report_row.py

@@ -1,9 +1,4 @@
-"""Report row"""
-
-import warnings
-from typing import Any, Optional
-
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field
 
 from .report_col import ReportCol
 
@@ -11,18 +6,11 @@ from .report_col import ReportCol
 class ReportRow(BaseModel):
   """Report row definition"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   content: list[ReportCol] = Field(description='List of report columns', default_factory=list)
-  height: Optional[float] = Field(description='Row height', default=None)
   compact: bool = Field(description='Compact mode', default=False)
-
-  @field_validator('height', mode='before')
-  def _validate_height(cls, value: Any) -> Any:
-    """Validate height"""
-    if value is not None:
-      warnings.warn(
-        'height is deprecated, the algorithm will calculate the rigth text color instead',
-        DeprecationWarning,
-        stacklevel=2,
-      )
-
-    return value

layrz_sdk/entities/request_type.py

@@ -1,5 +1,3 @@
-"""Http Operation Type"""
-
 from enum import StrEnum
 from typing import Self
 

layrz_sdk/entities/sensor.py

@@ -1,6 +1,4 @@
-"""Sensor entity"""
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from .sensor_mask import SensorMask
 
@@ -8,7 +6,16 @@ from .sensor_mask import SensorMask
 class Sensor(BaseModel):
   """Sensor entity"""
 
-  pk: int = Field(description='Defines the primary key of the sensor', 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 sensor',
+    alias='id',
+  )
   name: str = Field(description='Defines the name of the sensor')
   slug: str = Field(description='Defines the slug of the sensor')
   formula: str = Field(

layrz_sdk/entities/sensor_mask.py

@@ -1,14 +1,25 @@
-"""Sensor entity"""
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class SensorMask(BaseModel):
   """Sensor entity"""
 
-  icon: str | None = Field(description='Defines the icon of the sensor')
-  text: str | None = Field(description='Defines the text of the sensor')
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  icon: str | None = Field(
+    default=None,
+    description='Defines the icon of the sensor',
+  )
+  text: str | None = Field(
+    default=None,
+    description='Defines the text of the sensor',
+  )
   color: str | None = Field(
+    default=None,
     description='Defines the color of the sensor, used for visual representation',
   )
   value: str | float | int | None = Field(

layrz_sdk/entities/sound_effect.py

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

layrz_sdk/entities/static_position.py

@@ -1,7 +1,12 @@
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class StaticPosition(BaseModel):
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
   latitude: float = Field(
     ...,
     description='Latitude of the static position',

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_serializer, 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,7 +12,16 @@ from .weekday import Weekday
 class Trigger(BaseModel):
   """Trigger entity"""
 
-  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')
 
@@ -34,7 +43,6 @@ class Trigger(BaseModel):
 
   @field_serializer('type_', when_used='always')
   def serialize_type(self, value: TriggerKind | None) -> str | None:
-    """Serialize type_ to its value."""
     return value.value if value else None
 
   presence_type: TriggerGeofenceKind | None = Field(
@@ -44,7 +52,6 @@ class Trigger(BaseModel):
 
   @field_serializer('presence_type', when_used='always')
   def serialize_presence_type(self, value: TriggerGeofenceKind | None) -> str | None:
-    """Serialize presence_type to its value."""
     return value.value if value else None
 
   case_type: TriggerCaseKind | None = Field(
@@ -54,7 +61,6 @@ class Trigger(BaseModel):
 
   @field_serializer('case_type', when_used='always')
   def serialize_case_type(self, value: TriggerCaseKind | None) -> str | None:
-    """Serialize case_type to its value."""
     return value.value if value else None
 
   case_comment_pattern: TriggerCommentPattern | None = Field(
@@ -64,7 +70,6 @@ class Trigger(BaseModel):
 
   @field_serializer('case_comment_pattern', when_used='always')
   def serialize_case_comment_pattern(self, value: TriggerCommentPattern | None) -> str | None:
-    """Serialize case_comment_pattern to its value."""
     return value.value if value else None
 
   case_comment_value: str | None = Field(
@@ -88,7 +93,6 @@ class Trigger(BaseModel):
 
   @field_serializer('weekdays', when_used='always')
   def serialize_weekdays(self, value: list[Weekday]) -> list[str]:
-    """Serialize weekdays to their values."""
     return [day.value for day in value]
 
   is_plain_crontab: bool = Field(
@@ -113,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,
@@ -176,7 +177,6 @@ class Trigger(BaseModel):
 
   @field_serializer('when_case_expires_delta', when_used='always')
   def serialize_when_case_expires_delta(self, value: timedelta | None) -> float | None:
-    """Serialize when_case_expires_delta to total seconds."""
     return value.total_seconds() if value else None
 
   should_stack: bool = Field(
@@ -200,5 +200,38 @@ class Trigger(BaseModel):
 
   @field_serializer('search_time_delta', when_used='always')
   def serialize_search_time_delta(self, value: timedelta | None) -> float | None:
-    """Serialize search_time_delta to total seconds."""
     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'

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')