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

layrz_sdk/entities/exchange_service.py

@@ -1,14 +1,22 @@
-"""Exchange Service entity"""
-
 from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class ExchangeService(BaseModel):
   """Exchange service definition"""
 
-  pk: int = Field(..., description='Service ID', alias='id')
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  pk: int = Field(
+    ...,
+    description='Service ID',
+    alias='id',
+  )
   name: str = Field(..., description='Service name')
   credentials: dict[str, Any] = Field(
     description='Service credentials',

layrz_sdk/entities/function.py

@@ -1,9 +1,7 @@
-"""Geofence entity"""
-
 from datetime import timedelta
 from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from .asset import Asset
 
@@ -11,7 +9,16 @@ from .asset import Asset
 class Function(BaseModel):
   """Function entity"""
 
-  pk: int = Field(description='Defines the primary key of the Function', 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 Function',
+    alias='id',
+  )
   name: str = Field(description='Name of the function')
 
   maximum_time: timedelta | None = Field(

layrz_sdk/entities/geofence.py

@@ -1,11 +1,26 @@
-"""Geofence entity"""
+from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class Geofence(BaseModel):
   """Geofence entity"""
 
-  pk: int = Field(description='Defines the primary key of the geofence', alias='id')
-  name: str = Field(description='Defines the name of the geofence')
-  color: str = Field(description='Defines the color of the geofence')
+  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 geofence',
+    alias='id',
+  )
+  name: str = Field(..., description='Defines the name of the geofence')
+  color: str = Field(..., description='Defines the color of the geofence')
+
+  geom_wgs84: dict[str, Any] = Field(description='GeoJSON geometry', default_factory=dict)
+  geom_web_mercator: dict[str, Any] = Field(description='GeoJSON geometry in Web Mercator', default_factory=dict)
+
+  owner_id: int | None = Field(default=None, description='Defines the owner ID of the geofence')

layrz_sdk/entities/geofence_category.py

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

layrz_sdk/entities/last_message.py

@@ -1,6 +1,4 @@
-"""LastMessage entity"""
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from .asset import Asset
 from .message import Message
@@ -9,4 +7,10 @@ from .message import Message
 class LastMessage(Message, BaseModel):
   """LastMessage definition"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   asset: Asset = Field(description='Defines the asset of the last message')

layrz_sdk/entities/locator.py

@@ -0,0 +1,95 @@
+from datetime import datetime
+from typing import Any
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
+
+from .asset import Asset
+from .geofence import Geofence
+from .trigger import Trigger
+
+
+class LocatorMqttConfig(BaseModel):
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+  host: str = Field(..., description='Defines the MQTT host of the locator')
+  port: int = Field(..., description='Defines the MQTT port of the locator')
+  username: str | None = Field(default=None, description='Defines the MQTT username of the locator')
+  password: str | None = Field(default=None, description='Defines the MQTT password of the locator')
+  topic: str = Field(..., description='Defines the MQTT topic of the locator')
+
+
+class Locator(BaseModel):
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+  pk: str = Field(
+    ...,
+    description='Defines the primary key of the locator',
+    alias='id',
+  )
+
+  @field_validator('pk', mode='before')
+  def validate_pk(cls, v: Any) -> str:
+    if isinstance(v, int):
+      return str(v)
+    if isinstance(v, str):
+      return v
+    if isinstance(v, UUID):
+      return str(v)
+    raise ValueError('Invalid type for pk')
+
+  token: str = Field(..., description='Defines the token of the locator')
+  owner_id: int = Field(..., description='Defines the owner ID of the locator')
+
+  created_at: datetime = Field(..., description='Defines the creation date of the locator')
+
+  @field_serializer('created_at', when_used='always')
+  def serialize_created_at(self, created_at: datetime) -> float:
+    return created_at.timestamp()
+
+  updated_at: datetime = Field(..., description='Defines the last update date of the locator')
+
+  @field_serializer('updated_at', when_used='always')
+  def serialize_updated_at(self, updated_at: datetime) -> float:
+    return updated_at.timestamp()
+
+  mqtt_config: LocatorMqttConfig | None = Field(..., description='Defines the MQTT configuration of the locator')
+  assets: list[Asset] = Field(
+    default_factory=list,
+    description='Defines the list of assets associated with the locator',
+  )
+
+  geofences: list[Geofence] = Field(
+    default_factory=list,
+    description='Defines the list of geofences associated with the locator',
+  )
+
+  triggers: list[Trigger] = Field(
+    default_factory=list,
+    description='Defines the list of triggers associated with the locator',
+  )
+
+  is_expired: bool = Field(
+    default=False,
+    description='Indicates whether the locator is expired',
+  )
+
+  expires_at: datetime | None = Field(
+    default=None,
+    description='Defines the expiration date of the locator, if applicable',
+  )
+
+  @field_serializer('expires_at', when_used='always')
+  def serialize_expires_at(self, expires_at: datetime | None) -> float | None:
+    return expires_at.timestamp() if expires_at else None
+
+  customization_id: int | None = Field(
+    default=None,
+    description='Defines the customization ID associated with the locator, if applicable',
+  )

layrz_sdk/entities/message.py

@@ -1,9 +1,7 @@
-"""Message entity"""
-
 from datetime import datetime
 from typing import Any
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
 
 from layrz_sdk.constants import UTC
 from layrz_sdk.entities.geofence import Geofence
@@ -13,13 +11,17 @@ from layrz_sdk.entities.position import Position
 class Message(BaseModel):
   """Message 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='Message ID', alias='id')
+  pk: int = Field(
+    ...,
+    description='Message ID',
+    alias='id',
+  )
   asset_id: int = Field(..., description='Asset ID')
   position: Position = Field(
     default_factory=lambda: Position(),
@@ -38,6 +40,11 @@ class Message(BaseModel):
     description='Timestamp when the message was received',
   )
 
+  @field_serializer('received_at', when_used='always')
+  def serialize_received_at(self, value: datetime) -> float:
+    """Serialize received_at to a timestamp."""
+    return value.timestamp()
+
   geofences: list[Geofence] = Field(
     default_factory=list,
     description='List of geofences associated with the message',

layrz_sdk/entities/modbus/config.py

@@ -1,9 +1,15 @@
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from .parameter import ModbusParameter
 
 
 class ModbusConfig(BaseModel):
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   port_id: str = Field(
     ...,
     description='Port ID for Modbus communication',

layrz_sdk/entities/modbus/parameter.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 from .schema import ModbusSchema
 
@@ -8,6 +8,12 @@ from .schema import ModbusSchema
 class ModbusParameter(BaseModel):
   """Modbus parameter model"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   schema_: ModbusSchema = Field(
     ...,
     description='Modbus schema',

layrz_sdk/entities/modbus/wait.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
 
 from .schema import ModbusSchema
 from .status import ModbusStatus
@@ -9,11 +9,21 @@ from .status import ModbusStatus
 class ModbusWait(BaseModel):
   """Modbus parameter model"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   status: ModbusStatus = Field(
     ...,
     description='Status of the Modbus command',
   )
 
+  @field_serializer('status', when_used='always')
+  def serialize_status(self, status: ModbusStatus) -> str:
+    return status.value
+
   structure: ModbusSchema = Field(
     ...,
     description='Modbus structure schema',

layrz_sdk/entities/notification_type.py

@@ -1,5 +1,3 @@
-"""Twilio Notification Type Enum"""
-
 from enum import StrEnum
 from typing import Self
 

layrz_sdk/entities/operation.py

@@ -1,9 +1,7 @@
-"""Operation entity"""
-
-from datetime import time, timedelta
+from datetime import timedelta
 from typing import Any, Self
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
 
 from .destination_phone import DestinationPhone
 from .notification_type import TwilioNotificationType
@@ -17,18 +15,16 @@ from .timezone import Timezone
 class Operation(BaseModel):
   """Operation entity"""
 
-  model_config = {
-    'json_encoders': {
-      timedelta: lambda v: v.total_seconds(),
-      OperationType: lambda v: v.value,
-      HttpRequestType: lambda v: v.value,
-      TwilioNotificationType: lambda v: v.value,
-      SoundEffect: lambda v: v.value,
-      Platform: 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')
 
   cooldown_time: timedelta = Field(
@@ -36,11 +32,19 @@ class Operation(BaseModel):
     description='Defines the cooldown time of the trigger',
   )
 
+  @field_serializer('cooldown_time', when_used='always')
+  def serialize_cooldown_time(self, value: timedelta) -> float:
+    return value.total_seconds()
+
   operation_type: OperationType = Field(
     ...,
     description='Defines the kind of the operation',
   )
 
+  @field_serializer('operation_type', when_used='always')
+  def serialize_operation_type(self, value: OperationType) -> str:
+    return value.value
+
   @property
   def kind(self: Self) -> OperationType:
     """Get the kind of the operation"""
@@ -51,6 +55,10 @@ class Operation(BaseModel):
     description='Defines the HTTP method of the operation',
   )
 
+  @field_serializer('request_type', when_used='always')
+  def serialize_request_type(self, value: HttpRequestType | None) -> str | None:
+    return value.value if value else None
+
   @property
   def http_method(self: Self) -> HttpRequestType | None:
     """Get the HTTP method of the operation"""
@@ -125,6 +133,11 @@ class Operation(BaseModel):
     description='Defines the Twilio notification type of the operation',
   )
 
+  @field_serializer('notification_type', when_used='always')
+  def serialize_notification_type(self, value: TwilioNotificationType) -> str:
+    """Serialize notification_type to its value."""
+    return value.value
+
   @property
   def twilio_notification_type(self: Self) -> TwilioNotificationType:
     """Get the Twilio notification type of the operation"""
@@ -201,6 +214,10 @@ class Operation(BaseModel):
     description='Defines the sound effect for the operation',
   )
 
+  @field_serializer('sound_effect', when_used='always')
+  def serialize_sound_effect(self, value: SoundEffect) -> str:
+    return value.value
+
   sound_effect_uri: str | None = Field(
     default=None,
     description='Defines the URI for the sound effect of the operation. Only when sound_effect is set to CUSTOM.',
@@ -211,6 +228,10 @@ class Operation(BaseModel):
     description='Defines the duration of the operation',
   )
 
+  @field_serializer('duration', when_used='always')
+  def serialize_duration(self, value: timedelta | None) -> float | None:
+    return value.total_seconds() if value else None
+
   @field_validator('duration', mode='before')
   def validate_duration(cls, value: Any) -> timedelta:
     if value is None:

layrz_sdk/entities/operation_case_payload.py

@@ -1,9 +1,7 @@
-"""Operation case payload entity"""
-
 from datetime import datetime, timedelta
 from typing import Any
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
 
 from layrz_sdk.constants import UTC
 from layrz_sdk.entities.trigger import Trigger
@@ -12,7 +10,17 @@ from layrz_sdk.entities.trigger import Trigger
 class OperationCaseCommentPayload(BaseModel):
   """Operation case comment payload entity"""
 
-  pk: int = Field(..., description='Defines the primary key of the operation case comment', 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 operation case comment',
+    alias='id',
+  )
   user: str = Field(..., description='Defines the user who created the operation case comment')
   content: str = Field(..., description='Defines the content of the operation case comment')
   created_at: datetime = Field(
@@ -20,28 +28,42 @@ class OperationCaseCommentPayload(BaseModel):
     description='Defines the creation date of the operation case comment',
   )
 
+  @field_serializer('created_at', when_used='always')
+  def serialize_created_at(self, created_at: datetime) -> float:
+    return created_at.timestamp()
+
 
 class OperationCasePayload(BaseModel):
   """Operation case payload entity"""
 
-  model_config = {
-    'json_encoders': {
-      timedelta: lambda v: v.total_seconds(),
-      datetime: lambda v: v.timestamp(),
-      Trigger: lambda v: v.model_dump(by_alias=True, exclude_none=True),
-    },
-  }
+  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 operation case payload', alias='id')
+  pk: int = Field(
+    description='Defines the primary key of the operation case payload',
+    alias='id',
+  )
   created_at: datetime = Field(
     default_factory=lambda: datetime.now(UTC),
     description='Defines the creation date of the operation case payload',
   )
+
+  @field_serializer('created_at', when_used='always')
+  def serialize_created_at(self, created_at: datetime) -> float:
+    return created_at.timestamp()
+
   updated_at: datetime = Field(
     default_factory=lambda: datetime.now(UTC),
     description='Defines the last update date of the operation case payload',
   )
 
+  @field_serializer('updated_at', when_used='always')
+  def serialize_updated_at(self, updated_at: datetime) -> float:
+    return updated_at.timestamp()
+
   trigger: Trigger = Field(
     ...,
     description='Defines the trigger associated with the operation case payload',
@@ -52,7 +74,7 @@ class OperationCasePayload(BaseModel):
     """Serialize trigger to a dictionary"""
     if isinstance(value, Trigger):
       return Trigger(
-        id=value.pk,
+        id=value.pk,  # ty: ignore
         name=value.name,
         code=value.code,
       )
@@ -71,6 +93,10 @@ class OperationCasePayload(BaseModel):
     description='Defines the creation date of the file associated with the operation case payload',
   )
 
+  @field_serializer('file_created_at', when_used='always')
+  def serialize_file_created_at(self, file_created_at: datetime | None) -> float | None:
+    return file_created_at.timestamp() if file_created_at else None
+
   comment: OperationCaseCommentPayload | None = Field(
     default=None,
     description='Defines the comment associated with the operation case payload',