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

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

@@ -1,5 +1,14 @@
 # Changelog
 
+## 4.0.33
+
+- Reworked `BroadcastPayload` serialization to rely on Pydantic field serializers, keeping nested models and timestamps aligned with JSON expectations.
+- Added optional `locator` field to `BroadcastPayload` so locator metadata can accompany broadcast messages.
+
+## 4.0.32
+
+- Added `locator` field to `OperationPayload` entity to include locator information in operation payloads.
+
 ## 4.0.31
 
 - Refined `OperationPayload` serialization to rely on field serializers, ensuring nested models, enums, datetimes, and timedeltas dump with the expected API shape.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.31
+Version: 4.0.33
 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.33/layrz_sdk/entities/broadcast/payload.py

@@ -0,0 +1,69 @@
+"""Broadcast Payload data"""
+
+from datetime import datetime
+from typing import Any
+
+from pydantic import BaseModel, Field, field_serializer
+
+from layrz_sdk.constants import UTC
+from layrz_sdk.entities.asset import Asset
+from layrz_sdk.entities.device import Device
+from layrz_sdk.entities.locator import Locator
+from layrz_sdk.entities.trigger import Trigger
+
+from .service import BroadcastService
+
+
+class BroadcastPayload(BaseModel):
+  """Broadcast payload data, structure that is sent to the Outbound MQTT and other services"""
+
+  asset: Asset = Field(..., description='Asset object')
+
+  @field_serializer('asset', when_used='always')
+  def serialize_asset(self, v: Asset) -> dict[str, Any]:
+    return v.model_dump(mode='json', by_alias=True)
+
+  primary_device: Device | None = Field(default=None, description='Primary device object')
+
+  @field_serializer('primary_device', when_used='always')
+  def serialize_primary_device(self, v: Device | None) -> dict[str, Any] | None:
+    if v is None:
+      return None
+    return v.model_dump(mode='json', by_alias=True)
+
+  trigger: Trigger | None = Field(default=None, description='Trigger object, if available')
+
+  @field_serializer('trigger', when_used='always')
+  def serialize_trigger(self, v: Trigger | None) -> dict[str, Any] | None:
+    if v is None:
+      return None
+    return v.model_dump(mode='json', by_alias=True)
+
+  message_id: int | str = Field(..., description='Message ID')
+  service: BroadcastService | None = Field(default=None, description='Broadcast service object')
+
+  @field_serializer('service', when_used='always')
+  def serialize_service(self, v: BroadcastService | None) -> dict[str, Any] | None:
+    if v is None:
+      return None
+    return v.model_dump(mode='json', by_alias=True)
+
+  position: dict[str, Any] = Field(default_factory=dict, description='Position data, if available')
+  sensors: dict[str, Any] = Field(default_factory=dict, description='Sensors data, if available')
+  payload: dict[str, Any] = Field(default_factory=dict, description='Payload data, if available')
+  received_at: datetime = Field(
+    default_factory=lambda: datetime.now(UTC),
+    description='Broadcast payload received date',
+  )
+
+  @field_serializer('received_at', when_used='always')
+  def serialize_received_at(self, v: datetime) -> float:
+    return v.timestamp()
+
+  locator: Locator | None = Field(default=None, description='Locator object, if available')
+
+  @field_serializer('locator', when_used='always')
+  def serialize_locator(self, v: Locator | None) -> dict[str, Any] | None:
+    if v is None:
+      return None
+    return v.model_dump(mode='json', by_alias=True)

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

@@ -8,6 +8,7 @@ from pydantic import BaseModel, 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
@@ -364,3 +365,14 @@ class OperationPayload(BaseModel):
   @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',
+  )
+
+  @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-4.0.31 → layrz_sdk-4.0.33/layrz_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.31
+Version: 4.0.33
 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.31 → layrz_sdk-4.0.33}/pyproject.toml

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

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

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

layrz_sdk-4.0.31/layrz_sdk/entities/broadcast/payload.py

@@ -1,37 +0,0 @@
-"""Broadcast Payload data"""
-
-from datetime import datetime
-from typing import Any
-
-from pydantic import BaseModel, Field
-
-from layrz_sdk.constants import UTC
-from layrz_sdk.entities.asset import Asset
-from layrz_sdk.entities.device import Device
-from layrz_sdk.entities.trigger import Trigger
-
-from .service import BroadcastService
-
-
-class BroadcastPayload(BaseModel):
-  """Broadcast payload data, structure that is sent to the Outbound MQTT and other services"""
-
-  model_config = {
-    'loc_by_alias': True,
-    'json_encoders': {
-      datetime: lambda v: v.timestamp(),
-    },
-  }
-
-  asset: Asset = Field(..., description='Asset object')
-  primary_device: Device | None = Field(default=None, description='Primary device object')
-  trigger: Trigger | None = Field(default=None, description='Trigger object, if available')
-  message_id: int | str = Field(..., description='Message ID')
-  service: BroadcastService | None = Field(default=None, description='Broadcast service object')
-  position: dict[str, Any] = Field(default_factory=dict, description='Position data, if available')
-  sensors: dict[str, Any] = Field(default_factory=dict, description='Sensors data, if available')
-  payload: dict[str, Any] = Field(default_factory=dict, description='Payload data, if available')
-  received_at: datetime = Field(
-    default_factory=lambda: datetime.now(UTC),
-    description='Broadcast payload received date',
-  )