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

layrz_sdk/entities/operation_payload.py

@@ -1,13 +1,12 @@
-"""Operation Payload entity"""
-
 from datetime import datetime, timedelta
-from typing import Any, Self
+from typing import Any
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, field_validator
 
 from layrz_sdk.entities.asset import Asset
 from layrz_sdk.entities.destination_phone import DestinationPhone
 from layrz_sdk.entities.geofence import Geofence
+from layrz_sdk.entities.locator import Locator
 from layrz_sdk.entities.notification_type import TwilioNotificationType
 from layrz_sdk.entities.operation import Operation
 from layrz_sdk.entities.operation_case_payload import OperationCasePayload
@@ -22,22 +21,11 @@ from layrz_sdk.entities.trigger import Trigger
 class OperationPayload(BaseModel):
   """Operation Payload entity"""
 
-  model_config = {
-    'json_encoders': {
-      timedelta: lambda v: v.total_seconds(),
-      datetime: lambda v: v.timestamp(),
-      Asset: lambda v: v.model_dump(by_alias=True, exclude_none=True),
-      Trigger: lambda v: v.model_dump(by_alias=True, exclude_none=True),
-      Operation: lambda v: v.model_dump(by_alias=True, exclude_none=True),
-      Geofence: lambda v: v.model_dump(by_alias=True, exclude_none=True),
-      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,
-      PresenceType: lambda v: v.value,
-    },
-  }
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
 
   kind: OperationType = Field(
     ...,
@@ -45,14 +33,18 @@ class OperationPayload(BaseModel):
     alias='operationType',
   )
 
+  @field_serializer('kind', when_used='always')
+  def serialize_kind(self, value: OperationType) -> str:
+    return value.value
+
   asset: Asset = Field(..., description='Defines the asset associated with the operation')
 
   @field_validator('asset', mode='before')
-  def serialize_asset(cls, value: Any) -> Asset:
+  def validate_asset(cls, value: Any) -> Asset:
     """Serialize asset to a dictionary"""
     if isinstance(value, Asset):
       return Asset(
-        id=value.pk,
+        id=value.pk,  # ty: ignore
         name=value.name,
         operation_mode=value.operation_mode,
         vin=value.vin,
@@ -69,11 +61,11 @@ class OperationPayload(BaseModel):
   trigger: Trigger = Field(..., description='Defines the trigger associated with the operation')
 
   @field_validator('trigger', mode='before')
-  def serialize_trigger(cls, value: Any) -> Trigger:
+  def validate_trigger(cls, value: Any) -> Trigger:
     """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,
       )
@@ -86,11 +78,11 @@ class OperationPayload(BaseModel):
   operation: Operation = Field(..., description='Defines the operation associated with the payload')
 
   @field_validator('operation', mode='before')
-  def serialize_operation(cls, value: Any) -> Operation:
+  def validate_operation(cls, value: Any) -> Operation:
     """Serialize operation to a dictionary"""
     if isinstance(value, Operation):
       return Operation(
-        id=value.pk,
+        id=value.pk,  # ty: ignore
         name=value.name,
         operation_type=value.kind,
         timezone=value.timezone,
@@ -107,6 +99,10 @@ class OperationPayload(BaseModel):
     alias='activatedAt',
   )
 
+  @field_serializer('activated_at', when_used='always')
+  def serialize_activated_at(self, value: datetime) -> float:
+    return value.timestamp()
+
   position: dict[str, Any] = Field(
     default_factory=dict,
     description='Defines the position of the operation',
@@ -128,6 +124,10 @@ class OperationPayload(BaseModel):
     alias='presenceType',
   )
 
+  @field_serializer('presence_type', when_used='always')
+  def serialize_presence_type(self, value: PresenceType | None) -> Any:
+    return value.value if value else None
+
   case_: OperationCasePayload | None = Field(
     default=None,
     description='Defines the case of the operation',
@@ -167,6 +167,11 @@ class OperationPayload(BaseModel):
     description='Defines the HTTP method of the operation',
     alias='method',
   )
+
+  @field_serializer('http_method', when_used='always')
+  def serialize_http_method(self, value: HttpRequestType | None) -> Any:
+    return value.value if value else None
+
   http_headers: list[dict[str, Any]] = Field(
     default_factory=list,
     description='Defines the headers of the operation',
@@ -221,12 +226,27 @@ class OperationPayload(BaseModel):
     alias='hostPhone',
   )
 
+  @field_validator('twilio_host_phone', mode='before')
+  def serialize_twilio_host_phone(cls, value: Any) -> DestinationPhone | None:
+    """Serialize host phone to a DestinationPhone"""
+    if isinstance(value, DestinationPhone):
+      return value
+
+    if isinstance(value, dict):
+      return DestinationPhone.model_validate(value)
+
+    return None
+
   twilio_notification_type: TwilioNotificationType = Field(
     default=TwilioNotificationType.SMS,
     description='Defines the Twilio notification type of the operation',
     alias='notificationType',
   )
 
+  @field_serializer('twilio_notification_type', when_used='always')
+  def serialize_twilio_notification_type(self, value: TwilioNotificationType) -> str:
+    return value.value
+
   username: str | None = Field(
     default=None,
     description='Defines the username for the operation',
@@ -262,6 +282,10 @@ class OperationPayload(BaseModel):
     alias='pushPlatforms',
   )
 
+  @field_serializer('push_platforms', when_used='always')
+  def serialize_push_platforms(self, value: list[Platform]) -> list[str]:
+    return [platform.value for platform in value]
+
   ## For usage of In-app notifications operations
   destinations_ids: list[int] = Field(
     default_factory=list,
@@ -274,6 +298,10 @@ class OperationPayload(BaseModel):
     alias='soundEffect',
   )
 
+  @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 sound effect URI for the operation',
@@ -301,3 +329,12 @@ class OperationPayload(BaseModel):
     if isinstance(value, (int, float)):
       return timedelta(seconds=value)
     return timedelta(seconds=0)
+
+  @field_serializer('duration', when_used='always')
+  def serialize_duration(self, value: timedelta) -> float:
+    return value.total_seconds()
+
+  locator: Locator | None = Field(
+    default=None,
+    description='Defines the generated locator for the operation',
+  )

layrz_sdk/entities/operation_type.py

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

layrz_sdk/entities/outbound_service.py

@@ -1,14 +1,21 @@
-"""Service entity"""
-
 from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class OutboundService(BaseModel):
   """Outbound 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')
 
   protocol_name: str | None = Field(

layrz_sdk/entities/parameter_update.py

@@ -0,0 +1,25 @@
+from datetime import datetime
+from typing import Any
+
+from pydantic import BaseModel, Field, field_serializer, field_validator
+
+
+class ParamData(BaseModel):
+  value: Any | None = Field(default=None, description='The current value of the parameter.')
+  updated_at: datetime = Field(..., description='The timestamp when the parameter was updated.')
+
+  @field_serializer('updated_at', when_used='always')
+  def serialize_updated_at(self, value: datetime) -> float:
+    return value.timestamp()
+
+
+class ParameterUpdate(BaseModel):
+  asset_id: int = Field(..., description='The unique identifier for the asset.')
+  parameters: dict[str, ParamData] = Field(
+    default_factory=dict,
+    description='A mapping of parameter names to their data.',
+  )
+
+  @field_validator('parameters', mode='before')
+  def validate_parameter(cls, value: dict[str, Any]) -> dict[str, Any]:
+    return {k.replace('__', '.'): v for k, v in value.items()}

layrz_sdk/entities/platform.py

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

layrz_sdk/entities/position.py

@@ -1,13 +1,17 @@
-"""Position entity"""
-
 from typing import Any, Self, cast
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 
 class Position(BaseModel):
   """Geographic position definition"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   latitude: float | None = Field(default=None, description='Defines the latitude of the position')
   longitude: float | None = Field(default=None, description='Defines the longitude of the position')
   altitude: float | None = Field(default=None, description='Defines the altitude of the position')

layrz_sdk/entities/preset.py

@@ -1,25 +1,31 @@
-"""Preset entity"""
-
 from datetime import datetime
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 
 class Preset(BaseModel):
   """Preset entity"""
 
-  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='Defines the primary key of the preset', alias='id')
+  pk: int = Field(
+    description='Defines the primary key of the preset',
+    alias='id',
+  )
   name: str = Field(description='Defines the name of the preset')
   valid_before: datetime = Field(
     ...,
     description='Defines the date and time before which the preset is valid',
   )
+
+  @field_serializer('valid_before', when_used='always')
+  def serialize_valid_before(self, valid_before: datetime) -> float:
+    return valid_before.timestamp()
+
   comment: str = Field(
     default='',
     description='Defines the comment of the preset',

layrz_sdk/entities/report.py

@@ -1,5 +1,3 @@
-"""Report class"""
-
 import logging
 import os
 import time
@@ -8,7 +6,7 @@ from pathlib import Path
 from typing import Any, Optional, Self
 
 import xlsxwriter
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 from layrz_sdk.entities.custom_report_page import CustomReportPage
 from layrz_sdk.entities.report_data_type import ReportDataType
@@ -22,6 +20,12 @@ log = logging.getLogger(__name__)
 class Report(BaseModel):
   """Report definition"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   name: str = Field(description='Name of the report. Length should be less than 60 characters')
   pages: list[ReportPage | CustomReportPage] = Field(
     description='List of report pages',
@@ -113,10 +117,10 @@ class Report(BaseModel):
         for cell in row.content:
           cells.append(
             {
-              'content': cell.content,
+              'content': cell.content.timestamp() if cell.data_type == ReportDataType.DATETIME else cell.content,
               'text_color': '#000000' if use_black(cell.color) else '#ffffff',
               'color': cell.color,
-              'data_type': cell.data_type.value,
+              'data_type': cell.data_type.name,
             }
           )
         rows.append(

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,15 +1,33 @@
-"""Sensor entity"""
+from pydantic import BaseModel, ConfigDict, Field
 
-from pydantic import BaseModel, Field
+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(
     default='',
     description='Defines the formula of the sensor, used for calculations',
   )
+  mask: list[SensorMask] | None = Field(
+    default=None,
+    description='Defines the mask of the sensor, used for filtering data',
+  )
+
+  measuring_unit: str | None = Field(
+    default=None,
+    description='Defines the measuring unit of the sensor, e.g., km/h, °C',
+  )

layrz_sdk/entities/sensor_mask.py

@@ -0,0 +1,28 @@
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class SensorMask(BaseModel):
+  """Sensor entity"""
+
+  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(
+    default=None,
+    description='Defines the value of the sensor, can be of various types',
+  )

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