layrz-sdk 3.1.48__tar.gz → 3.1.50__tar.gz

{layrz_sdk-3.1.48 → layrz_sdk-3.1.50}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 3.1.50
+
+- Added `is_fixed` field to `CustomField` entity to indicate if the custom field is fixed or not.
+- Updated `CustomField` entity to include `pk` field as an alias for `id`.
+
+## 3.1.49
+
+- New models `AtsExitExecutionHistory` and  `AtsPossibleExit` for Ats exits add formula field to `Sensor`.
 ## 3.1.48
 
 - Moved `DestinationPhone` entity to its own file, and renamed from `TwilioHostPhone` to `DestinationPhone`.

{layrz_sdk-3.1.48 → layrz_sdk-3.1.50}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.48
+Version: 3.1.50
 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-3.1.48 → layrz_sdk-3.1.50}/layrz_sdk/entities/__init__.py

@@ -8,6 +8,8 @@ from .asset import Asset
 from .asset_constants import AssetConstants
 from .asset_contact import AssetContact
 from .asset_operation_mode import AssetOperationMode
+from .ats_exit_history import AtsExitExecutionHistory
+from .ats_possible_exit import AtsPossibleExit
 from .ats_reception import AtsReception
 from .broadcast import (
   BroadcastPayload,
@@ -103,6 +105,8 @@ __all__ = [
   'AssetContact',
   'AssetMessage',
   'AssetOperationMode',
+  'AtsExitExecutionHistory',
+  'AtsPossibleExit',
   'AtsReception',
   'AxisConfig',
   'BarChart',

layrz_sdk-3.1.50/layrz_sdk/entities/ats_exit_history.py

@@ -0,0 +1,58 @@
+"""Exit Execution History"""
+
+from datetime import datetime
+from typing import Literal, Optional
+
+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(
+    description='ID of the asset from which the exit is initiated',
+  )
+  to_asset: 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',
+  )
+
+  error_response: Optional[str] = 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',
+  )
+
+  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-3.1.50/layrz_sdk/entities/ats_possible_exit.py

@@ -0,0 +1,78 @@
+"""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,
+)
+
+
+class AtsPossibleExit(BaseModel):
+  """AtsPossibleExit entity"""
+
+  pk: int = Field(description='Defines the primary key of the AtsPossibleExit')
+
+  # Nullable “positive big integer” identifier
+  identifier: Optional[conint(ge=0)] = Field(  # type: ignore
+    default=None,
+    description='Nullable positive big integer identifier for the exit',
+  )
+
+  # Volume / gauge snapshots
+  initial_tank_volume: Optional[float] = Field(
+    default=None,
+    description='Initial tank volume in liters',
+  )
+  initial_fluxometer: Optional[float] = Field(
+    default=None,
+    description='Initial fluxometer reading in liters',
+  )
+  total_liters: float = Field(
+    default=0.0,
+    description='Total liters of fuel involved in the exit',
+  )
+
+  # Status flags
+  is_ready: bool = Field(
+    default=False,
+    description='Indicates if the exit is ready',
+  )
+  in_progress: bool = Field(
+    default=False,
+    description='Indicates if the exit is in progress',
+  )
+  is_validated: bool = Field(
+    default=False,
+    description='Indicates if the exit is validated',
+  )
+
+  # Lifecycle timestamps
+  start_at: datetime = Field(
+    default_factory=datetime.now,
+    description='Timestamp when the exit started',
+  )
+  end_at: Optional[datetime] = Field(
+    default=None,
+    description='Timestamp when the exit ended',
+  )
+
+  # Derived / bookkeeping flags
+  is_recalculated: bool = Field(
+    default=False,
+    description='Indicates if the exit has been recalculated',
+  )
+  is_blackbox: Optional[bool] = Field(
+    default=False,
+    description='Indicates if the exit is a blackbox',
+  )
+  false_positive_count: Optional[int] = Field(
+    default=0,
+    description='Count of false positives detected',
+  )
+
+  model_config = ConfigDict(from_attributes=True)  # enables .from_orm()

{layrz_sdk-3.1.48 → layrz_sdk-3.1.50}/layrz_sdk/entities/custom_field.py

@@ -6,5 +6,7 @@ from pydantic import BaseModel, Field
 class CustomField(BaseModel):
   """Custom field definition"""
 
+  pk: int | None = Field(default=None, description='Primary key of the custom field', alias='id')
   name: str = Field(description='Defines the name of the custom field')
   value: str = Field(description='Defines the value of the custom field')
+  is_fixed: bool = Field(default=False, description='Defines if the custom field is fixed or not')

{layrz_sdk-3.1.48 → layrz_sdk-3.1.50}/layrz_sdk/entities/sensor.py

@@ -9,3 +9,7 @@ class Sensor(BaseModel):
   pk: int = Field(description='Defines the primary key of the sensor')
   name: str = Field(description='Defines the name of the sensor')
   slug: str = Field(description='Defines the slug of the sensor')
+  formula: str = Field(
+    default='',
+    description='Defines the formula of the sensor, used for calculations',
+  )

{layrz_sdk-3.1.48 → layrz_sdk-3.1.50}/layrz_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.48
+Version: 3.1.50
 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-3.1.48 → layrz_sdk-3.1.50}/layrz_sdk.egg-info/SOURCES.txt

@@ -28,6 +28,8 @@ layrz_sdk/entities/asset.py
 layrz_sdk/entities/asset_constants.py
 layrz_sdk/entities/asset_contact.py
 layrz_sdk/entities/asset_operation_mode.py
+layrz_sdk/entities/ats_exit_history.py
+layrz_sdk/entities/ats_possible_exit.py
 layrz_sdk/entities/ats_reception.py
 layrz_sdk/entities/case.py
 layrz_sdk/entities/case_ignored_status.py

{layrz_sdk-3.1.48 → layrz_sdk-3.1.50}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "3.1.48"
+version = "3.1.50"
 description = "Layrz SDK for Python"
 authors = [
   {name = "Golden M, Inc.", email = "software@goldenm.com"}

{layrz_sdk-3.1.48 → layrz_sdk-3.1.50}/uv.lock

@@ -343,7 +343,7 @@ wheels = [
 
 [[package]]
 name = "layrz-sdk"
-version = "3.1.48"
+version = "3.1.50"
 source = { editable = "." }
 dependencies = [
     { name = "geopy" },