layrz-sdk 3.1.31__tar.gz → 3.1.33__tar.gz

{layrz_sdk-3.1.31 → layrz_sdk-3.1.33}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 3.1.33
+
+- New `Action` model
+- New `ActionKind`, `ActionSubKind`, `GeofenceCategory` and `ActionGeofenceOwnership` enums
+
+## 3.1.32
+
+- New `AtsREception` model
+
 ## 3.1.31
 
 - Expanded `Trigger` model with new fields (Almost closed to the Dart equivalent on [`layrz_models`](https://pub.dev/packages/layrz_models))

{layrz_sdk-3.1.31 → layrz_sdk-3.1.33}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.31
+Version: 3.1.33
 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>
-License: MIT License
+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>
+License-Expression: MIT
 Project-URL: Repository, https://github.com/goldenm-software/layrz-sdk
 Project-URL: Changelog, https://github.com/goldenm-software/layrz-sdk/blob/main/CHANGELOG.md
 Keywords: sdk,goldenm,lcl,layrz compute language,layrz
@@ -14,7 +14,6 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{layrz_sdk-3.1.31 → layrz_sdk-3.1.33}/layrz_sdk/entities/__init__.py

@@ -1,8 +1,13 @@
 """Init file"""
 
+from .action import Action
+from .action_geofence_ownership import ActionGeofenceOwnership
+from .action_kind import ActionKind
+from .action_subkind import ActionSubKind
 from .asset import Asset
 from .asset_constants import AssetConstants
 from .asset_operation_mode import AssetOperationMode
+from .ats_reception import AtsReception
 from .broadcast import (
   BroadcastPayload,
   BroadcastRequest,
@@ -50,6 +55,7 @@ from .device import Device
 from .event import Event
 from .function import Function
 from .geofence import Geofence
+from .geofence_category import GeofenceCategory
 from .last_message import LastMessage
 from .message import Message
 from .modbus import ModbusConfig, ModbusParameter, ModbusSchema, ModbusStatus, ModbusWait
@@ -152,4 +158,10 @@ __all__ = [
   'TriggerCaseKind',
   'TriggerCommentPattern',
   'Weekday',
+  'AtsReception',
+  'Action',
+  'ActionKind',
+  'ActionSubKind',
+  'GeofenceCategory',
+  'ActionGeofenceOwnership',
 ]

layrz_sdk-3.1.33/layrz_sdk/entities/action.py

@@ -0,0 +1,81 @@
+"""Action entity"""
+
+from datetime import timedelta
+
+from pydantic import BaseModel, Field
+
+from .action_geofence_ownership import ActionGeofenceOwnership
+from .action_kind import ActionKind
+from .action_subkind import ActionSubKind
+from .geofence_category import GeofenceCategory
+
+
+class Action(BaseModel):
+  """Action entity"""
+
+  model_config = {
+    'json_encoders': {
+      timedelta: lambda v: v.total_seconds(),
+      ActionKind: lambda v: v.value,
+      ActionSubKind: lambda v: v.value,
+      GeofenceCategory: lambda v: v.value,
+      ActionGeofenceOwnership: lambda v: v.value,
+    },
+  }
+
+  pk: str = 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: str | 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',
+  )
+
+  wait_for_image: bool = Field(
+    default=False,
+    description='Whether to wait for an image to be taken before executing the action',
+    alias='watch_image',
+  )
+
+  geofence_cateogry: GeofenceCategory = Field(
+    default=GeofenceCategory.NONE,
+    description='Geofence category of the action',
+  )
+
+  geofence_name_formula: str | None = Field(
+    default=None,
+    description='Formula to generate the geofence name',
+    alias='geofence_name',
+  )
+
+  geofence_radius: float | None = Field(
+    default=None,
+    description='Radius of the geofence in meters',
+    alias='geofence_radius',
+  )
+
+  mappit_route_id: str | None = Field(
+    default=None,
+    description='Route ID for Mappit integration',
+  )
+
+  new_geofence_ownership: ActionGeofenceOwnership = Field(
+    default=ActionGeofenceOwnership.NONE,
+    description='Ownership of the new geofence created by the action',
+  )

layrz_sdk-3.1.33/layrz_sdk/entities/action_geofence_ownership.py

@@ -0,0 +1,32 @@
+"""Action geofence ownership"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ActionGeofenceOwnership(str, Enum):
+  """
+  Action geofence ownership definition
+  """
+
+  NONE = 'NONE'
+  """ Not assigned to any owner (Orphan) """
+
+  ASSET = 'ASSET'
+  """ Assigns the geofence to the owner of the asset """
+
+  ACTION = 'ACTION'
+  """ Assigns the geofence to the owner of the action """
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ActionGeofenceOwnership.{self.name}'

layrz_sdk-3.1.33/layrz_sdk/entities/action_kind.py

@@ -0,0 +1,53 @@
+"""Action kind"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ActionKind(str, Enum):
+  """
+  Action kind definition
+  """
+
+  LINK = 'LINK'
+  """ Links or unkinks an asset or device to the parent asset """
+
+  PERFORM_OPERATION = 'PERFORMOPERATION'
+  """ Performs an operation over the activation """
+
+  SEND_TO_OUTBOUND = 'SENDTOOMEGA'
+  """ Send to Outbound services """
+
+  PERFORM_COMMAND = 'PERFORMCOMMAND'
+  """ Performs a command over the activation """
+
+  TO_MONITOR_CENTER = 'TOMONITORCENTER'
+  """ Sends the activation to the monitor center """
+
+  TO_CHECKPOINT_ROUTE = 'TOCHECKPOINTROUTE'
+  """ Sends the activation to the checkpoint route """
+
+  CORE_PROCESS = 'COREPROCESS'
+  """ Core process of the action """
+
+  CREATE_GEOFENCE = 'CREATE_GEOFENCE'
+  """ Creates a geofence for the action """
+
+  PURCHASE_ORDER_STATUS = 'PURCHASEORDERSTATUS'
+  """ Updates the purchase order status for the action """
+
+  EXCHANGE = 'EXCHANGE'
+  """ Sends the activation to the exchange service """
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ActionKind.{self.name}'

layrz_sdk-3.1.33/layrz_sdk/entities/action_subkind.py

@@ -0,0 +1,35 @@
+"""Action sub kind"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ActionSubKind(str, Enum):
+  """
+  Action sub kind definition
+  """
+
+  UNUSED = 'UNUSED'
+  """ Unused action sub kind, not linked to any action kind """
+
+  LINK = 'LINK'
+  """ Link asset or user to the parent asset """
+
+  UNLINK = 'UNLINK'
+  """ Unlink asset or user from the parent asset """
+
+  BOTH = 'BOTH'
+  """ Link and unlink asset or user to the parent asset """
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ActionSubKind.{self.name}'

layrz_sdk-3.1.33/layrz_sdk/entities/ats_reception.py

@@ -0,0 +1,25 @@
+"""Ats Reception entity"""
+
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class AtsReception(BaseModel):
+  """AtsReception entity"""
+
+  pk: int = Field(description='Defines the primary key of the AtsReception')
+  volume_bought: float = Field(
+    description='Volume bought in liters',
+    default=0.0,
+  )
+  real_volume: Optional[float] = 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,
+  )

layrz_sdk-3.1.33/layrz_sdk/entities/geofence_category.py

@@ -0,0 +1,47 @@
+"""Geofence category"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class GeofenceCategory(str, Enum):
+  """
+  Geofence category definition
+  """
+
+  NONE = 'NONE'
+  """ Classic or uncategorized geofence """
+
+  CUSTOM = 'CUSTOM'
+  """ Geofence with non-standard category """
+
+  ADMINISTRATIVE = 'ADMINISTRATIVE'
+  """ Geofence as administrative area """
+
+  CUSTOMER = 'CUSTOMER'
+  """ Geofence as customer location """
+
+  PROSPECT = 'PROSPECT'
+  """ Similar to customer location but not yet a customer """
+
+  OTHER = 'OTHER'
+  """ Other geofence category """
+
+  POLYGON = 'POLYGON'
+  """ Geofence as search geozone """
+
+  LEAD = 'LEAD'
+  """ Geofence as lead location, not yet a prospect or customer """
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'GeofenceCategory.{self.name}'

{layrz_sdk-3.1.31 → layrz_sdk-3.1.33}/layrz_sdk/entities/trigger.py

@@ -1,6 +1,6 @@
 """Trigger entity"""
 
-from datetime import datetime, time, timedelta
+from datetime import time, timedelta
 from typing import Any
 
 from pydantic import BaseModel, Field
@@ -12,6 +12,17 @@ from .weekday import Weekday
 class Trigger(BaseModel):
   """Trigger entity"""
 
+  model_config = {
+    'json_encoders': {
+      timedelta: lambda v: v.total_seconds(),
+      TriggerCaseKind: lambda v: v.value,
+      TriggerGeofenceKind: lambda v: v.value,
+      TriggerKind: lambda v: v.value,
+      TriggerCommentPattern: lambda v: v.value,
+      Weekday: lambda v: v.value,
+    },
+  }
+
   pk: int = Field(description='Defines the primary key of the trigger')
   name: str = Field(description='Defines the name of the trigger')
   code: str = Field(description='Defines the code of the trigger')

{layrz_sdk-3.1.31 → layrz_sdk-3.1.33}/layrz_sdk.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.31
+Version: 3.1.33
 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>
-License: MIT License
+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>
+License-Expression: MIT
 Project-URL: Repository, https://github.com/goldenm-software/layrz-sdk
 Project-URL: Changelog, https://github.com/goldenm-software/layrz-sdk/blob/main/CHANGELOG.md
 Keywords: sdk,goldenm,lcl,layrz compute language,layrz
@@ -14,7 +14,6 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{layrz_sdk-3.1.31 → layrz_sdk-3.1.33}/layrz_sdk.egg-info/SOURCES.txt

@@ -20,9 +20,14 @@ layrz_sdk.egg-info/dependency_links.txt
 layrz_sdk.egg-info/requires.txt
 layrz_sdk.egg-info/top_level.txt
 layrz_sdk/entities/__init__.py
+layrz_sdk/entities/action.py
+layrz_sdk/entities/action_geofence_ownership.py
+layrz_sdk/entities/action_kind.py
+layrz_sdk/entities/action_subkind.py
 layrz_sdk/entities/asset.py
 layrz_sdk/entities/asset_constants.py
 layrz_sdk/entities/asset_operation_mode.py
+layrz_sdk/entities/ats_reception.py
 layrz_sdk/entities/case.py
 layrz_sdk/entities/case_ignored_status.py
 layrz_sdk/entities/case_status.py
@@ -34,6 +39,7 @@ layrz_sdk/entities/device.py
 layrz_sdk/entities/event.py
 layrz_sdk/entities/function.py
 layrz_sdk/entities/geofence.py
+layrz_sdk/entities/geofence_category.py
 layrz_sdk/entities/last_message.py
 layrz_sdk/entities/message.py
 layrz_sdk/entities/outbound_service.py

{layrz_sdk-3.1.31 → layrz_sdk-3.1.33}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "3.1.31"
+version = "3.1.33"
 description = "Layrz SDK for Python"
 authors = [
   {name = "Golden M, Inc.", email = "software@goldenm.com"}
@@ -12,11 +12,12 @@ maintainers = [
   {name = "Luis Reyes", email = "lreyes@goldenm.com"},
   {name = "Kasen Li", email = "kli@goldenm.com"},
   {name = "Miguel Zauzich", email = "miguel@goldenm.com"},
+  {name = "Angel Prieto", email = "aprieto@goldenm.com"},
 ]
 
 readme = "README.md"
 
-license = {text = "MIT License"}
+license = "MIT"
 
 keywords = [
   "sdk",
@@ -32,7 +33,6 @@ classifiers = [
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3.14",
-  "License :: OSI Approved :: MIT License",
   "Operating System :: OS Independent",
 ]
 dependencies = [

{layrz_sdk-3.1.31 → layrz_sdk-3.1.33}/uv.lock

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