layrz-sdk 3.1.47__py3-none-any.whl → 3.1.49__py3-none-any.whl

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,
@@ -53,6 +55,7 @@ from .command_series_ticket import CommandSeriesTicket, CommandSeriesTicketStatu
 from .comment import Comment
 from .custom_field import CustomField
 from .custom_report_page import CustomReportPage
+from .destination_phone import DestinationPhone
 from .device import Device
 from .event import Event
 from .exchange_service import ExchangeService
@@ -65,7 +68,7 @@ from .modbus import ModbusConfig, ModbusParameter, ModbusSchema, ModbusStatus, M
 from .notification_type import TwilioNotificationType
 from .operation import Operation
 from .operation_case_payload import OperationCaseCommentPayload, OperationCasePayload
-from .operation_payload import OperationPayload, TwilioHostPhone
+from .operation_payload import OperationPayload
 from .operation_type import OperationType
 from .outbound_service import OutboundService
 from .platform import Platform
@@ -102,6 +105,8 @@ __all__ = [
   'AssetContact',
   'AssetMessage',
   'AssetOperationMode',
+  'AtsExitExecutionHistory',
+  'AtsPossibleExit',
   'AtsReception',
   'AxisConfig',
   'BarChart',
@@ -190,7 +195,7 @@ __all__ = [
   'TriggerCommentPattern',
   'TriggerGeofenceKind',
   'TriggerKind',
-  'TwilioHostPhone',
+  'DestinationPhone',
   'TwilioNotificationType',
   'User',
   'Waypoint',

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/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/entities/destination_phone.py

@@ -0,0 +1,29 @@
+import sys
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+from pydantic import BaseModel, Field
+
+
+class DestinationPhone(BaseModel):
+  """Destination Phone"""
+
+  phone_number: str = Field(
+    ...,
+    description='Defines the phone number for Twilio notifications',
+    alias='phoneNumber',
+  )
+
+  country_code: str = Field(
+    ...,
+    description='Defines the country code for the phone number',
+    alias='countryCode',
+  )
+
+  @property
+  def formatted_phone_number(self: Self) -> str:
+    """Returns the formatted phone number"""
+    return f'{self.country_code}{self.phone_number}'

layrz_sdk/entities/operation.py

@@ -5,6 +5,7 @@ from typing import Any
 
 from pydantic import BaseModel, Field
 
+from .destination_phone import DestinationPhone
 from .notification_type import TwilioNotificationType
 from .operation_type import OperationType
 from .platform import Platform
@@ -99,7 +100,7 @@ class Operation(BaseModel):
     alias='notification_type',
   )
 
-  host_phone: str | None = Field(
+  host_phone: DestinationPhone | None = Field(
     default=None,
     description='Defines the host phone number for Twilio notifications',
   )
@@ -114,7 +115,7 @@ class Operation(BaseModel):
     description='Defines the token for the operation, used for authentication in some cases',
   )
 
-  destination_phones: list[str] = Field(
+  destination_phones: list[DestinationPhone] = Field(
     default_factory=list,
     description='Defines the destination phone numbers for Twilio notifications',
   )

layrz_sdk/entities/operation_payload.py

@@ -4,6 +4,8 @@ import sys
 from datetime import datetime, timedelta
 from typing import Any
 
+from layrz_sdk.entities.destination_phone import DestinationPhone
+
 if sys.version_info >= (3, 11):
   from typing import Self
 else:
@@ -24,27 +26,6 @@ from layrz_sdk.entities.sound_effect import SoundEffect
 from layrz_sdk.entities.trigger import Trigger
 
 
-class TwilioHostPhone(BaseModel):
-  """Twilio Host Phone entity"""
-
-  phone_number: str = Field(
-    ...,
-    description='Defines the phone number for Twilio notifications',
-    alias='phoneNumber',
-  )
-
-  country_code: str = Field(
-    ...,
-    description='Defines the country code for the phone number',
-    alias='countryCode',
-  )
-
-  @property
-  def formatted_phone_number(self: Self) -> str:
-    """Returns the formatted phone number"""
-    return f'{self.country_code}{self.phone_number}'
-
-
 class OperationPayload(BaseModel):
   """Operation Payload entity"""
 
@@ -225,12 +206,12 @@ class OperationPayload(BaseModel):
   )
 
   ## For usage of Twilio operations
-  destinations: list[TwilioHostPhone] = Field(
+  destinations: list[DestinationPhone] = Field(
     default_factory=list,
     description='Defines the destination phone numbers for Twilio notifications',
   )
 
-  twilio_host_phone: TwilioHostPhone | None = Field(
+  twilio_host_phone: DestinationPhone | None = Field(
     default=None,
     description='Defines the host phone number for Twilio notifications',
     alias='hostPhone',

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.47.dist-info → layrz_sdk-3.1.49.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.47
+Version: 3.1.49
 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.47.dist-info → layrz_sdk-3.1.49.dist-info}/RECORD

@@ -2,7 +2,7 @@ layrz_sdk/__init__.py,sha256=OutylN0QazaeDVIA5NRDVyzwfYnZkAwVQzT-2F6iX2M,28
 layrz_sdk/backwards.py,sha256=f_DUxvbZs-p287-wGwxx0NVUK7Gha-cNP_hHRAJWAq0,85
 layrz_sdk/constants.py,sha256=guXfIsVAcex76OEMv6DAJy1km1A_WUfWJuUO2Lo3kXE,344
 layrz_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-layrz_sdk/entities/__init__.py,sha256=LBHHRML6XLUofjamv_HcYIMLinO6sFdNyd4kLBH-Z-s,5779
+layrz_sdk/entities/__init__.py,sha256=zVbcAEYzGIzqd_un63qKm-p9lv3xS2nTsBYflYn4ghE,5962
 layrz_sdk/entities/action.py,sha256=QTe2L2NCJqxCUn-kb-qgjgQ9gn9nGT-qXcVyHvjXF20,2089
 layrz_sdk/entities/action_geofence_ownership.py,sha256=PHu6495IUb9biKLXGEy4ESyrzmpP2AQbJiquYk9Kz7c,678
 layrz_sdk/entities/action_kind.py,sha256=u5CI9y86f6-zHKSf4gRhoqcK5azle1UAHqa8-033x88,1277
@@ -11,6 +11,8 @@ layrz_sdk/entities/asset.py,sha256=b8dCfQRsZsze-7X8Ydwi_lhBh7VEPx-KHalYSofUC40,2
 layrz_sdk/entities/asset_constants.py,sha256=dqBK9mq6N-WJLd-RQ7rgDSmcBchR1hYjhOKwd3O7PqQ,600
 layrz_sdk/entities/asset_contact.py,sha256=ptxItpob4VdQeM6qMUtSZgZxBw5DfKp3kVfBVlXpujo,422
 layrz_sdk/entities/asset_operation_mode.py,sha256=1RLRpbUm6jwxivdKbB2O6wdnrhyqaccQ_moA-wrnzdQ,639
+layrz_sdk/entities/ats_exit_history.py,sha256=znbBI-rYLF8_1ojsetID4F7gkce-FV-pVzNSs7pmqzA,1523
+layrz_sdk/entities/ats_possible_exit.py,sha256=ZJKu2-a5w0PXV7_GsPrY8LiPoKZoAI0pMGPnpG_nqfk,2016
 layrz_sdk/entities/ats_reception.py,sha256=yog5b5vvWKOHj67YMamJ_m7zodLcrYSSEwdXxtaLDCk,596
 layrz_sdk/entities/case.py,sha256=0dSfZCezDuEEED42rws-zntqa_Em9oFevlXSPrIeIC8,1877
 layrz_sdk/entities/case_ignored_status.py,sha256=9nRIKJqaZ9EBXYuI4j4v2hCd0C6GtWPDKsbdE2Srt1g,517
@@ -20,6 +22,7 @@ layrz_sdk/entities/command_series_ticket.py,sha256=Bn1j7q9qsnr-Kq8rvYOtJe8cTRySh
 layrz_sdk/entities/comment.py,sha256=1YSWVxXlpoicVVHv3mvkNlfUTfcOMxZYfb4YmwrxchY,414
 layrz_sdk/entities/custom_field.py,sha256=jurONu01Ph-Qq8uuxdzxoQ6i7BqbZe64vO2ESvQDSFg,277
 layrz_sdk/entities/custom_report_page.py,sha256=eqtoFOgip0z4_cMql1tHgaR4JiVEYlfbzd9ZJ7ZLyrM,1231
+layrz_sdk/entities/destination_phone.py,sha256=Wr8p27dyqVfYFKf8-bP6aJVAFwcJ6LvP_0Qp3Ov31A4,645
 layrz_sdk/entities/device.py,sha256=rqBJf0L-cIfxE6ONwGHVx_L0StyQL-ycvSVzug4iIwQ,732
 layrz_sdk/entities/event.py,sha256=IDcPwtKbqvX8S2QQei3yFbA2M8NeSYGFoXo3AaSmdHI,720
 layrz_sdk/entities/exchange_service.py,sha256=DOSffjwxZ7tcRA6nk0QCf-dpO981jqP9FX_wjvviSGI,665
@@ -29,9 +32,9 @@ layrz_sdk/entities/geofence_category.py,sha256=YtUx7z-NmnQhYL8GedQRMR4xsis_BnPNy
 layrz_sdk/entities/last_message.py,sha256=QNgF0xCQ6uLFDMmKQCjSRhGS1Bq7akw5pv6ZIiFlwfY,268
 layrz_sdk/entities/message.py,sha256=eFID7CEBnwp6-MsfhK09JPSJzp7iRbQibJOe_ELgQ9A,563
 layrz_sdk/entities/notification_type.py,sha256=yfuQhiIDaOfWCc8p9fZp8umaOU4ELdGrA_b5MWYHA5U,757
-layrz_sdk/entities/operation.py,sha256=xXD_-dqLW5c6J3aRMRxJh9tebaDKl7WPOoq0Q-chyjA,4887
+layrz_sdk/entities/operation.py,sha256=qTtPyNjpEzdnfxuX88iviyhfHBlMGdFgf9bPSkrKLDA,4961
 layrz_sdk/entities/operation_case_payload.py,sha256=ZOimwmt3fRz01U5Mz0KqeKbS9AGdIDJvZBhPI3c50xQ,2657
-layrz_sdk/entities/operation_payload.py,sha256=wJ1_0A5Ml-NNLwZ-rnhMqS-sFCIIJmWK9s87cgloc5U,8786
+layrz_sdk/entities/operation_payload.py,sha256=SOkg6xlj70C9iFZmvOchTm0GdZtbwC7-ISv4dHoWmo8,8356
 layrz_sdk/entities/operation_type.py,sha256=I7wzqvc-JlqmPxYbigAV32Sb5IXFeZ65Z156imC-MXk,1027
 layrz_sdk/entities/outbound_service.py,sha256=AUivyq_AuA1ZPBOYOfRoQsGrMCYNLGiHX1QycDFn230,651
 layrz_sdk/entities/platform.py,sha256=4nEXvBorqH2LndQ6iYBmvdqAL-ELGTftEzvIsjej0p0,714
@@ -47,7 +50,7 @@ layrz_sdk/entities/report_header.py,sha256=ChsxCqHe-Ik2t3DO3kxyja2WgILzxg12NPFcr
 layrz_sdk/entities/report_page.py,sha256=ebhFEI6dYRM2jZzjedyIJSyPBAggySpmZjtcaILltxA,550
 layrz_sdk/entities/report_row.py,sha256=t2Rk7LeforU-sD5abqnTQES2Oac8dmEXMLLo_18xg6Y,788
 layrz_sdk/entities/request_type.py,sha256=xOD33EOpHRy8307w5h_4axBPLuIgKTNNLid4hnvp2TQ,496
-layrz_sdk/entities/sensor.py,sha256=9Q6RGb9qDvyLS4tELZOZtPlaiWi9An5Vf0gGLGWIRhE,312
+layrz_sdk/entities/sensor.py,sha256=_S8xND8JyS-edS73Cnj29GHWqncdN3e7599C7URmHLc,432
 layrz_sdk/entities/sound_effect.py,sha256=lsGK3keNXyuZ7MEEFlxt-BoiRhurq8-hWpGFYE_Qzqo,1151
 layrz_sdk/entities/static_position.py,sha256=xTbTWRPQLZqTgPQnyIMOoMHiNi42AzmVRfgDMM4m03c,365
 layrz_sdk/entities/text_alignment.py,sha256=YqUqj07c4XzHZLdaqNw1FEUpneWoJU5UU3eicC5-Sps,496
@@ -105,8 +108,8 @@ layrz_sdk/helpers/__init__.py,sha256=5iW3z2m3jrYhvTfxX-p-QTkR9X9oTKfEsbtVOg9jFFY
 layrz_sdk/helpers/color.py,sha256=dlpMafbM-4Wd9D9hMbbnZJf4ALkpie_ZmBR2Vz_YCmM,1203
 layrz_sdk/lcl/__init__.py,sha256=U967AWANkL3u_YVxMNAYlh8jkZ6hqHfStacz7yz6sOA,89
 layrz_sdk/lcl/core.py,sha256=T80A3hL7SeqRNSfl5SrPAgwIEf-enoAVv9ldwJNzqsA,24786
-layrz_sdk-3.1.47.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
-layrz_sdk-3.1.47.dist-info/METADATA,sha256=rU1CIC_hQpIRJ1hlEgbOReYB4JWWzhq16EO7ymoJEXU,2109
-layrz_sdk-3.1.47.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-layrz_sdk-3.1.47.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
-layrz_sdk-3.1.47.dist-info/RECORD,,
+layrz_sdk-3.1.49.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
+layrz_sdk-3.1.49.dist-info/METADATA,sha256=IifviDhXVKKVspYWArzX15bhfYguN8lvBVJrPL7soDs,2109
+layrz_sdk-3.1.49.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+layrz_sdk-3.1.49.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
+layrz_sdk-3.1.49.dist-info/RECORD,,