layrz-sdk 4.0.29__tar.gz → 4.0.31__tar.gz

{layrz_sdk-4.0.29 → layrz_sdk-4.0.31}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 4.0.31
+
+- Refined `OperationPayload` serialization to rely on field serializers, ensuring nested models, enums, datetimes, and timedeltas dump with the expected API shape.
+- Allowed passing Twilio host phone data as dictionaries when constructing `OperationPayload`.
+
+## 4.0.30
+
+- Added a validation for `pk` field in `Locator` entity to ensure it is always a string, converting from `int` or `UUID` if necessary.
+
 ## 4.0.29
 
 - Added `created_at` and `updated_at` fields to `Locator` entity to track creation and last update timestamps.

{layrz_sdk-4.0.29/layrz_sdk.egg-info → layrz_sdk-4.0.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.29
+Version: 4.0.31
 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>

{layrz_sdk-4.0.29 → layrz_sdk-4.0.31}/layrz_sdk/entities/locator.py

@@ -1,6 +1,8 @@
 from datetime import datetime
+from typing import Any
+from uuid import UUID
 
-from pydantic import BaseModel, Field, field_serializer
+from pydantic import BaseModel, Field, field_serializer, field_validator
 
 from .asset import Asset
 from .geofence import Geofence
@@ -17,6 +19,17 @@ class LocatorMqttConfig(BaseModel):
 
 class Locator(BaseModel):
   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')
 

{layrz_sdk-4.0.29 → layrz_sdk-4.0.31}/layrz_sdk/entities/operation_payload.py

@@ -3,7 +3,7 @@
 from datetime import datetime, timedelta
 from typing import Any, Self
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, Field, field_serializer, field_validator
 
 from layrz_sdk.entities.asset import Asset
 from layrz_sdk.entities.destination_phone import DestinationPhone
@@ -22,29 +22,16 @@ 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,
-    },
-  }
-
   kind: OperationType = Field(
     ...,
     description='Defines the kind of the operation',
     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')
@@ -52,7 +39,7 @@ class OperationPayload(BaseModel):
     """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,
@@ -66,6 +53,11 @@ 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')
@@ -73,7 +65,7 @@ class OperationPayload(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,
       )
@@ -83,6 +75,11 @@ 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')
@@ -90,7 +87,7 @@ class OperationPayload(BaseModel):
     """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,
@@ -101,12 +98,21 @@ 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',
     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',
@@ -122,18 +128,36 @@ 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',
     alias='presenceType',
   )
 
+  @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
+
   case_: OperationCasePayload | None = Field(
     default=None,
     description='Defines the case of the operation',
     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',
@@ -167,6 +191,13 @@ 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:
+    if value is None:
+      return None
+    return value.value
+
   http_headers: list[dict[str, Any]] = Field(
     default_factory=list,
     description='Defines the headers of the operation',
@@ -215,18 +246,38 @@ 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',
     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 +313,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 +329,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 +360,7 @@ 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()

{layrz_sdk-4.0.29 → layrz_sdk-4.0.31/layrz_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.29
+Version: 4.0.31
 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>

{layrz_sdk-4.0.29 → layrz_sdk-4.0.31}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "4.0.29"
+version = "4.0.31"
 description = "Layrz SDK for Python"
 authors = [{ name = "Golden M, Inc.", email = "software@goldenm.com" }]
 requires-python = ">=3.13"

{layrz_sdk-4.0.29 → layrz_sdk-4.0.31}/uv.lock

@@ -233,7 +233,7 @@ wheels = [
 
 [[package]]
 name = "layrz-sdk"
-version = "4.0.29"
+version = "4.0.31"
 source = { editable = "." }
 dependencies = [
     { name = "geopy" },