layrz-sdk 3.1.34__tar.gz → 3.1.36__tar.gz

{layrz_sdk-3.1.34 → layrz_sdk-3.1.36}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 3.1.36
+
+- Updated enum of `OperationType`
+
+## 3.1.35
+
+- Added models for operations handling
+
 ## 3.1.34
 
 - Fixes on data types onf `Action` model

{layrz_sdk-3.1.34 → layrz_sdk-3.1.36}/PKG-INFO

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

@@ -59,7 +59,13 @@ from .geofence_category import GeofenceCategory
 from .last_message import LastMessage
 from .message import Message
 from .modbus import ModbusConfig, ModbusParameter, ModbusSchema, ModbusStatus, ModbusWait
+from .notification_type import TwilioNotificationType
+from .operation import Operation
+from .operation_case_payload import OperationCaseCommentPayload, OperationCasePayload
+from .operation_payload import OperationPayload
+from .operation_type import OperationType
 from .outbound_service import OutboundService
+from .platform import Platform
 from .position import Position
 from .presence_type import PresenceType
 from .report import Report
@@ -70,9 +76,12 @@ from .report_format import ReportFormat
 from .report_header import ReportHeader
 from .report_page import ReportPage
 from .report_row import ReportRow
+from .request_type import HttpRequestType
 from .sensor import Sensor
+from .sound_effect import SoundEffect
 from .telemetry import AssetMessage, DeviceMessage
 from .text_alignment import TextAlignment
+from .timezone import Timezone
 from .trigger import Trigger
 from .trigger_kind import TriggerCaseKind, TriggerCommentPattern, TriggerGeofenceKind, TriggerKind
 from .user import User
@@ -164,4 +173,14 @@ __all__ = [
   'ActionSubKind',
   'GeofenceCategory',
   'ActionGeofenceOwnership',
+  'SoundEffect',
+  'OperationType',
+  'Operation',
+  'TwilioNotificationType',
+  'HttpRequestType',
+  'Platform',
+  'Timezone',
+  'OperationCasePayload',
+  'OperationCaseCommentPayload',
+  'OperationPayload',
 ]

{layrz_sdk-3.1.34 → layrz_sdk-3.1.36}/layrz_sdk/entities/asset.py

@@ -74,3 +74,8 @@ class Asset(BaseModel):
         return device
 
     return None
+
+  contacts: list[str] = Field(
+    default_factory=list,
+    description='Defines the list of contacts of the asset, used for notifications',
+  )

layrz_sdk-3.1.36/layrz_sdk/entities/notification_type.py

@@ -0,0 +1,32 @@
+"""Twilio Notification Type Enum"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class TwilioNotificationType(str, Enum):
+  """
+  Twilio Notification Type Enum definition
+  """
+
+  SMS = 'SMS'
+  """ Short Message Service (SMS) notification type, used for sending text messages. """
+
+  VOICE = 'VOICE'
+  """ Voice notification type, used for making phone calls. """
+
+  WHATSAPP = 'WHATSAPP'
+  """ WhatsApp notification type, used for sending messages via WhatsApp. """
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'TwilioNotificationType.{self.name}'

layrz_sdk-3.1.36/layrz_sdk/entities/operation.py

@@ -0,0 +1,170 @@
+"""Operation entity"""
+
+from datetime import time, timedelta
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from .notification_type import TwilioNotificationType
+from .operation_type import OperationType
+from .platform import Platform
+from .request_type import HttpRequestType
+from .sound_effect import SoundEffect
+from .timezone import Timezone
+
+
+class Operation(BaseModel):
+  """Operation entity"""
+
+  model_config = {
+    'json_encoders': {
+      timedelta: lambda v: v.total_seconds(),
+      OperationType: lambda v: v.value,
+      HttpRequestType: lambda v: v.value,
+      TwilioNotificationType: lambda v: v.value,
+      SoundEffect: lambda v: v.value,
+      Platform: lambda v: v.value,
+    },
+  }
+
+  pk: int = Field(description='Defines the primary key of the trigger', alias='id')
+  name: str = Field(description='Defines the name of the trigger')
+
+  cooldown_time: timedelta = Field(
+    default_factory=lambda: timedelta(seconds=0),
+    description='Defines the cooldown time of the trigger',
+  )
+
+  kind: OperationType = Field(
+    ...,
+    description='Defines the kind of the operation',
+    alias='operation_type',
+  )
+
+  http_method: HttpRequestType | None = Field(
+    default=None,
+    description='Defines the HTTP method of the operation',
+    alias='request_type',
+  )
+
+  url: str | None = Field(
+    default=None,
+    description='Defines the URL of the operation',
+  )
+
+  headers: list[dict[str, Any]] = Field(
+    default_factory=list,
+    description='Defines the headers of the operation',
+  )
+
+  reception_emails: list[str] = Field(
+    default_factory=list,
+    description='Defines the reception emails of the operation',
+  )
+
+  language_id: int = Field(
+    default=2,
+    description='Defines the language ID of the operation',
+  )
+
+  payload: str = Field(
+    default='',
+    description='Defines the payload of the operation',
+  )
+
+  timezone_id: int | None = Field(
+    default=None,
+    description='Defines the timezone ID of the operation',
+  )
+
+  email_subject: str = Field(
+    default='',
+    description='Defines the email subject of the operation',
+  )
+
+  color: str = Field(
+    default='#2196F3',
+    description='Defines the color of the operation',
+  )
+
+  external_account_id: int | None = Field(
+    default=None,
+    description='Defines the external account ID of the operation',
+    alias='account_id',
+  )
+
+  twilio_notification_type: TwilioNotificationType = Field(
+    default=TwilioNotificationType.SMS,
+    description='Defines the Twilio notification type of the operation',
+    alias='notification_type',
+  )
+
+  destination_phones: list[str] = Field(
+    default_factory=list,
+    description='Defines the destination phone numbers for Twilio notifications',
+  )
+
+  attach_image: bool = Field(
+    default=False,
+    description='Defines if the operation should attach an image',
+  )
+
+  use_asset_contacts_instead: bool = Field(
+    default=False,
+    description='Defines if the operation should use asset contacts instead of reception emails',
+  )
+
+  email_template_id: int | None = Field(
+    default=None,
+    description='Defines the email template ID of the operation',
+  )
+
+  push_platforms: list[Platform] = Field(
+    default_factory=list,
+    description='Defines the platforms for push notifications',
+  )
+
+  push_title: str = Field(
+    default='',
+    description='Defines the title for push notifications',
+  )
+
+  requires_bhs_validation: bool = Field(
+    default=False,
+    description='Defines if the operation requires BHS validation',
+  )
+
+  bhs_tier_id: int | None = Field(
+    default=None,
+    description='Defines the BHS tier ID for the operation',
+  )
+
+  sound_effect: SoundEffect = Field(
+    default=SoundEffect.NONE,
+    description='Defines the sound effect for the operation',
+  )
+
+  sound_effect_uri: str | None = Field(
+    default=None,
+    description='Defines the URI for the sound effect of the operation. Only when sound_effect is set to CUSTOM.',
+  )
+
+  duration: timedelta = Field(
+    default_factory=lambda: timedelta(seconds=5),
+    description='Defines the duration of the operation',
+  )
+
+  credentials: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Defines the credentials for the operation',
+  )
+
+  timezone: Timezone | None = Field(
+    default=None,
+    description='Defines the timezone of the operation',
+  )
+
+  icon: str | None = Field(
+    default=None,
+    description='Defines the icon for the operation',
+  )

layrz_sdk-3.1.36/layrz_sdk/entities/operation_case_payload.py

@@ -0,0 +1,83 @@
+"""Operation case payload entity"""
+
+from datetime import datetime, timedelta
+from typing import Any
+
+from pydantic import BaseModel, Field, field_validator
+
+from layrz_sdk.constants import UTC
+from layrz_sdk.entities.trigger import Trigger
+
+
+class OperationCaseCommentPayload(BaseModel):
+  """Operation case comment payload entity"""
+
+  pk: int = Field(..., description='Defines the primary key of the operation case comment', alias='id')
+  user: str = Field(..., description='Defines the user who created the operation case comment')
+  content: str = Field(..., description='Defines the content of the operation case comment')
+  created_at: datetime = Field(
+    default_factory=lambda: datetime.now(UTC),
+    description='Defines the creation date of the operation case comment',
+    alias='createdAt',
+  )
+
+
+class OperationCasePayload(BaseModel):
+  """Operation case payload entity"""
+
+  model_config = {
+    'json_encoders': {
+      timedelta: lambda v: v.total_seconds(),
+      datetime: lambda v: v.timestamp(),
+      Trigger: lambda v: v.model_dump(by_alias=True, exclude_none=True),
+    },
+  }
+
+  pk: int = Field(description='Defines the primary key of the operation case payload', alias='id')
+  created_at: datetime = Field(
+    default_factory=lambda: datetime.now(UTC),
+    description='Defines the creation date of the operation case payload',
+    alias='createdAt',
+  )
+  updated_at: datetime = Field(
+    default_factory=lambda: datetime.now(UTC),
+    description='Defines the last update date of the operation case payload',
+    alias='updatedAt',
+  )
+
+  trigger: Trigger = Field(
+    ...,
+    description='Defines the trigger associated with the operation case payload',
+  )
+
+  @field_validator('trigger', mode='before')
+  def serialize_trigger(cls, value: Any) -> Trigger:
+    """Serialize trigger to a dictionary"""
+    if isinstance(value, Trigger):
+      return Trigger(
+        pk=value.pk,
+        name=value.name,
+        code=value.code,
+      )
+    if isinstance(value, dict):
+      return Trigger.model_validate(value)
+
+    raise ValueError('Trigger must be an instance of Trigger or a dictionary')
+
+  file_id: int | None = Field(
+    default=None,
+    description='Defines the file ID associated with the operation case payload',
+    alias='fileId',
+  )
+
+  file_created_at: datetime | None = Field(
+    default=None,
+    description='Defines the creation date of the file associated with the operation case payload',
+    alias='fileCreatedAt',
+  )
+
+  comment: OperationCaseCommentPayload | None = Field(
+    default=None,
+    description='Defines the comment associated with the operation case payload',
+    alias='comment',
+  )

layrz_sdk-3.1.36/layrz_sdk/entities/operation_payload.py

@@ -0,0 +1,281 @@
+"""Operation Payload entity"""
+
+from datetime import datetime, timedelta
+from typing import Any
+
+from pydantic import BaseModel, Field, field_validator
+
+from layrz_sdk.entities.asset import Asset
+from layrz_sdk.entities.geofence import Geofence
+from layrz_sdk.entities.notification_type import TwilioNotificationType
+from layrz_sdk.entities.operation import Operation
+from layrz_sdk.entities.operation_case_payload import OperationCasePayload
+from layrz_sdk.entities.operation_type import OperationType
+from layrz_sdk.entities.platform import Platform
+from layrz_sdk.entities.presence_type import PresenceType
+from layrz_sdk.entities.request_type import HttpRequestType
+from layrz_sdk.entities.sound_effect import SoundEffect
+from layrz_sdk.entities.trigger import Trigger
+
+
+class OperationPayload(BaseModel):
+  """Operation Payload entity"""
+
+  model_config = {
+    'json_encoders': {
+      timedelta: lambda v: v.total_seconds(),
+      datetime: lambda v: v.timestamp(),
+      Asset: lambda v: v.model_dump(by_alias=True, exclude_none=True),
+      Trigger: lambda v: v.model_dump(by_alias=True, exclude_none=True),
+      Operation: lambda v: v.model_dump(by_alias=True, exclude_none=True),
+      Geofence: lambda v: v.model_dump(by_alias=True, exclude_none=True),
+      OperationType: lambda v: v.value,
+      HttpRequestType: lambda v: v.value,
+      TwilioNotificationType: lambda v: v.value,
+      SoundEffect: lambda v: v.value,
+      Platform: lambda v: v.value,
+      PresenceType: lambda v: v.value,
+    },
+  }
+
+  kind: OperationType = Field(
+    ...,
+    description='Defines the kind of the operation',
+    alias='operationType',
+  )
+
+  asset: Asset = Field(..., description='Defines the asset associated with the operation')
+
+  @field_validator('asset', mode='before')
+  def serialize_asset(cls, value: Any) -> Asset:
+    """Serialize asset to a dictionary"""
+    if isinstance(value, Asset):
+      return Asset(
+        pk=value.pk,
+        name=value.name,
+        operation_mode=value.operation_mode,
+        vin=value.vin,
+        plate=value.plate,
+        custom_fields=value.custom_fields,
+        contacts=value.contacts,
+      )
+
+    if isinstance(value, dict):
+      return Asset.model_validate(value)
+
+    raise ValueError('Asset must be an instance of Asset or a dictionary')
+
+  trigger: Trigger = Field(..., description='Defines the trigger associated with the operation')
+
+  @field_validator('trigger', mode='before')
+  def serialize_trigger(cls, value: Any) -> Trigger:
+    """Serialize trigger to a dictionary"""
+    if isinstance(value, Trigger):
+      return Trigger(
+        pk=value.pk,
+        name=value.name,
+        code=value.code,
+      )
+
+    if isinstance(value, dict):
+      return Trigger.model_validate(value)
+
+    raise ValueError('Trigger must be an instance of Trigger or a dictionary')
+
+  operation: Operation = Field(..., description='Defines the operation associated with the payload')
+
+  @field_validator('operation', mode='before')
+  def serialize_operation(cls, value: Any) -> Operation:
+    """Serialize operation to a dictionary"""
+    if isinstance(value, Operation):
+      return Operation(
+        id=value.pk,
+        name=value.name,
+        operation_type=value.kind,
+        timezone=value.timezone,
+      )
+
+    if isinstance(value, dict):
+      return Operation.model_validate(value)
+
+    raise ValueError('Operation must be an instance of Operation or a dictionary')
+
+  activated_at: datetime = Field(
+    ...,
+    description='Defines the date when the operation was activated',
+    alias='activatedAt',
+  )
+
+  position: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Defines the position of the operation',
+  )
+
+  sensors: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Defines the sensors of the operation',
+  )
+
+  geofence: Geofence | None = Field(
+    default=None,
+    description='Defines the geofence of the operation',
+  )
+
+  presence_type: PresenceType | None = Field(
+    default=None,
+    description='Defines the presence type of the operation',
+    alias='presenceType',
+  )
+
+  case_: OperationCasePayload | None = Field(
+    default=None,
+    description='Defines the case of the operation',
+    alias='case',
+  )
+
+  language_id: int = Field(
+    default=2,
+    description='Defines the language ID of the operation',
+    alias='languageId',
+  )
+
+  payload: str = Field(
+    default='',
+    description='Defines the payload of the operation',
+  )
+
+  use_asset_contacts_instead: bool = Field(
+    default=False,
+    description='Defines if the operation should use asset contacts instead of reception emails',
+    alias='useAssetContactsInstead',
+  )
+
+  account_id: int | None = Field(
+    default=None,
+    description='Defines the external account ID of the operation',
+    alias='accountId',
+  )
+
+  ## For usage of Webhooks operations
+  http_url: str | None = Field(
+    default=None,
+    description='Defines the URL of the operation',
+  )
+  http_method: HttpRequestType | None = Field(
+    default=None,
+    description='Defines the HTTP method of the operation',
+    alias='method',
+  )
+  http_headers: list[dict[str, Any]] = Field(
+    default_factory=list,
+    description='Defines the headers of the operation',
+    alias='headers',
+  )
+
+  ## For usage of Email operations
+  email_subject: str = Field(
+    default='',
+    description='Defines the email subject of the operation',
+    alias='emailSubject',
+  )
+
+  attach_image: bool = Field(
+    default=False,
+    description='Defines if the operation should attach an image',
+    alias='attachImage',
+  )
+
+  reception_emails: list[str] = Field(
+    default_factory=list,
+    description='Defines the reception emails of the operation',
+    alias='receptionEmails',
+  )
+
+  template_id: int | None = Field(
+    default=None,
+    description='Defines the template ID of the operation',
+    alias='templateId',
+  )
+
+  ## For usage of Twilio operations
+  destinations: list[str] = Field(
+    default_factory=list,
+    description='Defines the destination phone numbers for Twilio notifications',
+  )
+
+  twilio_host_phone: str | None = Field(
+    default=None,
+    description='Defines the host phone number for Twilio notifications',
+    alias='hostPhone',
+  )
+
+  twilio_notification_type: TwilioNotificationType = Field(
+    default=TwilioNotificationType.SMS,
+    description='Defines the Twilio notification type of the operation',
+    alias='notificationType',
+  )
+
+  username: str | None = Field(
+    default=None,
+    description='Defines the username for the operation',
+  )
+
+  token: str | None = Field(
+    default=None,
+    description='Defines the token for the operation',
+  )
+
+  requires_bhs_validation: bool = Field(
+    default=False,
+    description='Defines if the operation requires BHS validation',
+    alias='requiresBhsValidation',
+  )
+
+  bhs_tier_id: int | None = Field(
+    default=None,
+    description='Defines the BHS tier ID for the operation',
+    alias='bhsTierId',
+  )
+
+  ## For usage of BHS Push operations
+  push_title: str = Field(
+    default='',
+    description='Defines the title for push notifications',
+    alias='pushTitle',
+  )
+
+  push_platforms: list[Platform] = Field(
+    default_factory=list,
+    description='Defines the platforms for push notifications',
+    alias='pushPlatforms',
+  )
+
+  ## For usage of In-app notifications operations
+  destinations_ids: list[int] = Field(
+    default_factory=list,
+    description='Defines the destination IDs for in-app notifications',
+    alias='destinationsIds',
+  )
+  sound_effect: SoundEffect = Field(
+    default=SoundEffect.NONE,
+    description='Defines the sound effect for the operation',
+    alias='soundEffect',
+  )
+
+  sound_effect_uri: str | None = Field(
+    default=None,
+    description='Defines the sound effect URI for the operation',
+    alias='soundEffectUri',
+  )
+
+  icon: str | None = Field(
+    default=None,
+    description='Defines the icon for the in-app notification',
+    alias='icon',
+  )
+
+  duration: timedelta = Field(
+    default_factory=lambda: timedelta(seconds=0),
+    description='Defines the duration of the in-app notification',
+    alias='duration',
+  )

layrz_sdk-3.1.36/layrz_sdk/entities/operation_type.py

@@ -0,0 +1,44 @@
+"""Operation type"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class OperationType(str, Enum):
+  """
+  Operation type definition
+  """
+
+  WEBHOOKS = 'WEBHOOKS'
+  """ All the operations by http request """
+
+  SEND_EMAIL = 'SENDEMAIL'
+  """ Send notifications emails """
+
+  REGISTER_ON_ASSET = 'ACTIVATEASSET'
+  """ Register an event for the asset """
+
+  IN_APP_NOTIFICATION = 'INAPPNOTIFICATION'
+  """ Send notifications inside the app """
+
+  TWILIO = 'TWILIO'
+  """ Send notifications using Twilio """
+
+  MOBILE_POPUP_NOTIFICATION = 'MOBILE_POPUP_NOTIFICATION'
+  """ Send notifications using Push Notification (Mobile) """
+
+  BHS_PUSH = 'BHS_PUSH'
+  """ Send notifications using Firebase Push Notifications of Brickhouse Tracking Platform """
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'OperationType.{self.name}'