layrz-sdk 3.1.44__py3-none-any.whl → 3.1.46__py3-none-any.whl

layrz_sdk/entities/__init__.py

@@ -6,6 +6,7 @@ from .action_kind import ActionKind
 from .action_subkind import ActionSubKind
 from .asset import Asset
 from .asset_constants import AssetConstants
+from .asset_contact import AssetContact
 from .asset_operation_mode import AssetOperationMode
 from .ats_reception import AtsReception
 from .broadcast import (
@@ -64,7 +65,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
+from .operation_payload import OperationPayload, TwilioHostPhone
 from .operation_type import OperationType
 from .outbound_service import OutboundService
 from .platform import Platform
@@ -92,19 +93,27 @@ from .waypoint import Waypoint, WaypointKind, WaypointRef
 from .weekday import Weekday
 
 __all__ = [
+  'Action',
+  'ActionGeofenceOwnership',
+  'ActionKind',
+  'ActionSubKind',
   'Asset',
+  'AssetConstants',
+  'AssetContact',
+  'AssetMessage',
   'AssetOperationMode',
+  'AtsReception',
+  'AxisConfig',
+  'BarChart',
+  'BroadcastPayload',
   'BroadcastRequest',
   'BroadcastResponse',
   'BroadcastResult',
-  'BroadcastStatus',
   'BroadcastService',
-  'BroadcastPayload',
+  'BroadcastStatus',
   'Case',
   'CaseIgnoredStatus',
   'CaseStatus',
-  'AxisConfig',
-  'BarChart',
   'ChartAlignment',
   'ChartColor',
   'ChartConfiguration',
@@ -112,37 +121,49 @@ __all__ = [
   'ChartDataSerieType',
   'ChartDataType',
   'ChartRenderTechnology',
-  'ColumnChart',
-  'HTMLChart',
-  'LineChart',
-  'MapCenterType',
-  'MapChart',
-  'MapPoint',
-  'NumberChart',
-  'PieChart',
-  'RadarChart',
-  'RadialBarChart',
-  'ScatterChart',
-  'ScatterSerie',
-  'ScatterSerieItem',
-  'TableChart',
-  'TableHeader',
-  'TableRow',
-  'TimelineChart',
-  'TimelineSerie',
-  'TimelineSerieItem',
   'Checkpoint',
+  'CheckpointOperationMode',
+  'CheckpointRef',
+  'ColumnChart',
+  'CommandSeriesTicket',
+  'CommandSeriesTicketStatus',
   'Comment',
   'CustomField',
   'CustomReportPage',
   'Device',
+  'DeviceMessage',
   'Event',
+  'ExchangeService',
+  'Function',
   'Geofence',
+  'GeofenceCategory',
+  'HTMLChart',
+  'HttpRequestType',
   'LastMessage',
+  'LineChart',
+  'MapCenterType',
+  'MapChart',
+  'MapPoint',
   'Message',
+  'ModbusConfig',
+  'ModbusParameter',
+  'ModbusSchema',
+  'ModbusStatus',
+  'ModbusWait',
+  'NumberChart',
+  'Operation',
+  'OperationCaseCommentPayload',
+  'OperationCasePayload',
+  'OperationPayload',
+  'OperationType',
   'OutboundService',
+  'PieChart',
+  'Platform',
   'Position',
   'PresenceType',
+  'Preset',
+  'RadarChart',
+  'RadialBarChart',
   'Report',
   'ReportCol',
   'ReportConfiguration',
@@ -151,47 +172,29 @@ __all__ = [
   'ReportHeader',
   'ReportPage',
   'ReportRow',
+  'ScatterChart',
+  'ScatterSerie',
+  'ScatterSerieItem',
   'Sensor',
+  'SoundEffect',
+  'TableChart',
+  'TableHeader',
+  'TableRow',
   'TextAlignment',
+  'TimelineChart',
+  'TimelineSerie',
+  'TimelineSerieItem',
+  'Timezone',
   'Trigger',
-  'User',
-  'Waypoint',
-  'ModbusConfig',
-  'ModbusParameter',
-  'ModbusSchema',
-  'ModbusStatus',
-  'ModbusWait',
-  'AssetMessage',
-  'DeviceMessage',
-  'AssetConstants',
-  'Function',
-  'TriggerKind',
-  'TriggerGeofenceKind',
   'TriggerCaseKind',
   'TriggerCommentPattern',
-  'Weekday',
-  'AtsReception',
-  'Action',
-  'ActionKind',
-  'ActionSubKind',
-  'GeofenceCategory',
-  'ActionGeofenceOwnership',
-  'SoundEffect',
-  'OperationType',
-  'Operation',
+  'TriggerGeofenceKind',
+  'TriggerKind',
+  'TwilioHostPhone',
   'TwilioNotificationType',
-  'HttpRequestType',
-  'Platform',
-  'Timezone',
-  'OperationCasePayload',
-  'OperationCaseCommentPayload',
-  'OperationPayload',
-  'ExchangeService',
-  'CommandSeriesTicket',
-  'CommandSeriesTicketStatus',
-  'Preset',
-  'CheckpointOperationMode',
-  'CheckpointRef',
+  'User',
+  'Waypoint',
   'WaypointKind',
   'WaypointRef',
+  'Weekday',
 ]

layrz_sdk/entities/asset.py

@@ -10,6 +10,7 @@ if sys.version_info >= (3, 11):
 else:
   from typing_extensions import Self
 
+from .asset_contact import AssetContact
 from .asset_operation_mode import AssetOperationMode
 from .custom_field import CustomField
 from .device import Device
@@ -75,7 +76,7 @@ class Asset(BaseModel):
 
     return None
 
-  contacts: list[str] = Field(
+  contacts: list[AssetContact] = Field(
     default_factory=list,
     description='Defines the list of contacts of the asset, used for notifications',
   )

layrz_sdk/entities/asset_contact.py

@@ -0,0 +1,11 @@
+"""Asset contact information"""
+
+from pydantic import BaseModel, Field
+
+
+class AssetContact(BaseModel):
+  """Asset contact information"""
+
+  name: str = Field(default='', description='Name of the contact person for the asset')
+  phone: str = Field(default='', description='Phone number of the contact person for the asset')
+  email: str = Field(default='', description='Email address of the contact person for the asset')

layrz_sdk/entities/operation_payload.py

@@ -1,8 +1,14 @@
 """Operation Payload entity"""
 
+import sys
 from datetime import datetime, timedelta
 from typing import Any
 
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
 from pydantic import BaseModel, Field, field_validator
 
 from layrz_sdk.entities.asset import Asset
@@ -18,6 +24,27 @@ 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"""
 
@@ -203,7 +230,7 @@ class OperationPayload(BaseModel):
     description='Defines the destination phone numbers for Twilio notifications',
   )
 
-  twilio_host_phone: str | None = Field(
+  twilio_host_phone: TwilioHostPhone | None = Field(
     default=None,
     description='Defines the host phone number for Twilio notifications',
     alias='hostPhone',

layrz_sdk/entities/waypoint.py

@@ -27,11 +27,12 @@ class Waypoint(BaseModel):
   """Waypoint entity definition"""
 
   pk: int = Field(description='Waypoint ID')
-  geofence: Geofence = Field(description='Geofence object')
-  start_at: datetime = Field(description='Waypoint start date')
-  end_at: datetime = Field(description='Waypoint end date')
-  sequence_real: int = Field(description='Real sequence number')
-  sequence_ideal: int = Field(description='Ideal sequence number')
+  geofence: Geofence | None = Field(default=None, description='Geofence object')
+  geofence_id: int | None = Field(default=None, description='Geofence ID')
+  start_at: datetime | None = Field(default=None, description='Waypoint start date')
+  end_at: datetime | None = Field(default=None, description='Waypoint end date')
+  sequence_real: int = Field(..., description='Real sequence number')
+  sequence_ideal: int = Field(..., description='Ideal sequence number')
 
 
 class WaypointRef(BaseModel):

{layrz_sdk-3.1.44.dist-info → layrz_sdk-3.1.46.dist-info}/METADATA

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

@@ -2,13 +2,14 @@ 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=7NvPkpA0PdO3X8p70AXz0g3f1kRSRJMDi8i6JSxA0zQ,5683
+layrz_sdk/entities/__init__.py,sha256=LBHHRML6XLUofjamv_HcYIMLinO6sFdNyd4kLBH-Z-s,5779
 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
 layrz_sdk/entities/action_subkind.py,sha256=7aL8j_JrIN4TcXdcPu25wxZJIHZmEa5NrGIm21PJp1A,723
-layrz_sdk/entities/asset.py,sha256=0m0v46zeVO2tchFk4BAzjz4bE2LgPlZJ589aA7xZNl8,2813
+layrz_sdk/entities/asset.py,sha256=b8dCfQRsZsze-7X8Ydwi_lhBh7VEPx-KHalYSofUC40,2862
 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_reception.py,sha256=yog5b5vvWKOHj67YMamJ_m7zodLcrYSSEwdXxtaLDCk,596
 layrz_sdk/entities/case.py,sha256=0dSfZCezDuEEED42rws-zntqa_Em9oFevlXSPrIeIC8,1877
@@ -30,7 +31,7 @@ layrz_sdk/entities/message.py,sha256=eFID7CEBnwp6-MsfhK09JPSJzp7iRbQibJOe_ELgQ9A
 layrz_sdk/entities/notification_type.py,sha256=yfuQhiIDaOfWCc8p9fZp8umaOU4ELdGrA_b5MWYHA5U,757
 layrz_sdk/entities/operation.py,sha256=xXD_-dqLW5c6J3aRMRxJh9tebaDKl7WPOoq0Q-chyjA,4887
 layrz_sdk/entities/operation_case_payload.py,sha256=ZOimwmt3fRz01U5Mz0KqeKbS9AGdIDJvZBhPI3c50xQ,2657
-layrz_sdk/entities/operation_payload.py,sha256=p_Zqb-pcYbt4DvmAGWphdxM74k8XQIh7CKiS1xBX_nI,8150
+layrz_sdk/entities/operation_payload.py,sha256=gklGruSQ2NNGu1g5f58moSIkZGQj7dTGjIGOmSz8lOQ,8774
 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
@@ -54,7 +55,7 @@ layrz_sdk/entities/timezone.py,sha256=VhS3o9miktQmThz22KJfatjvqzSONHy73_eBUtjI8i
 layrz_sdk/entities/trigger.py,sha256=patZ_GE6GAlqfJJ33ddt_bLKtBNeD-5CQ4Jp2dPB9OY,3658
 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=FIh4OHojuQhMJxnVP_aKUr4fLgf5TPmVpndvIG9jhys,1497
+layrz_sdk/entities/waypoint.py,sha256=cwVOP9dmkLnkWSxMWMu7Qm28HfDKWF5P1hpkY9zS7z0,1645
 layrz_sdk/entities/weekday.py,sha256=5y5BTMVvxi1ujUa5e1iRb8cpxzTQIBTvzmzfiPC8poI,506
 layrz_sdk/entities/broadcast/__init__.py,sha256=Q1fIeDj1oAL63Q0JDddkW_FuP826-Im6ScwUUwAZIOM,372
 layrz_sdk/entities/broadcast/payload.py,sha256=ugD5m3zVFZVDfBMkR2WlZTWunn9gZSQ1Ej8YXbeA8Wk,1417
@@ -104,8 +105,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.44.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
-layrz_sdk-3.1.44.dist-info/METADATA,sha256=eBhfgT-C2sXwXUQJfMfdM85aKSCmUXkJ2TLKepzQDzM,2109
-layrz_sdk-3.1.44.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-layrz_sdk-3.1.44.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
-layrz_sdk-3.1.44.dist-info/RECORD,,
+layrz_sdk-3.1.46.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
+layrz_sdk-3.1.46.dist-info/METADATA,sha256=Bp3RQGpVYvjGffhalb9E35nMJMfITdpi80k7zMS4qsU,2109
+layrz_sdk-3.1.46.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+layrz_sdk-3.1.46.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
+layrz_sdk-3.1.46.dist-info/RECORD,,