layrz-sdk 4.0.35__py3-none-any.whl → 4.1.0__py3-none-any.whl

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

layrz_sdk/entities/operation_payload.py

@@ -1,9 +1,7 @@
-"""Operation Payload entity"""
-
 from datetime import datetime, timedelta
-from typing import Any, Self
+from typing import Any
 
-from pydantic import BaseModel, Field, field_serializer, 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
@@ -23,6 +21,12 @@ from layrz_sdk.entities.trigger import Trigger
 class OperationPayload(BaseModel):
   """Operation Payload entity"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   kind: OperationType = Field(
     ...,
     description='Defines the kind of the operation',
@@ -36,7 +40,7 @@ class OperationPayload(BaseModel):
   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(
@@ -54,15 +58,10 @@ class OperationPayload(BaseModel):
 
     raise ValueError('Asset must be an instance of Asset or a dictionary')
 
-  @field_serializer('asset', when_used='always')
-  def serialize_asset_field(self, value: Asset) -> dict[str, Any]:
-    """Serialize asset to a dictionary"""
-    return value.model_dump(by_alias=True)
-
   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(
@@ -76,15 +75,10 @@ class OperationPayload(BaseModel):
 
     raise ValueError('Trigger must be an instance of Trigger or a dictionary')
 
-  @field_serializer('trigger', when_used='always')
-  def serialize_trigger_field(self, value: Trigger) -> dict[str, Any]:
-    """Serialize trigger to a dictionary"""
-    return value.model_dump(by_alias=True)
-
   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(
@@ -99,11 +93,6 @@ class OperationPayload(BaseModel):
 
     raise ValueError('Operation must be an instance of Operation or a dictionary')
 
-  @field_serializer('operation', when_used='always')
-  def serialize_operation_field(self, value: Operation) -> dict[str, Any]:
-    """Serialize operation to a dictionary"""
-    return value.model_dump(by_alias=True)
-
   activated_at: datetime = Field(
     ...,
     description='Defines the date when the operation was activated',
@@ -129,12 +118,6 @@ class OperationPayload(BaseModel):
     description='Defines the geofence of the operation',
   )
 
-  @field_serializer('geofence', when_used='always')
-  def serialize_geofence(self, value: Geofence | None) -> Any:
-    if value is None:
-      return None
-    return value.model_dump(by_alias=True)
-
   presence_type: PresenceType | None = Field(
     default=None,
     description='Defines the presence type of the operation',
@@ -143,9 +126,7 @@ class OperationPayload(BaseModel):
 
   @field_serializer('presence_type', when_used='always')
   def serialize_presence_type(self, value: PresenceType | None) -> Any:
-    if value is None:
-      return None
-    return value.value
+    return value.value if value else None
 
   case_: OperationCasePayload | None = Field(
     default=None,
@@ -153,12 +134,6 @@ class OperationPayload(BaseModel):
     alias='case',
   )
 
-  @field_serializer('case_', when_used='always')
-  def serialize_case(self, value: OperationCasePayload | None) -> Any:
-    if value is None:
-      return None
-    return value.model_dump(by_alias=True)
-
   language_id: int = Field(
     default=2,
     description='Defines the language ID of the operation',
@@ -195,9 +170,7 @@ class OperationPayload(BaseModel):
 
   @field_serializer('http_method', when_used='always')
   def serialize_http_method(self, value: HttpRequestType | None) -> Any:
-    if value is None:
-      return None
-    return value.value
+    return value.value if value else None
 
   http_headers: list[dict[str, Any]] = Field(
     default_factory=list,
@@ -247,11 +220,6 @@ class OperationPayload(BaseModel):
 
     return []
 
-  @field_serializer('destinations', when_used='always')
-  def serialize_destinations_field(self, value: list[DestinationPhone]) -> list[dict[str, Any]]:
-    """Serialize destinations to a list of dictionaries"""
-    return [dest.model_dump(by_alias=True) for dest in value]
-
   twilio_host_phone: DestinationPhone | None = Field(
     default=None,
     description='Defines the host phone number for Twilio notifications',
@@ -370,9 +338,3 @@ class OperationPayload(BaseModel):
     default=None,
     description='Defines the generated locator for the operation',
   )
-
-  @field_serializer('locator', when_used='always')
-  def serialize_locator(self, value: Locator | None) -> Any:
-    if value is None:
-      return None
-    return value.model_dump(by_alias=True)

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

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