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

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

@@ -1,5 +1,20 @@
 # Changelog
 
+## 3.1.31
+
+- Expanded `Trigger` model with new fields (Almost closed to the Dart equivalent on [`layrz_models`](https://pub.dev/packages/layrz_models))
+- Added `Weekday` enum to represent days of the week
+- Added `TriggerKind`, `TriggerGeofenceKind`, `TriggerCaseKind`, and `TriggerCommentPattern` enums to represent different trigger types and patterns
+- Almost removed all aliases from the models
+
+## 3.1.30
+
+- New `Function` model
+
+## 3.1.29
+
+- Serialization changes
+
 ## 3.1.28
 
 - Added `BroadcastPayload` and `BroadcastService` models

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

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.29
+Version: 3.1.31
 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>
+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
 Project-URL: Repository, https://github.com/goldenm-software/layrz-sdk
 Project-URL: Changelog, https://github.com/goldenm-software/layrz-sdk/blob/main/CHANGELOG.md

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

@@ -48,6 +48,7 @@ from .custom_field import CustomField
 from .custom_report_page import CustomReportPage
 from .device import Device
 from .event import Event
+from .function import Function
 from .geofence import Geofence
 from .last_message import LastMessage
 from .message import Message
@@ -67,8 +68,10 @@ from .sensor import Sensor
 from .telemetry import AssetMessage, DeviceMessage
 from .text_alignment import TextAlignment
 from .trigger import Trigger
+from .trigger_kind import TriggerCaseKind, TriggerCommentPattern, TriggerGeofenceKind, TriggerKind
 from .user import User
 from .waypoint import Waypoint
+from .weekday import Weekday
 
 __all__ = [
   'Asset',
@@ -143,4 +146,10 @@ __all__ = [
   'AssetMessage',
   'DeviceMessage',
   'AssetConstants',
+  'Function',
+  'TriggerKind',
+  'TriggerGeofenceKind',
+  'TriggerCaseKind',
+  'TriggerCommentPattern',
+  'Weekday',
 ]

{layrz_sdk-3.1.29 → layrz_sdk-3.1.31}/layrz_sdk/entities/asset.py

@@ -20,7 +20,7 @@ from .static_position import StaticPosition
 class Asset(BaseModel):
   """Asset entity definition"""
 
-  pk: int = Field(description='Defines the primary key of the asset', serialization_alias='id')
+  pk: int = Field(description='Defines the primary key of the asset')
   name: str = Field(description='Defines the name of the asset')
   vin: str | None = Field(
     default=None,

{layrz_sdk-3.1.29 → layrz_sdk-3.1.31}/layrz_sdk/entities/asset_constants.py

@@ -14,20 +14,9 @@ class AssetConstants(BaseModel):
     },
   }
 
-  distance_traveled: float = Field(
-    default=0.0,
-    description='Total distance traveled by the asset in meters',
-    alias='distanceTraveled',
-  )
-
+  distance_traveled: float = Field(default=0.0, description='Total distance traveled by the asset in meters')
+  primary_device: str = Field(default='N/a', description='Primary device associated with the asset')
   elapsed_time: timedelta = Field(
     default=timedelta(seconds=0),
     description='Total elapsed time for the asset in seconds',
-    alias='elapsedTime',
-  )
-
-  primary_device: str = Field(
-    default='N/a',
-    description='Primary device associated with the asset',
-    alias='primaryDevice',
   )

{layrz_sdk-3.1.29 → layrz_sdk-3.1.31}/layrz_sdk/entities/broadcast/payload.py

@@ -24,16 +24,9 @@ class BroadcastPayload(BaseModel):
   }
 
   asset: Asset = Field(..., description='Asset object')
-  primary_device: Device | None = Field(
-    default=None,
-    description='Primary device object',
-    serialization_alias='primaryDevice',
-  )
-  trigger: Trigger | None = Field(
-    default=None,
-    description='Trigger object, if available',
-  )
-  message_id: int | str = Field(..., description='Message ID', serialization_alias='message.id')
+  primary_device: Device | None = Field(default=None, description='Primary device object')
+  trigger: Trigger | None = Field(default=None, description='Trigger object, if available')
+  message_id: int | str = Field(..., description='Message ID')
   service: BroadcastService | None = Field(default=None, description='Broadcast service object')
   position: dict[str, Any] = Field(default_factory=dict, description='Position data, if available')
   sensors: dict[str, Any] = Field(default_factory=dict, description='Sensors data, if available')
@@ -41,5 +34,4 @@ class BroadcastPayload(BaseModel):
   received_at: datetime = Field(
     default_factory=lambda: datetime.now(UTC),
     description='Broadcast payload received date',
-    serialization_alias='receivedAt',
   )

{layrz_sdk-3.1.29 → layrz_sdk-3.1.31}/layrz_sdk/entities/broadcast/service.py

@@ -8,6 +8,6 @@ from pydantic import BaseModel, Field
 class BroadcastService(BaseModel):
   """Broadcast Service object"""
 
-  pk: int = Field(..., description='Service ID', serialization_alias='id')
+  pk: int = Field(..., description='Service ID')
   name: str = Field(..., description='Service name')
   credentials: dict[str, Any] = Field(default_factory=dict, description='Service credentials')

{layrz_sdk-3.1.29 → layrz_sdk-3.1.31}/layrz_sdk/entities/device.py

@@ -8,7 +8,7 @@ from .modbus import ModbusConfig
 class Device(BaseModel):
   """Device entity"""
 
-  pk: int = Field(description='Defines the primary key of the device', serialization_alias='id')
+  pk: int = Field(description='Defines the primary key of the device')
   name: str = Field(description='Defines the name of the device')
   ident: str = Field(description='Defines the identifier of the device')
   protocol_id: int | None = Field(

{layrz_sdk-3.1.29 → layrz_sdk-3.1.31}/layrz_sdk/entities/event.py

@@ -1,7 +1,6 @@
 """Event entity"""
 
 from datetime import datetime
-from typing import Optional
 
 from pydantic import BaseModel, Field
 
@@ -19,5 +18,5 @@ class Event(BaseModel):
   asset_id: int = Field(description='Asset ID')
   message: Message = Field(description='Message')
   activated_at: datetime = Field(description='Event activation date')
-  geofence: Optional[Geofence] = Field(default=None, description='Geofence object')
-  presence_type: Optional[PresenceType] = Field(default=None, description='Presence type object')
+  geofence: Geofence | None = Field(default=None, description='Geofence object')
+  presence_type: PresenceType | None = Field(default=None, description='Presence type object')

layrz_sdk-3.1.31/layrz_sdk/entities/function.py

@@ -0,0 +1,29 @@
+"""Geofence entity"""
+
+from datetime import timedelta
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, Field, constr
+
+from .asset import Asset
+
+
+class Function(BaseModel):
+  """Function entity"""
+
+  pk: int = Field(description='Defines the primary key of the Function')
+  name: str = Field(description='Name of the function')
+
+  maximum_time: Optional[timedelta] = None  # DurationField → timedelta
+  minutes_delta: Optional[timedelta] = None
+
+  external_identifiers: List[constr(max_length=255)] = Field(default_factory=list)  # type: ignore
+
+  credentials: Dict[str, Any] = Field(default_factory=dict)
+
+  # Many-to-manys  ➜  list of nested DTOs
+  assets: List[Asset] = Field(default_factory=list)
+
+  # Foreign keys – normally expose only the FK id to keep the payload small.
+  owner_id: Optional[int] = None
+  algorithm_id: int

{layrz_sdk-3.1.29 → layrz_sdk-3.1.31}/layrz_sdk/entities/telemetry/assetmessage.py

@@ -36,16 +36,8 @@ class AssetMessage(BaseModel):
     }
   }
 
-  pk: int | None = Field(
-    default=None,
-    description='Message ID',
-    alias='id',
-  )
-
-  asset_id: int = Field(
-    ...,
-    description='Asset ID',
-  )
+  pk: int | None = Field(default=None, description='Message ID')
+  asset_id: int = Field(..., description='Asset ID')
 
   position: dict[str, float | int] = Field(
     default_factory=dict,

{layrz_sdk-3.1.29 → layrz_sdk-3.1.31}/layrz_sdk/entities/telemetry/devicemessage.py

@@ -24,11 +24,7 @@ from layrz_sdk.entities.device import Device
 class DeviceMessage(BaseModel):
   """Device message model"""
 
-  pk: int | None = Field(
-    default=None,
-    description='Device message ID',
-    alias='id',
-  )
+  pk: int | None = Field(default=None, description='Device message ID')
 
   ident: str = Field(
     ...,

layrz_sdk-3.1.31/layrz_sdk/entities/trigger.py

@@ -0,0 +1,119 @@
+"""Trigger entity"""
+
+from datetime import datetime, time, timedelta
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from .trigger_kind import TriggerCaseKind, TriggerCommentPattern, TriggerGeofenceKind, TriggerKind
+from .weekday import Weekday
+
+
+class Trigger(BaseModel):
+  """Trigger entity"""
+
+  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')
+
+  cooldown_time: timedelta = Field(
+    default_factory=lambda: timedelta(seconds=0),
+    description='Defines the cooldown time of the trigger',
+  )
+
+  type_: TriggerKind | None = Field(
+    default=None,
+    description='Defines the kind of the trigger',
+    alias='type',
+  )
+
+  presence_type: TriggerGeofenceKind | None = Field(
+    default=None,
+    description='Defines the geofence kind of the trigger',
+  )
+
+  case_type: TriggerCaseKind | None = Field(
+    default=None,
+    description='Defines the case kind of the trigger',
+  )
+
+  case_comment_pattern: TriggerCommentPattern | None = Field(
+    default=None,
+    description='Defines the comment pattern of the trigger',
+  )
+
+  case_comment_value: str | None = Field(
+    default=None,
+    description='Defines the comment pattern value of the trigger',
+  )
+
+  exact_hour: time | None = Field(
+    default=None,
+    description='Defines the exact hour of the trigger',
+  )
+  crontab_format: str | None = Field(
+    default=None,
+    description='Defines the crontab format of the trigger',
+  )
+
+  weekdays: list[Weekday] = Field(
+    default_factory=list,
+    description='Defines the weekdays of the trigger',
+  )
+
+  is_plain_crontab: bool = Field(
+    default=False,
+    description='Defines if the trigger is a plain crontab',
+  )
+
+  timezone_id: int | None = Field(
+    default=None,
+    description='Defines the timezone ID of the trigger',
+  )
+
+  parameters: list[str] = Field(
+    default_factory=list,
+    description='Defines the parameters of the trigger',
+  )
+
+  manual_action_fields: list[dict[str, Any]] = Field(
+    default_factory=list,
+    description='Defines the fields for manual action in the trigger',
+  )
+
+  formula: str | None = Field(
+    default=None,
+    description='Defines the formula of the trigger, this formula is only LCL (Layrz Computation Language) compatible',
+  )
+
+  script: str | None = Field(
+    default=None,
+    description='Defines the script of the trigger, depending of the trigger kidn, this script can be in Python, '
+    + 'Javascript, Lua, Dart or Golang. (Or any other language supported by the SDK)',
+  )
+
+  is_legacy: bool = Field(
+    default=False,
+    description='Defines if the trigger is legacy, normally when a version of the trigger is not compatible '
+    + 'with the current version of the SDK',
+  )
+
+  priority: int = Field(
+    default=0,
+    description='Defines the priority of the trigger',
+  )
+
+  color: str | None = Field(
+    default='#2196F3',
+    description='Defines the color of the trigger',
+  )
+
+  sequence: int = Field(
+    default=0,
+    description='Defines the sequence of the trigger',
+  )
+
+  care_protocol_id: int | None = Field(
+    default=None,
+    description='Defines the care protocol ID of the trigger',
+  )

layrz_sdk-3.1.31/layrz_sdk/entities/trigger_kind.py

@@ -0,0 +1,88 @@
+"""Asset Operation Mode"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class TriggerKind(str, Enum):
+  """
+  Trigger Kind definition
+  """
+
+  PRESENCE_IN_GEOFENCE = 'PRESENCEINGEOFENCE'
+  EXACT_TIME = 'EXACTTIME'
+  FORMULA = 'FORMULA'
+  AUTHENTICATION = 'AUTHENTICATION'
+  PYTHON_SCRIPT = 'PYTHONSCRIPT'
+  CASES_CHANGES = 'CASES_CHANGES'
+  BHS_SPEEDING = 'BHS_SPEEDING'
+  BHS_PRESENCE = 'BHS_PRESENCE'
+  MANUAL_ACTION = 'MANUAL_ACTION'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'TriggerKind.{self.name}'
+
+
+class TriggerGeofenceKind(str, Enum):
+  """
+  Geofence Kind definition
+  """
+
+  ENTRANCE = 'ENTRANCE'
+  EXIT = 'EXIT'
+  BOTH = 'BOTH'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'GeofenceKind.{self.name}'
+
+
+class TriggerCaseKind(str, Enum):
+  """
+  Case Kind definition
+  """
+
+  ON_FOLLOW = 'ON_FOLLOW'
+  ON_CLOSE = 'ON_CLOSE'
+  ON_DISMISS = 'ON_DISMISS'
+  ON_COMMENT_PATTERN = 'ON_COMMENT_PATTERN'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'TriggerCaseKind.{self.name}'
+
+
+class TriggerCommentPattern(str, Enum):
+  """
+  Comment Pattern definition
+  """
+
+  STARTS_WITH = 'STARTS_WITH'
+  ENDS_WITH = 'ENDS_WITH'
+  CONTAINS = 'CONTAINS'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'TriggerCommentPattern.{self.name}'

layrz_sdk-3.1.31/layrz_sdk/entities/weekday.py

@@ -0,0 +1,29 @@
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class Weekday(str, Enum):
+  """
+  Weekday definition
+  """
+
+  MONDAY = 'MON'
+  TUESDAY = 'TUE'
+  WEDNESDAY = 'WED'
+  THURSDAY = 'THU'
+  FRIDAY = 'FRI'
+  SATURDAY = 'SAT'
+  SUNDAY = 'SUN'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'Weekday.{self.name}'

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

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.29
+Version: 3.1.31
 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>
+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
 Project-URL: Repository, https://github.com/goldenm-software/layrz-sdk
 Project-URL: Changelog, https://github.com/goldenm-software/layrz-sdk/blob/main/CHANGELOG.md

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

@@ -32,6 +32,7 @@ layrz_sdk/entities/custom_field.py
 layrz_sdk/entities/custom_report_page.py
 layrz_sdk/entities/device.py
 layrz_sdk/entities/event.py
+layrz_sdk/entities/function.py
 layrz_sdk/entities/geofence.py
 layrz_sdk/entities/last_message.py
 layrz_sdk/entities/message.py
@@ -50,8 +51,10 @@ layrz_sdk/entities/sensor.py
 layrz_sdk/entities/static_position.py
 layrz_sdk/entities/text_alignment.py
 layrz_sdk/entities/trigger.py
+layrz_sdk/entities/trigger_kind.py
 layrz_sdk/entities/user.py
 layrz_sdk/entities/waypoint.py
+layrz_sdk/entities/weekday.py
 layrz_sdk/entities/broadcast/__init__.py
 layrz_sdk/entities/broadcast/payload.py
 layrz_sdk/entities/broadcast/request.py

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

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "3.1.29"
+version = "3.1.31"
 description = "Layrz SDK for Python"
 authors = [
   {name = "Golden M, Inc.", email = "software@goldenm.com"}
@@ -11,6 +11,7 @@ maintainers = [
   {name = "Kenny Mochizuki", email = "kenny@goldenm.com"},
   {name = "Luis Reyes", email = "lreyes@goldenm.com"},
   {name = "Kasen Li", email = "kli@goldenm.com"},
+  {name = "Miguel Zauzich", email = "miguel@goldenm.com"},
 ]
 
 readme = "README.md"

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

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

layrz_sdk-3.1.29/layrz_sdk/entities/trigger.py

@@ -1,11 +0,0 @@
-"""Trigger entity"""
-
-from pydantic import BaseModel, Field
-
-
-class Trigger(BaseModel):
-  """Trigger entity"""
-
-  pk: int = Field(description='Defines the primary key of the trigger', serialization_alias='id')
-  name: str = Field(description='Defines the name of the trigger')
-  code: str = Field(description='Defines the code of the trigger')