layrz-sdk 3.0.9__tar.gz → 3.0.11__tar.gz

{layrz_sdk-3.0.9 → layrz_sdk-3.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: layrz-sdk
-Version: 3.0.9
+Version: 3.0.11
 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>
@@ -17,6 +17,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
 Requires-Dist: xlsxwriter
+Requires-Dist: tzdata
 
 # Layrz SDK
 

layrz_sdk-3.0.11/layrz_sdk/entities/broadcasts/request.py

@@ -0,0 +1,30 @@
+"""Broadcast Result Request data"""
+
+from typing import Dict, List
+
+
+class BroadcastRequest:
+  """
+  Broadcast request data
+  ---
+  Attributes
+    - json : Parsed data
+    - raw : Raw data
+  """
+
+  def __init__(self, json: Dict | List, raw: str) -> None:
+    self.json = json
+    self.raw = raw
+
+  @property
+  def _readable(self) -> str | None | bool:
+    """Readable"""
+    return f'BroadcastRequest(json={self.json}, raw={self.raw})'
+
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable
+
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable

layrz_sdk-3.0.11/layrz_sdk/entities/broadcasts/response.py

@@ -0,0 +1,30 @@
+"""Broadcast Result Response data"""
+
+from typing import Dict, List
+
+
+class BroadcastResponse:
+  """
+  Broadcast response data
+  ---
+  Attributes
+    - json (dict|list): Parsed data
+    - raw (str): Raw data
+  """
+
+  def __init__(self, json: Dict | List, raw: str) -> str | None | bool:
+    self.json = json
+    self.raw = raw
+
+  @property
+  def _readable(self) -> str | None | bool:
+    """Readable"""
+    return f'BroadcastResponse(json={self.json}, raw={self.raw})'
+
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable
+
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable

{layrz_sdk-3.0.9 → layrz_sdk-3.0.11}/layrz_sdk/entities/broadcasts/result.py

@@ -1,6 +1,6 @@
-""" Broadcast result """
+"""Broadcast result"""
+
 from datetime import datetime
-from typing import Self
 
 from .request import BroadcastRequest
 from .response import BroadcastResponse
@@ -21,7 +21,7 @@ class BroadcastResult:
   """
 
   def __init__(
-    self: Self,
+    self,
     service_id: int,
     asset_id: int,
     status: BroadcastStatus,
@@ -37,15 +37,17 @@ class BroadcastResult:
     self.submitted_at = submitted_at
 
   @property
-  def _readable(self: Self) -> str | None | bool:
-    """ Readable """
-    return f'BroadcastResult(service_id={self.service_id}, asset_id={self.asset_id}, status={self.status}, ' +\
-           f'request={self.request}, response={self.response}, submitted_at={self.submitted_at})'
+  def _readable(self) -> str | None | bool:
+    """Readable"""
+    return (
+      f'BroadcastResult(service_id={self.service_id}, asset_id={self.asset_id}, status={self.status}, '
+      + f'request={self.request}, response={self.response}, submitted_at={self.submitted_at})'
+    )
 
-  def __repr__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
-  def __str__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable

layrz_sdk-3.0.11/layrz_sdk/entities/broadcasts/service.py

@@ -0,0 +1,28 @@
+"""Service entity"""
+
+
+class OutboundService:
+  """
+  Outbound service definition
+  ---
+  Attributes
+    - pk : Service ID
+    - name : Service Name
+  """
+
+  def __init__(self, pk: int, name: str) -> str | None | bool:
+    self.pk = pk
+    self.name = name
+
+  @property
+  def _readable(self) -> str | None | bool:
+    """Readable"""
+    return f'OutboundService(pk={self.pk}, name={self.name})'
+
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable
+
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable

{layrz_sdk-3.0.9 → layrz_sdk-3.0.11}/layrz_sdk/entities/broadcasts/status.py

@@ -1,10 +1,11 @@
-""" Broadcast result Status """
+"""Broadcast result Status"""
+
 from enum import Enum
-from typing import Self
 
 
 class BroadcastStatus(Enum):
-  """ Broadcast result status """
+  """Broadcast result status"""
+
   OK = 'OK'
   BADREQUEST = 'BADREQUEST'
   INTERNALERROR = 'INTERNALERROR'
@@ -13,14 +14,14 @@ class BroadcastStatus(Enum):
   DISCONNECTED = 'DISCONNECTED'
 
   @property
-  def _readable(self: Self) -> str | None | bool:
-    """ Readable """
+  def _readable(self) -> str | None | bool:
+    """Readable"""
     return f'BroadcastStatus.{self.value}'
 
-  def __str__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
-  def __repr__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable

{layrz_sdk-3.0.9 → layrz_sdk-3.0.11}/layrz_sdk/entities/cases/case.py

@@ -1,29 +1,29 @@
-""" Events entitites """
+"""Events entitites"""
 
 from datetime import datetime
 from enum import Enum
-from typing import Self
 
 from .trigger import Trigger
 
 
 class CaseStatus(Enum):
-  """ Case status enum """
+  """Case status enum"""
+
   PENDING = 'PENDING'
   FOLLOWED = 'FOLLOWED'
   CLOSED = 'CLOSED'
 
   @property
-  def _readable(self: Self) -> str | None | bool:
-    """ Readable """
+  def _readable(self) -> str | None | bool:
+    """Readable"""
     return f'BroadcastStatus.{self.value}'
 
-  def __str__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
-  def __repr__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
 
@@ -31,22 +31,23 @@ class CaseIgnoredStatus(Enum):
   """
   Case ignore status, will define what kind ignore happened.
   """
+
   NORMAL = 'NORMAL'
   IGNORED = 'IGNORED'
   PRESSET = 'PRESSET'
   AUTO = 'AUTO'
 
   @property
-  def _readable(self: Self) -> str | None | bool:
-    """ Readable """
+  def _readable(self) -> str | None | bool:
+    """Readable"""
     return f'BroadcastStatus.{self.value}'
 
-  def __str__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
-  def __repr__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
 
@@ -67,7 +68,7 @@ class Case:
   """
 
   def __init__(
-    self: Self,
+    self,
     pk: int,
     trigger: Trigger,
     asset_id: int,
@@ -78,7 +79,7 @@ class Case:
     status: CaseStatus = CaseStatus.CLOSED,
     ignored_status: CaseIgnoredStatus = CaseIgnoredStatus.NORMAL,
   ) -> None:
-    """ Constructor """
+    """Constructor"""
     self.pk = pk
     self.trigger = trigger
     self.asset_id = asset_id
@@ -89,29 +90,31 @@ class Case:
     self._sequence = sequence
     self.ignored_status = ignored_status
 
-  def get_sequence(self: Self) -> str | None | bool:
-    """ Sequence getter """
+  def get_sequence(self) -> str | None | bool:
+    """Sequence getter"""
     if self._sequence is not None:
       return f'{self.trigger.code}/{self._sequence}'
     else:
       return f'GENERIC/{self.pk}'
 
-  def set_sequence(self: Self, sequence: int) -> None:
-    """ Sequence setter """
+  def set_sequence(self, sequence: int) -> None:
+    """Sequence setter"""
     self._sequence = sequence
 
   sequence = property(get_sequence, set_sequence)
 
   @property
-  def _readable(self: Self) -> str | None | bool:
-    """ Readable """
-    return f'Case(pk={self.pk}, trigger={self.trigger}, asset_id={self.asset_id}, ' +\
-           f'comments={len(self.comments)}, opened_at={self.opened_at}, closed_at={self.closed_at})'
-
-  def __str__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def _readable(self) -> str | None | bool:
+    """Readable"""
+    return (
+      f'Case(pk={self.pk}, trigger={self.trigger}, asset_id={self.asset_id}, '
+      + f'comments={len(self.comments)}, opened_at={self.opened_at}, closed_at={self.closed_at})'
+    )
+
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
-  def __repr__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable

{layrz_sdk-3.0.9 → layrz_sdk-3.0.11}/layrz_sdk/entities/cases/comment.py

@@ -1,6 +1,6 @@
-""" Comment entity """
+"""Comment entity"""
+
 from datetime import datetime
-from typing import Self
 
 from layrz_sdk.entities.general.user import User
 
@@ -16,22 +16,22 @@ class Comment:
     - submitted_at : Date of comment submission
   """
 
-  def __init__(self: Self, pk: int, content: str, user: User, submitted_at: datetime) -> None:
-    """ Constructor """
+  def __init__(self, pk: int, content: str, user: User, submitted_at: datetime) -> None:
+    """Constructor"""
     self.pk = pk
     self.content = content
     self.user = user
     self.submitted_at = submitted_at
 
   @property
-  def _readable(self: Self) -> str | None | bool:
-    """ Readable """
+  def _readable(self) -> str | None | bool:
+    """Readable"""
     return f'Comment(pk={self.pk}, content="{self.content}", user={self.user}, submitted_at={self.submitted_at})'
 
-  def __str__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
-  def __repr__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable

layrz_sdk-3.0.11/layrz_sdk/entities/cases/trigger.py

@@ -0,0 +1,31 @@
+"""Trigger entity"""
+
+
+class Trigger:
+  """
+  Trigger entity definition
+  ---
+  Attributes
+    - pk : Trigger ID
+    - name : Trigger name
+    - code : Trigger code
+  """
+
+  def __init__(self, pk: int, name: str, code: str) -> None:
+    """Constructor"""
+    self.pk = pk
+    self.name = name
+    self.code = code
+
+  @property
+  def _readable(self) -> str | None | bool:
+    """Readable"""
+    return f'Trigger(pk={self.pk}, name="{self.name}", code="{self.code}")'
+
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable
+
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable

layrz_sdk-3.0.11/layrz_sdk/entities/charts/alignment.py

@@ -0,0 +1,26 @@
+"""Chart alignment"""
+
+from enum import Enum
+
+
+class ChartAlignment(Enum):
+  """
+  Chart Alignment
+  """
+
+  CENTER = 'center'
+  LEFT = 'left'
+  RIGHT = 'right'
+
+  @property
+  def _readable(self) -> str | None | bool:
+    """Readable"""
+    return f'ChartAlignment.{self.value}'
+
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable
+
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
+    return self._readable

{layrz_sdk-3.0.9 → layrz_sdk-3.0.11}/layrz_sdk/entities/charts/bar.py

@@ -1,5 +1,6 @@
-""" Bar chart """
-from typing import Any, List, Self
+"""Bar chart"""
+
+from typing import Any, List
 
 from .alignment import ChartAlignment
 from .configuration import AxisConfig
@@ -15,7 +16,7 @@ class BarChart:
   """
 
   def __init__(
-    self: Self,
+    self,
     x_axis: ChartDataSerie,
     y_axis: List[ChartDataSerie],
     title: str = 'Chart',
@@ -68,7 +69,7 @@ class BarChart:
     self.y_axis_config = y_axis_config
 
   def render(
-    self: Self,
+    self,
     technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
   ) -> Any:
     """
@@ -105,7 +106,7 @@ class BarChart:
       'configuration': [f'Unsupported rendering technology {technology.name}'],
     }
 
-  def _render_syncfusion_flutter_charts(self: Self) -> Any:
+  def _render_syncfusion_flutter_charts(self) -> Any:
     """
     Converts the configuration of the chart to Syncfusion Flutter Charts.
     """
@@ -117,11 +118,13 @@ class BarChart:
         x_axis = self.x_axis.data[i]
         values.append({'xAxis': x_axis, 'yAxis': value})
 
-      series.append({
-        'label': serie.label,
-        'color': serie.color,
-        'values': values,
-      })
+      series.append(
+        {
+          'label': serie.label,
+          'color': serie.color,
+          'values': values,
+        }
+      )
 
     return {
       'series': series,
@@ -141,7 +144,7 @@ class BarChart:
       },
     }
 
-  def _render_graphic(self: Self) -> Any:
+  def _render_graphic(self) -> Any:
     """
     Converts the configuration of the chart to Flutter library graphic.
     """
@@ -151,16 +154,18 @@ class BarChart:
     for serie in self.y_axis:
       for i, value in enumerate(serie.data):
         x_axis = self.x_axis.data[i]
-        series.append({
-          'label': serie.label,
-          'color': serie.color,
-          'category': x_axis,
-          'value': value,
-        })
+        series.append(
+          {
+            'label': serie.label,
+            'color': serie.color,
+            'category': x_axis,
+            'value': value,
+          }
+        )
 
     return series
 
-  def _render_apexcharts(self: Self) -> Any:
+  def _render_apexcharts(self) -> Any:
     """
     Converts the configuration of the chart to Javascript library ApexCharts.
     """
@@ -183,40 +188,21 @@ class BarChart:
       'xaxis': {
         'categories': self.x_axis.data,
         'type': self.x_axis.data_type.value,
-        'title': {
-          'text': self.x_axis.label
-        }
+        'title': {'text': self.x_axis.label},
       },
       'title': {
         'text': self.title,
         'align': self.align.value,
-        'style': {
-          'fontFamily': 'Fira Sans Condensed',
-          'fontSize': '20px',
-          'fontWeight': 'normal'
-        }
-      },
-      'plotOptions': {
-        'bar': {
-          'horizontal': True,
-          'borderRadius': 4
-        }
-      },
-      'dataLabels': {
-        'enabled': False
+        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
       },
+      'plotOptions': {'bar': {'horizontal': True, 'borderRadius': 4}},
+      'dataLabels': {'enabled': False},
       'chart': {
         'type': 'bar',
-        'animations': {
-          'enabled': False
-        },
-        'toolbar': {
-          'show': False
-        },
-        'zoom': {
-          'enabled': False
-        }
-      }
+        'animations': {'enabled': False},
+        'toolbar': {'show': False},
+        'zoom': {'enabled': False},
+      },
     }
 
     return config

{layrz_sdk-3.0.9 → layrz_sdk-3.0.11}/layrz_sdk/entities/charts/color.py

@@ -1,10 +1,12 @@
-""" Chart alignment """
+"""Chart alignment"""
+
 from enum import Enum
-from typing import Any, Self
+from typing import Any
 
 
 class ChartColor(Enum):
-  """ Chart color list, ideal to use to colorize the series """
+  """Chart color list, ideal to use to colorize the series"""
+
   RED = '#F44336'
   BLUE = '#2196F3'
   GREEN = '#4CAF50'
@@ -18,19 +20,19 @@ class ChartColor(Enum):
   LIME = '#CDDC39'
 
   @property
-  def _readable(self: Self) -> str | None | bool:
-    """ Readable """
+  def _readable(self) -> str | None | bool:
+    """Readable"""
     return f'ChartColor.{self.value}'
 
-  def __str__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __str__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
-  def __repr__(self: Self) -> str | None | bool:
-    """ Readable property """
+  def __repr__(self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
 
 def get_color_list() -> Any:
-  """ Get all colors """
+  """Get all colors"""
   return [color.value for color in ChartColor]