layrz-sdk 3.1.32__py3-none-any.whl → 3.1.34__py3-none-any.whl

layrz_sdk/entities/__init__.py

@@ -1,5 +1,9 @@
 """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
@@ -51,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
@@ -154,4 +159,9 @@ __all__ = [
   'TriggerCommentPattern',
   'Weekday',
   'AtsReception',
+  'Action',
+  'ActionKind',
+  'ActionSubKind',
+  'GeofenceCategory',
+  'ActionGeofenceOwnership',
 ]

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: 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',
+  )
+
+  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/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/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/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/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/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.32.dist-info → layrz_sdk-3.1.34.dist-info}/METADATA

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

@@ -2,7 +2,11 @@ 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=l_DhH3H33h-lnWfmoEwLoJr9PnJiuQqFC09S0Wp8WyU,4361
+layrz_sdk/entities/__init__.py,sha256=b5Mo2-NaWDHUhO9vCi2Vv5gIK-JESXVPRKnAdl37ISI,4675
+layrz_sdk/entities/action.py,sha256=6H_HJGYPbgV-7Gq-82rrOgTCo7X3byfhYw3op_1wvOE,2006
+layrz_sdk/entities/action_geofence_ownership.py,sha256=PHu6495IUb9biKLXGEy4ESyrzmpP2AQbJiquYk9Kz7c,678
+layrz_sdk/entities/action_kind.py,sha256=u5CI9y86f6-zHKSf4gRhoqcK5azle1UAHqa8-033x88,1277
+layrz_sdk/entities/action_subkind.py,sha256=7aL8j_JrIN4TcXdcPu25wxZJIHZmEa5NrGIm21PJp1A,723
 layrz_sdk/entities/asset.py,sha256=9dVnNXeBP_CnpXUU2KH7LiQxCWBXZzok13HMkN9diaI,2583
 layrz_sdk/entities/asset_constants.py,sha256=dqBK9mq6N-WJLd-RQ7rgDSmcBchR1hYjhOKwd3O7PqQ,600
 layrz_sdk/entities/asset_operation_mode.py,sha256=1RLRpbUm6jwxivdKbB2O6wdnrhyqaccQ_moA-wrnzdQ,639
@@ -18,6 +22,7 @@ layrz_sdk/entities/device.py,sha256=rqBJf0L-cIfxE6ONwGHVx_L0StyQL-ycvSVzug4iIwQ,
 layrz_sdk/entities/event.py,sha256=IDcPwtKbqvX8S2QQei3yFbA2M8NeSYGFoXo3AaSmdHI,720
 layrz_sdk/entities/function.py,sha256=n1E72233GM7kSZEUVj8e9IiV7XyeirGMlwrqsNf_xAc,865
 layrz_sdk/entities/geofence.py,sha256=jPuG5OCknkM37Q4h5haOXdV4OpVyd4gX77dFjd-FaP4,326
+layrz_sdk/entities/geofence_category.py,sha256=YtUx7z-NmnQhYL8GedQRMR4xsis_BnPNyNR4hq-dJds,988
 layrz_sdk/entities/last_message.py,sha256=QNgF0xCQ6uLFDMmKQCjSRhGS1Bq7akw5pv6ZIiFlwfY,268
 layrz_sdk/entities/message.py,sha256=eFID7CEBnwp6-MsfhK09JPSJzp7iRbQibJOe_ELgQ9A,563
 layrz_sdk/entities/outbound_service.py,sha256=_AzIKB3i86FhpSaxxdMYmCCG8JHtBi2PdzzDzMODerw,225
@@ -34,7 +39,7 @@ layrz_sdk/entities/report_row.py,sha256=t2Rk7LeforU-sD5abqnTQES2Oac8dmEXMLLo_18x
 layrz_sdk/entities/sensor.py,sha256=9Q6RGb9qDvyLS4tELZOZtPlaiWi9An5Vf0gGLGWIRhE,312
 layrz_sdk/entities/static_position.py,sha256=xTbTWRPQLZqTgPQnyIMOoMHiNi42AzmVRfgDMM4m03c,365
 layrz_sdk/entities/text_alignment.py,sha256=YqUqj07c4XzHZLdaqNw1FEUpneWoJU5UU3eicC5-Sps,496
-layrz_sdk/entities/trigger.py,sha256=IRrFV9nXnUfvOi7mCtIvZHb7URyJyQvHY_csLeAdEQc,3277
+layrz_sdk/entities/trigger.py,sha256=makyynoCZk-Cywv-ZQJfEQct8TP3geKmij8AgT-z_hw,3575
 layrz_sdk/entities/trigger_kind.py,sha256=Sk7iNndnMSMgjGR_2ouB1eLNPTH7WyPszQofbY0J-I8,1783
 layrz_sdk/entities/user.py,sha256=S2mJoW44xbBe-O3I_ajy5l4V9-azVLUfKvcfsuqfodQ,236
 layrz_sdk/entities/waypoint.py,sha256=Wx4uFzKVXKTuSgu8wiDpvqGFtG3c1_owk1-M9APlpj8,550
@@ -87,8 +92,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.32.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
-layrz_sdk-3.1.32.dist-info/METADATA,sha256=dAf_ZkhKJULhqJSjbv1pl7NGitwxBB1epMYIMJb198k,2109
-layrz_sdk-3.1.32.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-layrz_sdk-3.1.32.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
-layrz_sdk-3.1.32.dist-info/RECORD,,
+layrz_sdk-3.1.34.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
+layrz_sdk-3.1.34.dist-info/METADATA,sha256=ola_WlxSl-BwL_ZZV0iIdWnjZRQTx6dbnXWRxXcIg60,2109
+layrz_sdk-3.1.34.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+layrz_sdk-3.1.34.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
+layrz_sdk-3.1.34.dist-info/RECORD,,