layrz-sdk 3.1.38__tar.gz → 3.1.39__tar.gz

{layrz_sdk-3.1.38 → layrz_sdk-3.1.39}/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.1.39
+
+- Added `ExchangeService` entity to represent outbound services with credentials.
+- New `CommandSeriesTicket` model
+- Added more information on `OutboundService` model
+
 ## 3.1.38
 
 - Added `owner_id` field to `Asset`, `Action`, and `Trigger` models to represent the owner of the entity.

{layrz_sdk-3.1.38 → layrz_sdk-3.1.39}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.38
+Version: 3.1.39
 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.38 → layrz_sdk-3.1.39}/layrz_sdk/entities/__init__.py

@@ -48,11 +48,13 @@ from .charts.timeline_chart import TimelineChart
 from .charts.timeline_serie import TimelineSerie
 from .charts.timeline_serie_item import TimelineSerieItem
 from .checkpoint import Checkpoint
+from .command_series_ticket import CommandSeriesTicket, CommandSeriesTicketStatus
 from .comment import Comment
 from .custom_field import CustomField
 from .custom_report_page import CustomReportPage
 from .device import Device
 from .event import Event
+from .exchange_service import ExchangeService
 from .function import Function
 from .geofence import Geofence
 from .geofence_category import GeofenceCategory
@@ -183,4 +185,7 @@ __all__ = [
   'OperationCasePayload',
   'OperationCaseCommentPayload',
   'OperationPayload',
+  'ExchangeService',
+  'CommandSeriesTicket',
+  'CommandSeriesTicketStatus',
 ]

layrz_sdk-3.1.39/layrz_sdk/entities/command_series_ticket.py

@@ -0,0 +1,66 @@
+"""Command Series Ticket entity"""
+
+from datetime import datetime
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from layrz_sdk.backwards import StrEnum
+from layrz_sdk.constants import UTC
+from layrz_sdk.entities.action import Action
+from layrz_sdk.entities.asset import Asset
+from layrz_sdk.entities.geofence import Geofence
+from layrz_sdk.entities.trigger import Trigger
+
+
+class CommandSeriesTicketStatus(StrEnum):
+  PENDING = 'PND'
+  IN_SERVICE = 'ISV'
+  TO_JOB = 'TJB'
+  AT_JOB = 'ATJ'
+  POURING = 'POU'
+  TO_PLANT = 'TPL'
+  IN_YARD = 'IYD'
+  OUT_OF_SERVICE = 'OSV'
+
+
+class CommandSeriesTicket(BaseModel):
+  """Command Series Ticket definition"""
+
+  pk: int = Field(..., description='ID', alias='id')
+  service_id: int = Field(..., description='Service ID')
+  status: CommandSeriesTicketStatus = Field(
+    default=CommandSeriesTicketStatus.IN_SERVICE,
+    description='Ticket status',
+  )
+
+  ticket_id: str = Field(..., description='Ticket ID')
+  ticket_code: str = Field(..., description='Ticket code')
+  ticket_at: datetime = Field(..., description='Ticket creation date')
+
+  source_id: int | None = Field(default=None, description='Source geofence ID')
+  source: Geofence | None = Field(default=None, description='Source geofence')
+
+  job_id: int | None = Field(default=None, description='Job geofence ID')
+  job: Geofence | None = Field(default=None, description='Job geofence')
+
+  destination_id: int | None = Field(default=None, description='Destination geofence ID')
+  destination: Geofence | None = Field(default=None, description='Destination geofence')
+
+  asset_id: int | None = Field(default=None, description='Asset ID')
+  asset: Asset | None = Field(default=None, description='Asset')
+
+  trigger_id: int | None = Field(default=None, description='Trigger ID')
+  trigger: Trigger | None = Field(default=None, description='Trigger')
+
+  action_id: int | None = Field(default=None, description='Action ID')
+  action: Action | None = Field(default=None, description='Action')
+
+  created_at: datetime = Field(
+    default_factory=lambda: datetime.now(UTC),
+    description='Creation date',
+  )
+  updated_at: datetime = Field(
+    default_factory=lambda: datetime.now(UTC),
+    description='Last update date',
+  )

layrz_sdk-3.1.39/layrz_sdk/entities/exchange_service.py

@@ -0,0 +1,29 @@
+"""Exchange Service entity"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class ExchangeService(BaseModel):
+  """Exchange service definition"""
+
+  pk: int = Field(..., description='Service ID', alias='id')
+  name: str = Field(..., description='Service name')
+  credentials: dict[str, Any] = Field(
+    description='Service credentials',
+    default_factory=dict,
+  )
+  protocol_id: int | None = Field(
+    default=None,
+    description='Protocol ID',
+  )
+  flespi_token: str | None = Field(
+    default=None,
+    description='Flespi token for the service',
+  )
+
+  owner_id: int | None = Field(
+    default=None,
+    description='Owner ID',
+  )

layrz_sdk-3.1.39/layrz_sdk/entities/outbound_service.py

@@ -0,0 +1,29 @@
+"""Service entity"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class OutboundService(BaseModel):
+  """Outbound service definition"""
+
+  pk: int = Field(description='Service ID')
+  name: str = Field(description='Service name')
+
+  protocol_name: str | None = Field(
+    default=None,
+    description='Protocol name',
+  )
+  mqtt_topic: str | None = Field(
+    default=None,
+    description='MQTT topic for the service',
+  )
+  is_consumpted: bool = Field(
+    default=False,
+    description='Is the service consumpted',
+  )
+  credentials: dict[str, Any] = Field(
+    description='Service credentials',
+    default_factory=dict,
+  )

{layrz_sdk-3.1.38 → layrz_sdk-3.1.39}/layrz_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.38
+Version: 3.1.39
 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.38 → layrz_sdk-3.1.39}/layrz_sdk.egg-info/SOURCES.txt

@@ -32,11 +32,13 @@ layrz_sdk/entities/case.py
 layrz_sdk/entities/case_ignored_status.py
 layrz_sdk/entities/case_status.py
 layrz_sdk/entities/checkpoint.py
+layrz_sdk/entities/command_series_ticket.py
 layrz_sdk/entities/comment.py
 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/exchange_service.py
 layrz_sdk/entities/function.py
 layrz_sdk/entities/geofence.py
 layrz_sdk/entities/geofence_category.py

{layrz_sdk-3.1.38 → layrz_sdk-3.1.39}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "3.1.38"
+version = "3.1.39"
 description = "Layrz SDK for Python"
 authors = [
   {name = "Golden M, Inc.", email = "software@goldenm.com"}

{layrz_sdk-3.1.38 → layrz_sdk-3.1.39}/uv.lock

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

layrz_sdk-3.1.38/layrz_sdk/entities/outbound_service.py

@@ -1,10 +0,0 @@
-"""Service entity"""
-
-from pydantic import BaseModel, Field
-
-
-class OutboundService(BaseModel):
-  """Outbound service definition"""
-
-  pk: int = Field(description='Service ID')
-  name: str = Field(description='Service name')