layrz-sdk 3.0.14__py3-none-any.whl → 3.1.0__py3-none-any.whl

layrz_sdk/__init__.py

@@ -1 +1 @@
-""" Layrz SDK Namespace """
+""" Layrz SDK Namespace """

layrz_sdk/constants.py

@@ -0,0 +1,5 @@
+"""Constants"""
+
+from zoneinfo import ZoneInfo
+
+UTC = ZoneInfo('UTC')

layrz_sdk/entities/__init__.py

@@ -1,73 +1,129 @@
-"""Init file"""
-
-# Broadcast entities
-from .broadcasts import BroadcastRequest, BroadcastResponse, BroadcastResult, BroadcastStatus, OutboundService
-
-# Cases entitites
-from .cases import Case, CaseIgnoredStatus, CaseStatus, Comment, Trigger
-
-# Charts entities
-from .charts import (
-  AreaChart,
-  AxisConfig,
-  BarChart,
-  ChartAlignment,
-  ChartColor,
-  ChartConfiguration,
-  ChartDataSerie,
-  ChartDataSerieType,
-  ChartDataType,
-  ChartException,
-  ChartRenderTechnology,
-  ColumnChart,
-  HTMLChart,
-  LineChart,
-  MapCenterType,
-  MapChart,
-  MapPoint,
-  NumberChart,
-  PieChart,
-  RadarChart,
-  RadialBarChart,
-  ScatterChart,
-  ScatterSerie,
-  ScatterSerieItem,
-  TableChart,
-  TableHeader,
-  TableRow,
-  TimelineChart,
-  TimelineSerie,
-  TimelineSerieItem,
-  get_color_list,
-)
-
-# Checkpoints entities
-from .checkpoints import Checkpoint, Waypoint
-
-# Events entities
-from .events import Event
-
-# Formatting entities
-from .formatting import TextAlignment
-
-# General entities
-from .general import Asset, AssetOperationMode, CustomField, Device, Geofence, PresenceType, Sensor, User
-
-# REPCOM entities
-from .repcom import Transaction
-
-# Reports entities
-from .reports import (
-  CustomReportPage,
-  Report,
-  ReportCol,
-  ReportConfiguration,
-  ReportDataType,
-  ReportFormat,
-  ReportHeader,
-  ReportPage,
-  ReportRow,
-)
-
-# Telemetry entities
-from .telemetry import LastMessage, Message, Position
+"""Init file"""
+
+from .asset import Asset
+from .asset_operation_mode import AssetOperationMode
+from .broadcast_request import BroadcastRequest
+from .broadcast_response import BroadcastResponse
+from .broadcast_result import BroadcastResult
+from .broadcast_status import BroadcastStatus
+from .case import Case
+from .case_ignored_status import CaseIgnoredStatus
+from .case_status import CaseStatus
+from .charts.axis_config import AxisConfig
+from .charts.bar_chart import BarChart
+from .charts.chart_alignment import ChartAlignment
+from .charts.chart_color import ChartColor
+from .charts.chart_configuration import ChartConfiguration
+from .charts.chart_data_serie import ChartDataSerie
+from .charts.chart_data_serie_type import ChartDataSerieType
+from .charts.chart_data_type import ChartDataType
+from .charts.chart_render_technology import ChartRenderTechnology
+from .charts.column_chart import ColumnChart
+from .charts.html_chart import HTMLChart
+from .charts.line_chart import LineChart
+from .charts.map_center_type import MapCenterType
+from .charts.map_chart import MapChart
+from .charts.map_point import MapPoint
+from .charts.number_chart import NumberChart
+from .charts.pie_chart import PieChart
+from .charts.radar_chart import RadarChart
+from .charts.radial_bar_chart import RadialBarChart
+from .charts.scatter_chart import ScatterChart
+from .charts.scatter_serie import ScatterSerie
+from .charts.scatter_serie_item import ScatterSerieItem
+from .charts.table_chart import TableChart
+from .charts.table_header import TableHeader
+from .charts.table_row import TableRow
+from .charts.timeline_chart import TimelineChart
+from .charts.timeline_serie import TimelineSerie
+from .charts.timeline_serie_item import TimelineSerieItem
+from .checkpoint import Checkpoint
+from .comment import Comment
+from .custom_field import CustomField
+from .custom_report_page import CustomReportPage
+from .device import Device
+from .event import Event
+from .geofence import Geofence
+from .last_message import LastMessage
+from .message import Message
+from .outbound_service import OutboundService
+from .position import Position
+from .presence_type import PresenceType
+from .report import Report
+from .report_col import ReportCol
+from .report_configuration import ReportConfiguration
+from .report_data_type import ReportDataType
+from .report_format import ReportFormat
+from .report_header import ReportHeader
+from .report_page import ReportPage
+from .report_row import ReportRow
+from .sensor import Sensor
+from .text_alignment import TextAlignment
+from .trigger import Trigger
+from .user import User
+from .waypoint import Waypoint
+
+__all__ = [
+  'Asset',
+  'AssetOperationMode',
+  'BroadcastRequest',
+  'BroadcastResponse',
+  'BroadcastResult',
+  'BroadcastStatus',
+  'Case',
+  'CaseIgnoredStatus',
+  'CaseStatus',
+  'AxisConfig',
+  'BarChart',
+  'ChartAlignment',
+  'ChartColor',
+  'ChartConfiguration',
+  'ChartDataSerie',
+  'ChartDataSerieType',
+  'ChartDataType',
+  'ChartRenderTechnology',
+  'ColumnChart',
+  'HTMLChart',
+  'LineChart',
+  'MapCenterType',
+  'MapChart',
+  'MapPoint',
+  'NumberChart',
+  'PieChart',
+  'RadarChart',
+  'RadialBarChart',
+  'ScatterChart',
+  'ScatterSerie',
+  'ScatterSerieItem',
+  'TableChart',
+  'TableHeader',
+  'TableRow',
+  'TimelineChart',
+  'TimelineSerie',
+  'TimelineSerieItem',
+  'Checkpoint',
+  'Comment',
+  'CustomField',
+  'CustomReportPage',
+  'Device',
+  'Event',
+  'Geofence',
+  'LastMessage',
+  'Message',
+  'OutboundService',
+  'Position',
+  'PresenceType',
+  'Report',
+  'ReportCol',
+  'ReportConfiguration',
+  'ReportDataType',
+  'ReportFormat',
+  'ReportHeader',
+  'ReportPage',
+  'ReportRow',
+  'Sensor',
+  'TextAlignment',
+  'Trigger',
+  'User',
+  'Waypoint',
+]

layrz_sdk/entities/asset.py

@@ -0,0 +1,71 @@
+"""Asset Entity"""
+
+import sys
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, Field, model_validator
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+from .asset_operation_mode import AssetOperationMode
+from .custom_field import CustomField
+from .device import Device
+from .sensor import Sensor
+
+
+class Asset(BaseModel):
+  """Asset entity definition"""
+
+  pk: int = Field(description='Defines the primary key of the asset')
+  name: str = Field(description='Defines the name of the asset')
+  vin: Optional[str] = Field(
+    default=None,
+    description='Defines the serial number of the asset, may be an VIN, or any other unique identifier',
+  )
+  plate: Optional[str] = Field(default=None, description='Defines the plate number of the asset')
+  asset_type: int = Field(description='Defines the type of the asset')
+  operation_mode: AssetOperationMode = Field(description='Defines the operation mode of the asset')
+  sensors: List[Sensor] = Field(default_factory=list, description='Defines the list of sensors of the asset')
+  custom_fields: List[CustomField] = Field(
+    default_factory=list, description='Defines the list of custom fields of the asset'
+  )
+  devices: List[Device] = Field(default_factory=list, description='Defines the list of devices of the asset')
+  children: List[Self] = Field(default_factory=list, description='Defines the list of children of the asset')
+
+  @model_validator(mode='before')
+  def _validate_model(cls: Self, data: Dict[str, Any]) -> Dict[str, Any]:
+    """Validate model"""
+    operation_mode = data.get('operation_mode')
+    if operation_mode == AssetOperationMode.ASSETMULTIPLE:
+      data['devices'] = []
+
+    elif operation_mode == AssetOperationMode.SINGLE:
+      primary: Optional[Device] = None
+      for device in data['devices']:
+        if device.is_primary:
+          primary = device
+          break
+
+      if not primary:
+        raise ValueError('Single asset must have a primary device')
+      data['devices'] = [primary]
+
+    else:
+      data['children'] = []
+
+    return data
+
+  @property
+  def primary(self: Self) -> Optional[Device]:
+    """Get primary device"""
+    if self.operation_mode not in [AssetOperationMode.SINGLE, AssetOperationMode.MULTIPLE]:
+      return None
+
+    for device in self.devices:
+      if device.is_primary:
+        return device
+
+    return None

layrz_sdk/entities/{general/asset_operation_mode.py → asset_operation_mode.py}

@@ -1,30 +1,31 @@
-"""Asset Operation Mode"""
-
-from enum import Enum
-
-
-class AssetOperationMode(Enum):
-  """
-  Asset Operation mode definition
-  It's an enum of the operation mode of the asset.
-  """
-
-  SINGLE = 'SINGLE'
-  MULTIPLE = 'MULTIPLE'
-  ASSETMULTIPLE = 'ASSETMULTIPLE'
-  DISCONNECTED = 'DISCONNECTED'
-  STATIC = 'STATIC'
-  ZONE = 'ZONE'
-
-  @property
-  def _readable(self) -> str | None | bool:
-    """Readable"""
-    return self.value
-
-  def __str__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
+"""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 AssetOperationMode(Enum):
+  """
+  Asset Operation mode definition
+  It's an enum of the operation mode of the asset.
+  """
+
+  SINGLE = 'SINGLE'
+  MULTIPLE = 'MULTIPLE'
+  ASSETMULTIPLE = 'ASSETMULTIPLE'
+  DISCONNECTED = 'DISCONNECTED'
+  STATIC = 'STATIC'
+  ZONE = 'ZONE'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'AssetOperationMode.{self.name}'

layrz_sdk/entities/broadcast_request.py

@@ -0,0 +1,12 @@
+"""Broadcast Result Request data"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class BroadcastRequest(BaseModel):
+  """Broadcast request data"""
+
+  json: Any = Field(description='Parsed data')
+  raw: str = Field(description='Raw data')

layrz_sdk/entities/broadcast_response.py

@@ -0,0 +1,12 @@
+"""Broadcast Result Response data"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class BroadcastResponse(BaseModel):
+  """Broadcast response data"""
+
+  json: Any = Field(description='Parsed data')
+  raw: str = Field(description='Raw data')

layrz_sdk/entities/broadcast_result.py

@@ -0,0 +1,20 @@
+"""Broadcast result"""
+
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+from .broadcast_request import BroadcastRequest
+from .broadcast_response import BroadcastResponse
+from .broadcast_status import BroadcastStatus
+
+
+class BroadcastResult(BaseModel):
+  """Broadcast result data"""
+
+  service_id: int = Field(description='Service ID')
+  asset_id: int = Field(description='Asset ID')
+  status: BroadcastStatus = Field(description='Broadcast status')
+  request: BroadcastRequest = Field(description='Broadcast request')
+  response: BroadcastResponse = Field(description='Broadcast response')
+  submitted_at: datetime = Field(description='Broadcast submission date')

layrz_sdk/entities/{broadcasts/status.py → broadcast_status.py}

@@ -1,27 +1,28 @@
-"""Broadcast result Status"""
-
-from enum import Enum
-
-
-class BroadcastStatus(Enum):
-  """Broadcast result status"""
-
-  OK = 'OK'
-  BADREQUEST = 'BADREQUEST'
-  INTERNALERROR = 'INTERNALERROR'
-  UNAUTHORIZED = 'UNAUTHORIZED'
-  UNPROCESSABLE = 'UNPROCESSABLE'
-  DISCONNECTED = 'DISCONNECTED'
-
-  @property
-  def _readable(self) -> str | None | bool:
-    """Readable"""
-    return f'BroadcastStatus.{self.value}'
-
-  def __str__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
+"""Broadcast result Status"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class BroadcastStatus(Enum):
+  """Broadcast result status"""
+
+  OK = 'OK'
+  BADREQUEST = 'BADREQUEST'
+  INTERNALERROR = 'INTERNALERROR'
+  UNAUTHORIZED = 'UNAUTHORIZED'
+  UNPROCESSABLE = 'UNPROCESSABLE'
+  DISCONNECTED = 'DISCONNECTED'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'BroadcastStatus.{self.name}'

layrz_sdk/entities/case.py

@@ -0,0 +1,47 @@
+"""Events entities"""
+import sys
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, Field, model_validator
+
+from .case_ignored_status import CaseIgnoredStatus
+from .case_status import CaseStatus
+from .comment import Comment
+from .trigger import Trigger
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class Case(BaseModel):
+  """Case entity"""
+
+  pk: int = Field(description='Defines the primary key of the case')
+  trigger: Trigger = Field(description='Defines the trigger of the case')
+  asset_id: int = Field(description='Defines the asset ID of the case')
+  comments: List[Comment] = Field(default_factory=list, description='Defines the comments of the case')
+  opened_at: datetime = Field(description='Defines the date when the case was opened')
+  closed_at: Optional[datetime] = Field(default=None, description='Defines the date when the case was closed')
+  status: CaseStatus = Field(description='Defines the status of the case', default=CaseStatus.CLOSED)
+  ignored_status: CaseIgnoredStatus = Field(
+    description='Defines the ignored status of the case',
+    default=CaseIgnoredStatus.NORMAL,
+  )
+  sequence: Optional[int | str] = Field(
+    default=None,
+    description='Defines the sequence of the case. This is a unique identifier for the case',
+  )
+
+  @model_validator(mode='before')
+  def _validate_model(cls: Self, data: Dict[str, Any]) -> Dict[str, Any]:
+    """Validate model"""
+    sequence = data.get('sequence')
+    if sequence is not None and isinstance(sequence, int):
+      data['sequence'] = f'{data["trigger"].code}/{sequence}'
+    else:
+      data['sequence'] = f'GENERIC/{data["pk"]}'
+
+    return data

layrz_sdk/entities/case_ignored_status.py

@@ -0,0 +1,26 @@
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class CaseIgnoredStatus(Enum):
+  """
+  Case ignore status, will define what kind ignore happened.
+  """
+
+  NORMAL = 'NORMAL'
+  IGNORED = 'IGNORED'
+  PRESET = 'PRESET'
+  AUTO = 'AUTO'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'CaseIgnoredStatus.{self.name}'

layrz_sdk/entities/case_status.py

@@ -0,0 +1,23 @@
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class CaseStatus(Enum):
+  """Case status enum"""
+
+  PENDING = 'PENDING'
+  FOLLOWED = 'FOLLOWED'
+  CLOSED = 'CLOSED'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'CaseStatus.{self.name}'

layrz_sdk/entities/charts/axis_config.py

@@ -0,0 +1,15 @@
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+from .chart_data_type import ChartDataType
+
+
+class AxisConfig(BaseModel):
+  """Axis configuration"""
+
+  label: str = Field(default='', description='Label of the axis')
+  measure_unit: str = Field(default='', description='Measure unit of the axis')
+  min_value: Optional[float] = Field(default=None, description='Minimum value of the axis')
+  max_value: Optional[float] = Field(default=None, description='Maximum value of the axis')
+  data_type: ChartDataType = Field(default=ChartDataType.DATETIME, description='Data type of the axis')