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

layrz_sdk/entities/ats_purchaseorder.py

@@ -0,0 +1,106 @@
+from datetime import datetime
+from enum import StrEnum
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
+
+from .asset import Asset
+
+
+class OrderStatus(StrEnum):
+  GENERATED = 'GENERATED'
+  IN_TRANSIT = 'IN_TRANSIT'
+  WAITING_TO_DISPATCH = 'WAITING_TO_DISPATCH'  # For trucks
+  DELIVERED = 'DELIVERED'
+  # For the purchase order status in the port
+  READY_TO_OPERATE = 'READY_TO_OPERATE'
+  UNLOADING_OPERATION = 'UNLOADING_OPERATION'
+  UNLOADING_FUEL = 'UNLOADING_FUEL'
+  UNLOADING_FUEL_INTERRUPTED = 'UNLOADING_FUEL_INTERRUPTED'
+  DESTINATION_BERTH_EXIT = 'DESTINATION_BERTH_EXIT'
+  ORIGIN_BERTH_EXIT = 'ORIGIN_BERTH_EXIT'
+
+
+class OrderCategories(StrEnum):
+  PICKUP = 'PICKUP'
+  PICKUP_TO_SUPPLIER = 'PICKUP_TO_SUPPLIER'
+  TRANSFER = 'TRANSFER'
+  DELIVERY_TO_SUPPLIER = 'DELIVERY_TO_SUPPLIER'
+  DELIVERY_TO_RESELLER = 'DELIVERY_TO_RESELLER'
+  FOR_SALE_OUTSIDE = 'FOR_SALE_OUTSIDE'
+  DELIVERY_TO_STORAGE = 'DELIVERY_TO_STORAGE'
+  RETURN_FROM_STORAGE = 'RETURN_FROM_STORAGE'
+  NOT_DEFINED = 'NOT_DEFINED'
+
+
+class DeliveryCategories(StrEnum):
+  SAME_STATE = 'SAME_STATE'
+  OTHER_STATE = 'OTHER_STATE'
+  NOT_DEFINED = 'NOT_DEFINED'
+
+
+class AtsPurchaseOrder(BaseModel):
+  """Entry entity"""
+
+  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',
+  )
+  purchased_at: datetime = Field(description='Timestamp when the operation was purchased')
+
+  @field_serializer('purchased_at', when_used='always')
+  def serialize_purchased_at(self, purchased_at: datetime) -> float:
+    return purchased_at.timestamp()
+
+  order_status: OrderStatus = Field(..., description='Current status of the order')
+
+  @field_serializer('order_status', when_used='always')
+  def serialize_order_status(self, order_status: OrderStatus) -> str:
+    return order_status.value
+
+  order_id: int = Field(description='ID of the order')
+  category: OrderCategories | None = Field(description='Category of the operation', default=None)
+
+  @field_serializer('category', when_used='always')
+  def serialize_category(self, category: OrderCategories | None) -> str | None:
+    return category.value if category else None
+
+  deliver_category: DeliveryCategories | None = Field(description='Delivery category of the operation', default=None)
+
+  @field_serializer('deliver_category', when_used='always')
+  def serialize_deliver_category(self, deliver_category: DeliveryCategories | None) -> str | None:
+    return deliver_category.value if deliver_category else None
+
+  seller_asset_id: int = Field(description='ID of the seller asset')
+  transport_asset_id: int | None = Field(description='ID of the transport asset', default=None)
+  asset_id: int = Field(description='ID of the asset')
+
+  seller_asset: Asset | None = Field(description='Seller asset details', default=None)
+  transport_asset: Asset | None = Field(description='Transport asset details', default=None)
+  asset: Asset | None = Field(description='Destination asset details', default=None)
+  delivered_at: datetime | None = Field(description='Timestamp when the operation was delivered', default=None)
+
+  @field_serializer('delivered_at', when_used='always')
+  def serialize_delivered_at(self, delivered_at: datetime | None) -> float | None:
+    return delivered_at.timestamp() if delivered_at else None
+
+  eta: datetime | None = Field(description='Estimated time of arrival to the destination', default=None)
+
+  @field_serializer('eta', when_used='always')
+  def serialize_eta(self, eta: datetime | None) -> float | None:
+    return eta.timestamp() if eta else None
+
+  eta_updated_at: datetime | None = Field(description='Timestamp when the ETA was last updated', default=None)
+
+  @field_serializer('eta_updated_at', when_used='always')
+  def serialize_eta_updated_at(self, eta_updated_at: datetime | None) -> float | None:
+    return eta_updated_at.timestamp() if eta_updated_at else None
+
+  invoice_type: str = Field(description='Type of the invoice')
+  operation_id: int | None = Field(description='ID of the operation', default=None)
+  products_information: list[dict[str, Any]] = Field(description='List of products information', default_factory=list)

layrz_sdk/entities/ats_reception.py

@@ -1,8 +1,6 @@
-"""Ats Reception entity"""
-
 from datetime import datetime
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from layrz_sdk.constants import UTC
 
@@ -10,7 +8,16 @@ from layrz_sdk.constants import UTC
 class AtsReception(BaseModel):
   """AtsReception entity"""
 
-  pk: int = Field(description='Defines the primary key of the AtsReception')
+  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 AtsReception',
+    alias='id',
+  )
   volume_bought: float = Field(
     description='Volume bought in liters',
     default=0.0,
@@ -24,6 +31,11 @@ class AtsReception(BaseModel):
     description='Date and time when the reception was made',
     default_factory=lambda: datetime.now(UTC),
   )
+
+  @field_serializer('received_at', when_used='always')
+  def serialize_received_at(self, received_at: datetime) -> float:
+    return received_at.timestamp()
+
   fuel_type: str = Field(
     description='Type of fuel used in the reception',
     default='',

layrz_sdk/entities/broadcast/__init__.py

@@ -1,7 +1,7 @@
 from .payload import BroadcastPayload
 from .request import BroadcastRequest
 from .response import BroadcastResponse
-from .result import BroadcastResult
+from .result import BroadcastResult, RawBroadcastResult
 from .service import BroadcastService
 from .status import BroadcastStatus
 
@@ -10,6 +10,7 @@ __all__ = [
   'BroadcastRequest',
   'BroadcastResponse',
   'BroadcastResult',
+  'RawBroadcastResult',
   'BroadcastService',
   'BroadcastStatus',
 ]

layrz_sdk/entities/broadcast/payload.py

@@ -3,11 +3,12 @@
 from datetime import datetime
 from typing import Any
 
-from pydantic import BaseModel, Field
+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
@@ -16,18 +17,37 @@ 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')
+
+  @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')
@@ -35,3 +55,15 @@ class BroadcastPayload(BaseModel):
     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/entities/broadcast/result.py

@@ -1,8 +1,9 @@
 """Broadcast result"""
 
 from datetime import datetime
+from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from .request import BroadcastRequest
 from .response import BroadcastResponse
@@ -18,3 +19,73 @@ class BroadcastResult(BaseModel):
   request: BroadcastRequest = Field(description='Broadcast request')
   response: BroadcastResponse = Field(description='Broadcast response')
   submitted_at: datetime = Field(description='Broadcast submission date')
+
+
+class RawBroadcastResult(BaseModel):
+  """Broadcast result data"""
+
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
+  pk: int | None = Field(
+    default=None,
+    description='Broadcast result ID',
+    alias='id',
+  )
+
+  trigger_id: int | None = Field(default=None, description='Trigger ID')
+  service_id: int | None = Field(description='Service ID')
+  asset_id: int | None = Field(description='Asset ID')
+
+  status: BroadcastStatus = Field(description='Broadcast status')
+
+  @field_serializer('status', when_used='always')
+  def serialize_status(self, status: BroadcastStatus) -> str:
+    return status.value
+
+  algorithm: str | None = Field(
+    default=None,
+    description='Algorithm used for the broadcast, if any',
+  )
+
+  request: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Broadcast request data',
+  )
+
+  response: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Broadcast response data',
+  )
+
+  error: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Error message if the broadcast failed',
+  )
+
+  service: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Service details at the time of the broadcast',
+  )
+
+  asset: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Asset details at the time of the broadcast',
+  )
+
+  trigger: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Trigger details at the time of the broadcast',
+  )
+
+  submitted_at: datetime = Field(
+    description='Broadcast submission date',
+    alias='at',
+  )
+
+  @field_serializer('submitted_at', when_used='always')
+  def serialize_submitted_at(self, v: datetime) -> float:
+    return v.timestamp()

layrz_sdk/entities/broadcast/service.py

@@ -2,12 +2,22 @@
 
 from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class BroadcastService(BaseModel):
   """Broadcast Service object"""
 
-  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(default_factory=dict, description='Service credentials')

layrz_sdk/entities/broadcast/status.py

@@ -8,8 +8,8 @@ class BroadcastStatus(StrEnum):
   """Broadcast result status"""
 
   OK = 'OK'
-  BADREQUEST = 'BADREQUEST'
-  INTERNALERROR = 'INTERNALERROR'
+  BAD_REQUEST = 'BADREQUEST'
+  INTERNAL_ERROR = 'INTERNALERROR'
   UNAUTHORIZED = 'UNAUTHORIZED'
   UNPROCESSABLE = 'UNPROCESSABLE'
   DISCONNECTED = 'DISCONNECTED'

layrz_sdk/entities/case.py

@@ -1,9 +1,7 @@
-"""Events entities"""
-
 from datetime import datetime
-from typing import Any, Optional, Self
+from typing import Any, Self
 
-from pydantic import BaseModel, Field, model_validator
+from pydantic import BaseModel, ConfigDict, Field, field_serializer, model_validator
 
 from .case_ignored_status import CaseIgnoredStatus
 from .case_status import CaseStatus
@@ -14,22 +12,56 @@ from .trigger import Trigger
 class Case(BaseModel):
   """Case entity"""
 
-  pk: int = Field(description='Defines the primary key of the case', 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 case',
+    alias='id',
+  )
   trigger: Trigger = Field(description='Defines the trigger of the case')
   asset_id: int = Field(description='Defines the asset ID of the case')
   comments: list[Comment] = Field(default_factory=list, description='Defines the comments of the case')
   opened_at: datetime = Field(description='Defines the date when the case was opened')
-  closed_at: Optional[datetime] = Field(default=None, description='Defines the date when the case was closed')
+
+  @field_serializer('opened_at', when_used='always')
+  def serialize_opened_at(self, opened_at: datetime) -> float:
+    return opened_at.timestamp()
+
+  closed_at: datetime | None = Field(default=None, description='Defines the date when the case was closed')
+
+  @field_serializer('closed_at', when_used='always')
+  def serialize_closed_at(self, closed_at: datetime | None) -> float | None:
+    return closed_at.timestamp() if closed_at else None
+
   status: CaseStatus = Field(description='Defines the status of the case', default=CaseStatus.CLOSED)
+
+  @field_serializer('status', when_used='always')
+  def serialize_status(self, status: CaseStatus) -> str:
+    return status.value
+
   ignored_status: CaseIgnoredStatus = Field(
     description='Defines the ignored status of the case',
     default=CaseIgnoredStatus.NORMAL,
   )
-  sequence: Optional[int | str] = Field(
+
+  @field_serializer('ignored_status', when_used='always')
+  def serialize_ignored_status(self, ignored_status: CaseIgnoredStatus) -> str:
+    return ignored_status.value
+
+  sequence: int | str | None = Field(
     default=None,
     description='Defines the sequence of the case. This is a unique identifier for the case',
   )
 
+  stack_count: int = Field(
+    default=1,
+    description='Defines how many cases are stacked together. Only applicable if the trigger allows stacking',
+  )
+
   @model_validator(mode='before')
   def _validate_model(cls: Self, data: dict[str, Any]) -> dict[str, Any]:
     """Validate model"""
@@ -37,10 +69,21 @@ class Case(BaseModel):
     if sequence is not None and isinstance(sequence, int):
       trigger = data['trigger']
       if not isinstance(trigger, Trigger):
-        data['sequence'] = f'{trigger["code"]}/{data["pk"]}'
+        if pk := data.get('pk'):
+          data['sequence'] = f'{trigger["code"]}/{pk}'
+        elif id_ := data.get('id'):
+          data['sequence'] = f'{trigger["code"]}/{id_}'
+        else:
+          data['sequence'] = f'{trigger["code"]}/{sequence}'
       else:
         data['sequence'] = f'{trigger.code}/{sequence}'
     else:
       data['sequence'] = f'GENERIC/{data["pk"]}'
 
+    if stack_count := data.get('stack_count'):
+      if not isinstance(stack_count, int) or stack_count < 1:
+        data['stack_count'] = 1
+    else:
+      data['stack_count'] = 1
+
     return data

layrz_sdk/entities/case_ignored_status.py

@@ -11,6 +11,7 @@ class CaseIgnoredStatus(StrEnum):
   IGNORED = 'IGNORED'
   PRESET = 'PRESET'
   AUTO = 'AUTO'
+  EXPIRED = 'EXPIRED'
 
   def __str__(self: Self) -> str:
     """Readable property"""

layrz_sdk/entities/charts/axis_config.py

@@ -1,6 +1,4 @@
-from typing import Optional
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from .chart_data_type import ChartDataType
 
@@ -8,8 +6,18 @@ from .chart_data_type import ChartDataType
 class AxisConfig(BaseModel):
   """Axis configuration"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   label: str = Field(default='', description='Label of the axis')
   measure_unit: str = Field(default='', description='Measure unit of the axis')
-  min_value: Optional[float] = Field(default=None, description='Minimum value of the axis')
-  max_value: Optional[float] = Field(default=None, description='Maximum value of the axis')
+  min_value: float | None = Field(default=None, description='Minimum value of the axis')
+  max_value: float | None = Field(default=None, description='Maximum value of the axis')
   data_type: ChartDataType = Field(default=ChartDataType.DATETIME, description='Data type of the axis')
+
+  @field_serializer('data_type', when_used='always')
+  def serialize_data_type(self, data_type: ChartDataType) -> str:
+    return data_type.value

layrz_sdk/entities/charts/bar_chart.py

@@ -2,7 +2,7 @@
 
 from typing import Any, Self
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from .axis_config import AxisConfig
 from .chart_alignment import ChartAlignment
@@ -14,10 +14,21 @@ from .chart_render_technology import ChartRenderTechnology
 class BarChart(BaseModel):
   """Bar chart configuration"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   x_axis: ChartDataSerie = Field(description='Defines the X Axis of the chart')
   y_axis: list[ChartDataSerie] = Field(description='Defines the Y Axis of the chart', default_factory=list)
   title: str = Field(default='Chart', description='Title of the chart')
   align: ChartAlignment = Field(default=ChartAlignment.CENTER, description='Alignment of the title')
+
+  @field_serializer('align', when_used='always')
+  def serialize_align(self, align: ChartAlignment) -> str:
+    return align.value
+
   x_axis_config: AxisConfig = Field(
     default_factory=lambda: AxisConfig(),
     description='Configuration of the X Axis',

layrz_sdk/entities/charts/chart_data_serie.py

@@ -2,7 +2,7 @@
 
 from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from .chart_data_serie_type import ChartDataSerieType
 from .chart_data_type import ChartDataType
@@ -11,9 +11,25 @@ from .chart_data_type import ChartDataType
 class ChartDataSerie(BaseModel):
   """Chart Serie"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   data: Any = Field(description='Data of the serie')
   color: str = Field(description='Color of the serie', default='#000000')
   label: str = Field(description='Label of the serie', default='')
   serie_type: ChartDataSerieType = Field(description='Type of the serie', default=ChartDataSerieType.LINE)
+
+  @field_serializer('serie_type', when_used='always')
+  def serialize_serie_type(self, serie_type: ChartDataSerieType) -> str:
+    return serie_type.value
+
   data_type: ChartDataType = Field(description='Type of the data', default=ChartDataType.NUMBER)
+
+  @field_serializer('data_type', when_used='always')
+  def serialize_data_type(self, data_type: ChartDataType) -> str:
+    return data_type.value
+
   dashed: bool = Field(description='If the serie should be dashed', default=False)

layrz_sdk/entities/charts/column_chart.py

@@ -2,7 +2,7 @@
 
 from typing import Any, Self
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from layrz_sdk.helpers import convert_to_rgba
 
@@ -16,10 +16,21 @@ from .chart_render_technology import ChartRenderTechnology
 class ColumnChart(BaseModel):
   """Column chart configuration"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   x_axis: ChartDataSerie = Field(description='Defines the X Axis of the chart')
   y_axis: list[ChartDataSerie] = Field(description='Defines the Y Axis of the chart', default_factory=list)
   title: str = Field(default='Chart', description='Title of the chart')
   align: ChartAlignment = Field(default=ChartAlignment.CENTER, description='Alignment of the title')
+
+  @field_serializer('align', when_used='always')
+  def serialize_align(self, align: ChartAlignment) -> str:
+    return align.value
+
   x_axis_config: AxisConfig = Field(
     default_factory=lambda: AxisConfig(),
     description='Configuration of the X Axis',

layrz_sdk/entities/charts/html_chart.py

@@ -1,13 +1,17 @@
-"""HTML chart"""
+from typing import Any, Self
 
-from typing import Any, Dict, Self
-
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class HTMLChart(BaseModel):
   """HTML chart configuration"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   content: str = Field(description='HTML content of the chart', default='<p>N/A</p>')
   title: str = Field(description='Title of the chart', default='Chart')
 

layrz_sdk/entities/charts/line_chart.py

@@ -1,9 +1,7 @@
-"""Line chart"""
-
 import logging
 from typing import Any, Self
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 from .axis_config import AxisConfig
 from .chart_alignment import ChartAlignment
@@ -18,10 +16,21 @@ log = logging.getLogger(__name__)
 class LineChart(BaseModel):
   """Line chart configuration"""
 
+  model_config = ConfigDict(
+    validate_by_name=False,
+    validate_by_alias=True,
+    serialize_by_alias=True,
+  )
+
   x_axis: ChartDataSerie = Field(description='Defines the X Axis of the chart')
   y_axis: list[ChartDataSerie] = Field(description='Defines the Y Axis of the chart', default_factory=list)
   title: str = Field(default='Chart', description='Title of the chart')
   align: ChartAlignment = Field(default=ChartAlignment.CENTER, description='Alignment of the title')
+
+  @field_serializer('align', when_used='always')
+  def serialize_align(self, align: ChartAlignment) -> str:
+    return align.value
+
   x_axis_config: AxisConfig = Field(
     default_factory=lambda: AxisConfig(),
     description='Configuration of the X Axis',