layrz-sdk 3.1.2__py3-none-any.whl → 3.1.3__py3-none-any.whl

layrz_sdk/entities/case.py

@@ -1,47 +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
+"""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

@@ -1,26 +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}'
+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

@@ -1,23 +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}'
+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

@@ -1,15 +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')
+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')

layrz_sdk/entities/charts/bar_chart.py

@@ -1,171 +1,171 @@
-"""Bar chart"""
-
-import sys
-from typing import Any, Dict, List
-
-from pydantic import BaseModel, Field
-
-from .axis_config import AxisConfig
-from .chart_alignment import ChartAlignment
-from .chart_data_serie import ChartDataSerie
-from .chart_data_serie_type import ChartDataSerieType
-from .chart_render_technology import ChartRenderTechnology
-
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
-
-class BarChart(BaseModel):
-  """Bar chart configuration"""
-
-  x_axis: ChartDataSerie = Field(description='Defines the X Axis of the chart')
-  y_axis: List[ChartDataSerie] = Field(description='Defines the Y Axis of the chart', default_factory=list)
-  title: str = Field(default='Chart', description='Title of the chart')
-  align: ChartAlignment = Field(default=ChartAlignment.CENTER, description='Alignment of the title')
-  x_axis_config: AxisConfig = Field(
-    default_factory=lambda: AxisConfig(),
-    description='Configuration of the X Axis',
-  )
-  y_axis_config: AxisConfig = Field(
-    default_factory=lambda: AxisConfig(),
-    description='Configuration of the Y Axis',
-  )
-
-  def render(
-    self: Self,
-    technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
-  ) -> Dict[str, Any]:
-    """
-    Render chart to a graphic Library.
-    :param technology: The technology to use to render the chart.
-    :return: The configuration of the chart.
-    """
-    if technology == ChartRenderTechnology.GRAPHIC:
-      return {
-        'library': 'GRAPHIC',
-        'chart': 'BAR',
-        'configuration': self._render_graphic(),
-      }
-
-    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
-      return {
-        'library': 'SYNCFUSION_FLUTTER_CHARTS',
-        'chart': 'BAR',
-        'configuration': self._render_syncfusion_flutter_charts(),
-      }
-
-    if technology == ChartRenderTechnology.APEX_CHARTS:
-      return {
-        'library': 'APEXCHARTS',
-        'chart': 'BAR',
-        'configuration': self._render_apexcharts(),
-      }
-
-    return {
-      'library': 'FLUTTER',
-      'chart': 'TEXT',
-      'configuration': [f'Unsupported rendering technology {technology.name}'],
-    }
-
-  def _render_syncfusion_flutter_charts(self: Self) -> Dict[str, Any]:
-    """
-    Converts the configuration of the chart to Syncfusion Flutter Charts.
-    """
-    series = []
-
-    for serie in self.y_axis:
-      values = []
-      for i, value in enumerate(serie.data):
-        x_axis = self.x_axis.data[i]
-        values.append({'xAxis': x_axis, 'yAxis': value})
-
-      series.append(
-        {
-          'label': serie.label,
-          'color': serie.color,
-          'values': values,
-        }
-      )
-
-    return {
-      'series': series,
-      'xAxis': {
-        'label': self.x_axis_config.label,
-        'measureUnit': self.x_axis_config.measure_unit,
-        'dataType': self.x_axis_config.data_type.value,
-        'minValue': self.x_axis_config.min_value,
-        'maxValue': self.x_axis_config.max_value,
-      },
-      'yAxis': {
-        'label': self.y_axis_config.label,
-        'measureUnit': self.y_axis_config.measure_unit,
-        'dataType': self.y_axis_config.data_type.value,
-        'minValue': self.y_axis_config.min_value,
-        'maxValue': self.y_axis_config.max_value,
-      },
-    }
-
-  def _render_graphic(self: Self) -> List[Dict[str, Any]]:
-    """
-    Converts the configuration of the chart to Flutter library graphic.
-    """
-
-    series = []
-
-    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,
-          }
-        )
-
-    return series
-
-  def _render_apexcharts(self: Self) -> Dict[str, Any]:
-    """
-    Converts the configuration of the chart to Javascript library ApexCharts.
-    """
-
-    series = []
-    colors = []
-
-    for serie in self.y_axis:
-      modified_serie = {'name': serie.label, 'data': serie.data}
-
-      if serie.serie_type is not ChartDataSerieType.NONE:
-        modified_serie['type'] = serie.serie_type.value
-
-      series.append(modified_serie)
-      colors.append(serie.color)
-
-    config = {
-      'series': series,
-      'colors': colors,
-      'xaxis': {
-        'categories': self.x_axis.data,
-        'type': self.x_axis.data_type.value,
-        '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},
-      'chart': {
-        'type': 'bar',
-        'animations': {'enabled': False},
-        'toolbar': {'show': False},
-        'zoom': {'enabled': False},
-      },
-    }
-
-    return config
+"""Bar chart"""
+
+import sys
+from typing import Any, Dict, List
+
+from pydantic import BaseModel, Field
+
+from .axis_config import AxisConfig
+from .chart_alignment import ChartAlignment
+from .chart_data_serie import ChartDataSerie
+from .chart_data_serie_type import ChartDataSerieType
+from .chart_render_technology import ChartRenderTechnology
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class BarChart(BaseModel):
+  """Bar chart configuration"""
+
+  x_axis: ChartDataSerie = Field(description='Defines the X Axis of the chart')
+  y_axis: List[ChartDataSerie] = Field(description='Defines the Y Axis of the chart', default_factory=list)
+  title: str = Field(default='Chart', description='Title of the chart')
+  align: ChartAlignment = Field(default=ChartAlignment.CENTER, description='Alignment of the title')
+  x_axis_config: AxisConfig = Field(
+    default_factory=lambda: AxisConfig(),
+    description='Configuration of the X Axis',
+  )
+  y_axis_config: AxisConfig = Field(
+    default_factory=lambda: AxisConfig(),
+    description='Configuration of the Y Axis',
+  )
+
+  def render(
+    self: Self,
+    technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
+  ) -> Dict[str, Any]:
+    """
+    Render chart to a graphic Library.
+    :param technology: The technology to use to render the chart.
+    :return: The configuration of the chart.
+    """
+    if technology == ChartRenderTechnology.GRAPHIC:
+      return {
+        'library': 'GRAPHIC',
+        'chart': 'BAR',
+        'configuration': self._render_graphic(),
+      }
+
+    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
+      return {
+        'library': 'SYNCFUSION_FLUTTER_CHARTS',
+        'chart': 'BAR',
+        'configuration': self._render_syncfusion_flutter_charts(),
+      }
+
+    if technology == ChartRenderTechnology.APEX_CHARTS:
+      return {
+        'library': 'APEXCHARTS',
+        'chart': 'BAR',
+        'configuration': self._render_apexcharts(),
+      }
+
+    return {
+      'library': 'FLUTTER',
+      'chart': 'TEXT',
+      'configuration': [f'Unsupported rendering technology {technology.name}'],
+    }
+
+  def _render_syncfusion_flutter_charts(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to Syncfusion Flutter Charts.
+    """
+    series = []
+
+    for serie in self.y_axis:
+      values = []
+      for i, value in enumerate(serie.data):
+        x_axis = self.x_axis.data[i]
+        values.append({'xAxis': x_axis, 'yAxis': value})
+
+      series.append(
+        {
+          'label': serie.label,
+          'color': serie.color,
+          'values': values,
+        }
+      )
+
+    return {
+      'series': series,
+      'xAxis': {
+        'label': self.x_axis_config.label,
+        'measureUnit': self.x_axis_config.measure_unit,
+        'dataType': self.x_axis_config.data_type.value,
+        'minValue': self.x_axis_config.min_value,
+        'maxValue': self.x_axis_config.max_value,
+      },
+      'yAxis': {
+        'label': self.y_axis_config.label,
+        'measureUnit': self.y_axis_config.measure_unit,
+        'dataType': self.y_axis_config.data_type.value,
+        'minValue': self.y_axis_config.min_value,
+        'maxValue': self.y_axis_config.max_value,
+      },
+    }
+
+  def _render_graphic(self: Self) -> List[Dict[str, Any]]:
+    """
+    Converts the configuration of the chart to Flutter library graphic.
+    """
+
+    series = []
+
+    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,
+          }
+        )
+
+    return series
+
+  def _render_apexcharts(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to Javascript library ApexCharts.
+    """
+
+    series = []
+    colors = []
+
+    for serie in self.y_axis:
+      modified_serie = {'name': serie.label, 'data': serie.data}
+
+      if serie.serie_type is not ChartDataSerieType.NONE:
+        modified_serie['type'] = serie.serie_type.value
+
+      series.append(modified_serie)
+      colors.append(serie.color)
+
+    config = {
+      'series': series,
+      'colors': colors,
+      'xaxis': {
+        'categories': self.x_axis.data,
+        'type': self.x_axis.data_type.value,
+        '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},
+      'chart': {
+        'type': 'bar',
+        'animations': {'enabled': False},
+        'toolbar': {'show': False},
+        'zoom': {'enabled': False},
+      },
+    }
+
+    return config

layrz_sdk/entities/charts/chart_alignment.py

@@ -1,27 +1,27 @@
-"""Chart alignment"""
-
-import sys
-from enum import Enum
-
-if sys.version_info >= (3, 11):
-  from typing import Self
-else:
-  from typing_extensions import Self
-
-
-class ChartAlignment(Enum):
-  """
-  Chart Alignment
-  """
-
-  CENTER = 'center'
-  LEFT = 'left'
-  RIGHT = 'right'
-
-  def __str__(self: Self) -> str:
-    """Readable property"""
-    return self.name
-
-  def __repr__(self: Self) -> str:
-    """Readable property"""
-    return f'ChartAlignment.{self.name}'
+"""Chart alignment"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ChartAlignment(Enum):
+  """
+  Chart Alignment
+  """
+
+  CENTER = 'center'
+  LEFT = 'left'
+  RIGHT = 'right'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ChartAlignment.{self.name}'