layrz-sdk 3.1.47__tar.gz → 3.1.49__tar.gz

{layrz_sdk-3.1.47 → layrz_sdk-3.1.49}/PKG-INFO

@@ -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 → layrz_sdk-3.1.49}/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-3.1.49/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.49/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.49/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-3.1.47 → layrz_sdk-3.1.49}/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-3.1.47 → layrz_sdk-3.1.49}/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-3.1.47 → layrz_sdk-3.1.49}/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 → layrz_sdk-3.1.49}/layrz_sdk.egg-info/PKG-INFO

@@ -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 → layrz_sdk-3.1.49}/layrz_sdk.egg-info/SOURCES.txt

@@ -1,15 +1,6 @@
-.gitignore
-CHANGELOG.md
-CODE_OF_CONDUCT.md
-CONTRIBUTING.md
 LICENSE
 README.md
-manual_deploy.py
 pyproject.toml
-uv.lock
-.github/workflows/checks.yml
-.github/workflows/deploy.yml
-.vscode/extensions.json
 layrz_sdk/__init__.py
 layrz_sdk/backwards.py
 layrz_sdk/constants.py
@@ -28,6 +19,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
@@ -37,6 +30,7 @@ layrz_sdk/entities/command_series_ticket.py
 layrz_sdk/entities/comment.py
 layrz_sdk/entities/custom_field.py
 layrz_sdk/entities/custom_report_page.py
+layrz_sdk/entities/destination_phone.py
 layrz_sdk/entities/device.py
 layrz_sdk/entities/event.py
 layrz_sdk/entities/exchange_service.py
@@ -122,5 +116,4 @@ layrz_sdk/helpers/__init__.py
 layrz_sdk/helpers/color.py
 layrz_sdk/lcl/__init__.py
 layrz_sdk/lcl/core.py
-tests/__init__.py
 tests/test_lcl.py

{layrz_sdk-3.1.47 → layrz_sdk-3.1.49}/pyproject.toml

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

layrz_sdk-3.1.47/.github/workflows/checks.yml

@@ -1,50 +0,0 @@
-name: "Checks before merging"
-
-on:
-  pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
-    branches:
-      - '*'
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/goldenm-software/python-builder:uv-3.13-x86
-      options: --user root
-      credentials:
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-    
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Lint
-        run: |
-          uv sync --only-group dev
-          uv run ruff check
-          uv run mypy .
-
-  uniitest:
-    needs: lint
-    runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/goldenm-software/python-builder:uv-3.13-x86
-      options: --user root
-      credentials:
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      
-      - name: Install dependencies
-        run: |
-          uv sync
-          uv run pytest ./tests/
-

layrz_sdk-3.1.47/.github/workflows/deploy.yml

@@ -1,32 +0,0 @@
-name: "Deploy package"
-
-on:
-  push:
-    branches: [ "main" ]
-
-jobs:
-  build:
-    permissions:
-      id-token: write
-      contents: read
-      repository-projects: read
-      packages: read
-
-    runs-on: ubuntu-latest
-    container:
-      image: ghcr.io/goldenm-software/python-builder:uv-3.13-x86
-      options: --user root
-      credentials:
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      
-      - name: Build and upload
-        run: |
-          uv venv --python 3.13
-          uv sync --only-group dev
-          uv run python -m build
-          uv run python -m twine upload -u ${{ secrets.LAYRZ_PYPI_USERNAME }} -p ${{ secrets.LAYRZ_PYPI_PASSWORD }} dist/*

layrz_sdk-3.1.47/.gitignore

@@ -1,19 +0,0 @@
-/dist
-/build
-/*.egg-info
-/.pypirc
-/test.py
-/**/*.pyc
-/.venv
-/site
-
-/**/*/__pycache__
-
-tests.py
-*.xlsx
-
-.ruff_cache
-.mypy_cache
-.pytest_cache
-
-.env

layrz_sdk-3.1.47/.vscode/extensions.json

@@ -1,9 +0,0 @@
-{
-  "recommendations": [
-    "ms-python.python",
-    "charliermarsh.ruff",
-    "ms-python.vscode-pylance",
-    "njpwerner.autodocstring",
-    "oderwat.indent-rainbow"
-  ]
-}