layrz-sdk 3.1.50__py3-none-any.whl → 4.0.1__py3-none-any.whl

layrz_sdk/entities/__init__.py

@@ -8,7 +8,9 @@ from .asset import Asset
 from .asset_constants import AssetConstants
 from .asset_contact import AssetContact
 from .asset_operation_mode import AssetOperationMode
+from .ats_entry import AtsEntry
 from .ats_exit_history import AtsExitExecutionHistory
+from .ats_possible_entry import AtsPossibleEntry
 from .ats_possible_exit import AtsPossibleExit
 from .ats_reception import AtsReception
 from .broadcast import (
@@ -108,6 +110,8 @@ __all__ = [
   'AtsExitExecutionHistory',
   'AtsPossibleExit',
   'AtsReception',
+  'AtsEntry',
+  'AtsPossibleEntry',
   'AxisConfig',
   'BarChart',
   'BroadcastPayload',

layrz_sdk/entities/action.py

@@ -23,29 +23,16 @@ class Action(BaseModel):
     },
   }
 
-  pk: int = Field(
-    ...,
-    description='Primary key of the action entity',
-    alias='id',
-  )
-  name: str = Field(
-    ...,
-    description='Name of the action',
-  )
-  kind: ActionKind = Field(
-    ...,
-    description='Kind of the action',
-  )
+  pk: int = Field(..., description='Primary key of the action entity', alias='id')
+  name: str = Field(..., description='Name of the action')
+  kind: ActionKind = Field(..., description='Kind of the action')
 
   command_id: int | None = Field(
     default=None,
     description='Tag ID associated with the action to send commands to primary devices',
   )
 
-  subkind: ActionSubKind = Field(
-    default=ActionSubKind.UNUSED,
-    description='Subkind of the action',
-  )
+  subkind: ActionSubKind = Field(default=ActionSubKind.UNUSED, description='Subkind of the action')
 
   wait_for_image: bool = Field(
     default=False,
@@ -80,7 +67,4 @@ class Action(BaseModel):
     description='Ownership of the new geofence created by the action',
   )
 
-  owner_id: int | None = Field(
-    default=None,
-    description='Owner ID',
-  )
+  owner_id: int | None = Field(default=None, description='Owner ID')

layrz_sdk/entities/action_geofence_ownership.py

@@ -1,15 +1,10 @@
 """Action geofence ownership"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class ActionGeofenceOwnership(str, Enum):
+class ActionGeofenceOwnership(StrEnum):
   """
   Action geofence ownership definition
   """

layrz_sdk/entities/action_kind.py

@@ -1,15 +1,10 @@
 """Action kind"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class ActionKind(str, Enum):
+class ActionKind(StrEnum):
   """
   Action kind definition
   """

layrz_sdk/entities/action_subkind.py

@@ -1,15 +1,10 @@
 """Action sub kind"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class ActionSubKind(str, Enum):
+class ActionSubKind(StrEnum):
   """
   Action sub kind definition
   """

layrz_sdk/entities/asset.py

@@ -1,15 +1,9 @@
 """Asset Entity"""
 
-import sys
-from typing import Any
+from typing import Any, Self
 
 from pydantic import BaseModel, Field, model_validator
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
 from .asset_contact import AssetContact
 from .asset_operation_mode import AssetOperationMode
 from .custom_field import CustomField
@@ -21,14 +15,20 @@ from .static_position import StaticPosition
 class Asset(BaseModel):
   """Asset entity definition"""
 
-  pk: int = Field(description='Defines the primary key of the asset')
+  model_config = {
+    'json_encoders': {
+      AssetOperationMode: lambda v: v.value,
+    }
+  }
+
+  pk: int = Field(description='Defines the primary key of the asset', alias='id')
   name: str = Field(description='Defines the name of the asset')
   vin: str | None = Field(
     default=None,
     description='Defines the serial number of the asset, may be an VIN, or any other unique identifier',
   )
   plate: str | None = Field(default=None, description='Defines the plate number of the asset')
-  asset_type: int | None = Field(description='Defines the type of the asset', alias='kind_id', default=None)
+  kind_id: int | None = Field(description='Defines the type of the asset', default=None)
   operation_mode: AssetOperationMode = Field(description='Defines the operation mode of the asset')
   sensors: list[Sensor] = Field(default_factory=list, description='Defines the list of sensors of the asset')
   custom_fields: list[CustomField] = Field(
@@ -85,3 +85,8 @@ class Asset(BaseModel):
     default=None,
     description='Owner ID',
   )
+
+  @property
+  def asset_type(self: Self) -> int | None:
+    """Get asset type"""
+    return self.kind_id

layrz_sdk/entities/asset_constants.py

@@ -15,7 +15,7 @@ class AssetConstants(BaseModel):
   }
 
   distance_traveled: float = Field(default=0.0, description='Total distance traveled by the asset in meters')
-  primary_device: str = Field(default='N/a', description='Primary device associated with the asset')
+  primary_device: str = Field(default='N/A', description='Primary device associated with the asset')
   elapsed_time: timedelta = Field(
     default=timedelta(seconds=0),
     description='Total elapsed time for the asset in seconds',

layrz_sdk/entities/asset_operation_mode.py

@@ -1,15 +1,10 @@
 """Asset Operation Mode"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class AssetOperationMode(str, Enum):
+class AssetOperationMode(StrEnum):
   """
   Asset Operation mode definition
   It's an enum of the operation mode of the asset.

layrz_sdk/entities/ats_entry.py

@@ -0,0 +1,14 @@
+"""Entry entity"""
+
+from pydantic import BaseModel, Field
+
+
+class AtsEntry(BaseModel):
+  """Entry entity"""
+
+  pk: int = Field(description='Defines the primary key of the Function', alias='id')
+  old_tank_level: float = Field(description='Old tank level in liters', default=0.0)
+  new_tank_level: float = Field(description='New tank level in liters', default=0.0)
+  density: float = Field(description='Density of the fuel in kg/m3', default=0.0)
+  temperature: float = Field(description='Temperature of the fuel in Celsius', default=0.0)
+  is_executed_by_command: bool = Field(description='Indicates if the entry is executed by command', default=False)

layrz_sdk/entities/ats_exit_history.py

@@ -1,58 +1,42 @@
 """Exit Execution History"""
 
 from datetime import datetime
-from typing import Literal, Optional
+from typing import Literal
 
 from pydantic import (
   BaseModel,
   ConfigDict,
   Field,
-  PositiveInt,  # useful if you later want a non-nullable positive int
-  conint,
 )
 
 
 class AtsExitExecutionHistory(BaseModel):
-  pk: int = Field(description='Primary key of the Exit Execution History')
-
-  from_asset: int = Field(
+  model_config = {
+    'json_encoders': {
+      datetime: lambda v: v.timestamp(),
+    }
+  }
+  pk: int = Field(description='Primary key of the Exit Execution History', alias='id')
+
+  from_asset_id: int = Field(
     description='ID of the asset from which the exit is initiated',
   )
-  to_asset: int = Field(
+  to_asset_id: int = Field(
     description='ID of the asset to which the exit is directed',
   )
 
-  status: Literal['PENDING', 'FAILED', 'SUCCESS'] = Field(
-    default='PENDING',
-  )
-  from_app: Optional[Literal['ATSWEB', 'ATSMOBILE', 'NFC']] = Field(
-    default=None,
-    description='Application from which the exit was initiated',
-  )
+  status: Literal['PENDING', 'FAILED', 'SUCCESS'] = Field(default='PENDING')
 
-  error_response: Optional[str] = Field(
+  from_app: Literal['ATSWEB', 'ATSMOBILE', 'NFC'] | None = Field(
     default=None,
-    description='Error response received during the exit process',
-  )
-
-  generated_by: int = Field(
-    description='ID of the user or system that initiated the exit',
-  )
-
-  queue_id: Optional[int] = Field(
-    default=None,
-    description='ID of the queue associated with the exit',
-  )
-  to_asset_mileage: Optional[float] = Field(
-    default=None,
-    description='Mileage of the asset to which the exit is directed',
+    description='Application from which the exit was initiated',
   )
 
-  created_at: datetime = Field(
-    description='Timestamp when the exit was created',
-  )
-  updated_at: datetime = Field(
-    description='Timestamp when the exit was last updated',
-  )
+  error_response: str | None = Field(default=None, description='Error response received during the exit process')
+  generated_by_id: int = Field(description='ID of the user or system that initiated the exit')
+  queue_id: int | None = Field(default=None, description='ID of the queue associated with the exit')
+  to_asset_mileage: float | None = Field(default=None, description='Mileage of the asset to which the exit is directed')
 
+  created_at: datetime = Field(description='Timestamp when the exit was created')
+  updated_at: datetime = Field(description='Timestamp when the exit was last updated')
   model_config = ConfigDict(from_attributes=True)

layrz_sdk/entities/ats_possible_entry.py

@@ -0,0 +1,27 @@
+"""Entry entity"""
+
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+
+class AtsPossibleEntry(BaseModel):
+  """Entry entity"""
+
+  initial_tank_level: float = Field(description='Initial tank level in liters', default=0.0)
+  tank_accumulator: float = Field(description='Tank accumulator in liters', default=0.0)
+  is_ready: bool = Field(description='Indicates if the entry is ready', default=False)
+  is_validated: bool = Field(description='Indicates if the entry is validated', default=False)
+  start_at: datetime = Field(description='Start time of the entry')
+  end_at: datetime | None = Field(description='End time of the entry')
+  accumulator_history: list[float] = Field(
+    default_factory=list, description='History of the tank accumulator in liters'
+  )
+  is_recalculated: bool = Field(description='Indicates if the entry is recalculated', default=False)
+  is_blackbox: bool = Field(description='Indicates if the entry is a black box', default=False)
+  is_executed_by_command: bool = Field(description='Indicates if the entry is executed by command', default=False)
+  is_ready_by_reception: bool = Field(description='Indicates if the entry is ready by reception', default=False)
+  false_positive_count: int = Field(description='Count of false positives for the entry', default=0)
+  reception_id: int | None = Field(
+    description='Reception ID associated with the entry', default=None, alias='receptionId'
+  )

layrz_sdk/entities/ats_possible_exit.py

@@ -1,34 +1,33 @@
 """Ats Exit entity"""
 
 from datetime import datetime
-from typing import Optional
 
-from pydantic import (
-  BaseModel,
-  ConfigDict,
-  Field,
-  PositiveInt,  # useful if you later want a non-nullable positive int
-  conint,
-)
+from pydantic import BaseModel, Field
 
 
 class AtsPossibleExit(BaseModel):
   """AtsPossibleExit entity"""
 
-  pk: int = Field(description='Defines the primary key of the AtsPossibleExit')
+  model_config = {
+    'json_encoders': {
+      datetime: lambda v: v.timestamp(),
+    }
+  }
 
-  # Nullable “positive big integer” identifier
-  identifier: Optional[conint(ge=0)] = Field(  # type: ignore
+  pk: int = Field(description='Defines the primary key of the AtsPossibleExit', alias='id')
+
+  identifier: int | None = Field(
     default=None,
     description='Nullable positive big integer identifier for the exit',
+    ge=0,
   )
 
   # Volume / gauge snapshots
-  initial_tank_volume: Optional[float] = Field(
+  initial_tank_volume: float | None = Field(
     default=None,
     description='Initial tank volume in liters',
   )
-  initial_fluxometer: Optional[float] = Field(
+  initial_fluxometer: float | None = Field(
     default=None,
     description='Initial fluxometer reading in liters',
   )
@@ -56,7 +55,7 @@ class AtsPossibleExit(BaseModel):
     default_factory=datetime.now,
     description='Timestamp when the exit started',
   )
-  end_at: Optional[datetime] = Field(
+  end_at: datetime | None = Field(
     default=None,
     description='Timestamp when the exit ended',
   )
@@ -66,13 +65,11 @@ class AtsPossibleExit(BaseModel):
     default=False,
     description='Indicates if the exit has been recalculated',
   )
-  is_blackbox: Optional[bool] = Field(
+  is_blackbox: bool | None = Field(
     default=False,
     description='Indicates if the exit is a blackbox',
   )
-  false_positive_count: Optional[int] = Field(
+  false_positive_count: int | None = Field(
     default=0,
     description='Count of false positives detected',
   )
-
-  model_config = ConfigDict(from_attributes=True)  # enables .from_orm()

layrz_sdk/entities/ats_reception.py

@@ -1,10 +1,11 @@
 """Ats Reception entity"""
 
 from datetime import datetime
-from typing import Optional
 
 from pydantic import BaseModel, Field
 
+from layrz_sdk.constants import UTC
+
 
 class AtsReception(BaseModel):
   """AtsReception entity"""
@@ -14,12 +15,24 @@ class AtsReception(BaseModel):
     description='Volume bought in liters',
     default=0.0,
   )
-  real_volume: Optional[float] = Field(
+  real_volume: float | None = Field(
     description='Real volume in liters',
     default=None,
   )
 
   received_at: datetime = Field(
     description='Date and time when the reception was made',
-    default_factory=datetime.now,
+    default_factory=lambda: datetime.now(UTC),
+  )
+  fuel_type: str = Field(
+    description='Type of fuel used in the reception',
+    default='',
+  )
+  is_merged: bool = Field(
+    description='Indicates if the reception is merged with another',
+    default=False,
+  )
+  order_id: int | None = Field(
+    description='Order ID associated with the reception',
+    default=None,
   )

layrz_sdk/entities/broadcast/service.py

@@ -8,6 +8,6 @@ from pydantic import BaseModel, Field
 class BroadcastService(BaseModel):
   """Broadcast Service object"""
 
-  pk: int = Field(..., description='Service ID')
+  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

@@ -1,15 +1,10 @@
 """Broadcast result Status"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class BroadcastStatus(str, Enum):
+class BroadcastStatus(StrEnum):
   """Broadcast result status"""
 
   OK = 'OK'

layrz_sdk/entities/case.py

@@ -1,8 +1,7 @@
 """Events entities"""
 
-import sys
 from datetime import datetime
-from typing import Any, Optional
+from typing import Any, Optional, Self
 
 from pydantic import BaseModel, Field, model_validator
 
@@ -11,16 +10,11 @@ from .case_status import CaseStatus
 from .comment import Comment
 from .trigger import Trigger
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
 
 class Case(BaseModel):
   """Case entity"""
 
-  pk: int = Field(description='Defines the primary key of the case')
+  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')

layrz_sdk/entities/case_ignored_status.py

@@ -1,13 +1,8 @@
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class CaseIgnoredStatus(str, Enum):
+class CaseIgnoredStatus(StrEnum):
   """
   Case ignore status, will define what kind ignore happened.
   """

layrz_sdk/entities/case_status.py

@@ -1,13 +1,8 @@
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class CaseStatus(str, Enum):
+class CaseStatus(StrEnum):
   """Case status enum"""
 
   PENDING = 'PENDING'

layrz_sdk/entities/charts/bar_chart.py

@@ -1,7 +1,6 @@
 """Bar chart"""
 
-import sys
-from typing import Any
+from typing import Any, Self
 
 from pydantic import BaseModel, Field
 
@@ -11,11 +10,6 @@ from .chart_data_serie import ChartDataSerie
 from .chart_data_serie_type import ChartDataSerieType
 from .chart_render_technology import ChartRenderTechnology
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
 
 class BarChart(BaseModel):
   """Bar chart configuration"""

layrz_sdk/entities/charts/chart_alignment.py

@@ -1,15 +1,10 @@
 """Chart alignment"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class ChartAlignment(str, Enum):
+class ChartAlignment(StrEnum):
   """
   Chart Alignment
   """

layrz_sdk/entities/charts/chart_color.py

@@ -1,15 +1,10 @@
 """Chart alignment"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class ChartColor(str, Enum):
+class ChartColor(StrEnum):
   """Chart color list, ideal to use to colorize the series"""
 
   RED = '#F44336'

layrz_sdk/entities/charts/chart_data_serie_type.py

@@ -1,28 +1,23 @@
 """Chart Serie type"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class ChartDataSerieType(Enum):
+class ChartDataSerieType(StrEnum):
   """
   Chart data serie type
   """
 
-  NONE = None
+  NONE = 'None'
   LINE = 'line'
   AREA = 'area'
   SCATTER = 'scatter'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str:
     """Readable property"""
     return self.name
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str:
     """Readable property"""
     return f'ChartDataSerieType.{self.name}'

layrz_sdk/entities/charts/chart_data_type.py

@@ -1,15 +1,10 @@
 """Chart Data type"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class ChartDataType(str, Enum):
+class ChartDataType(StrEnum):
   """
   Chart Data Type
   """

layrz_sdk/entities/charts/chart_render_technology.py

@@ -1,15 +1,10 @@
 """Chart rendering technology / library"""
 
-import sys
-from enum import Enum
+from enum import StrEnum
+from typing import Self
 
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
 
-
-class ChartRenderTechnology(str, Enum):
+class ChartRenderTechnology(StrEnum):
   """
   Chart Alignment
   """