layrz-sdk 4.0.21__tar.gz → 4.0.23__tar.gz

layrz_sdk-4.0.23/.gitignore

@@ -0,0 +1,18 @@
+dist/
+build/
+*.egg-info/
+/test.py
+/**/*.pyc
+.venv/
+site/
+
+**/*/__pycache__/
+
+tests.py
+*.xlsx
+
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+
+.env

{layrz_sdk-4.0.21 → layrz_sdk-4.0.23}/.vscode/extensions.json

@@ -3,7 +3,6 @@
     "ms-python.python",
     "charliermarsh.ruff",
     "ms-python.vscode-pylance",
-    "njpwerner.autodocstring",
     "oderwat.indent-rainbow"
   ]
 }

{layrz_sdk-4.0.21 → layrz_sdk-4.0.23}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 4.0.23
+
+- Added `should_stack` field to `Trigger` entity to define if the trigger cases should stack.
+- Added `stack_upper_limit` field to `Trigger` entity to define the stack upper limit of the trigger cases.
+- Added `stack_count` field to `Case` entity to define how many cases are stacked together. By default is 1 due to backwards compatibility.
+- Added validation to `stack_count` field in `Case` entity to ensure it is a positive integer. If the value is less than 1 or not an integer, it defaults to 1.
+- Added `metadata` field to `Comment` entity to store additional metadata associated with the comment. This field is a dictionary with string keys and values of any type, defaulting to an empty dictionary.
+
+## 4.0.22
+
+- Updated `Case` entity to include `ignored_status` field to represent the ignored status of the case.
+- Updated `Trigger` entity to support cases changes.
+- Some changes on the affected models to use the right definiton of pydantic regarding of the serialization.
+
 ## 4.0.21
 
 - Added `owner_id` field to `Geofence` entity to represent the owner of the geofence.

{layrz_sdk-4.0.21/layrz_sdk.egg-info → layrz_sdk-4.0.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.21
+Version: 4.0.23
 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-4.0.21 → layrz_sdk-4.0.23}/layrz_sdk/entities/case.py

@@ -30,6 +30,11 @@ class Case(BaseModel):
     description='Defines the sequence of the case. This is a unique identifier for the case',
   )
 
+  stack_count: int = Field(
+    default=1,
+    description='Defines how many cases are stacked together. Only applicable if the trigger allows stacking',
+  )
+
   @model_validator(mode='before')
   def _validate_model(cls: Self, data: dict[str, Any]) -> dict[str, Any]:
     """Validate model"""
@@ -48,4 +53,10 @@ class Case(BaseModel):
     else:
       data['sequence'] = f'GENERIC/{data["pk"]}'
 
+    if stack_count := data.get('stack_count'):
+      if not isinstance(stack_count, int) or stack_count < 1:
+        data['stack_count'] = 1
+    else:
+      data['stack_count'] = 1
+
     return data

{layrz_sdk-4.0.21 → layrz_sdk-4.0.23}/layrz_sdk/entities/case_ignored_status.py

@@ -11,6 +11,7 @@ class CaseIgnoredStatus(StrEnum):
   IGNORED = 'IGNORED'
   PRESET = 'PRESET'
   AUTO = 'AUTO'
+  EXPIRED = 'EXPIRED'
 
   def __str__(self: Self) -> str:
     """Readable property"""

{layrz_sdk-4.0.21 → layrz_sdk-4.0.23}/layrz_sdk/entities/comment.py

@@ -1,6 +1,7 @@
 """Comment entity"""
 
 from datetime import datetime
+from typing import Any
 
 from pydantic import BaseModel, Field
 
@@ -12,5 +13,10 @@ class Comment(BaseModel):
 
   pk: int = Field(description='Comment ID', alias='id')
   content: str = Field(description='Comment content')
-  user: User = Field(description='Operator/User what commented the case')
+  user: User | None = Field(description='Operator/User what commented the case. None if system generated')
   submitted_at: datetime = Field(description='Date of comment submission')
+
+  metadata: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Additional metadata associated with the comment',
+  )

{layrz_sdk-4.0.21 → layrz_sdk-4.0.23}/layrz_sdk/entities/trigger.py

@@ -3,7 +3,7 @@
 from datetime import time, timedelta
 from typing import Any
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, Field, field_serializer, field_validator
 
 from .trigger_kind import TriggerCaseKind, TriggerCommentPattern, TriggerGeofenceKind, TriggerKind
 from .weekday import Weekday
@@ -12,17 +12,6 @@ from .weekday import Weekday
 class Trigger(BaseModel):
   """Trigger entity"""
 
-  model_config = {
-    'json_encoders': {
-      timedelta: lambda v: v.total_seconds(),
-      TriggerCaseKind: lambda v: v.value,
-      TriggerGeofenceKind: lambda v: v.value,
-      TriggerKind: lambda v: v.value,
-      TriggerCommentPattern: lambda v: v.value,
-      Weekday: 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')
   code: str = Field(description='Defines the code of the trigger')
@@ -32,27 +21,52 @@ class Trigger(BaseModel):
     description='Defines the cooldown time of the trigger',
   )
 
+  @field_serializer('cooldown_time', when_used='always')
+  def serialize_cooldown_time(self, value: timedelta) -> float:
+    """Serialize cooldown_time to total seconds."""
+    return value.total_seconds()
+
   type_: TriggerKind | None = Field(
     default=None,
     description='Defines the kind of the trigger',
     alias='type',
   )
 
+  @field_serializer('type_', when_used='always')
+  def serialize_type(self, value: TriggerKind | None) -> str | None:
+    """Serialize type_ to its value."""
+    return value.value if value else None
+
   presence_type: TriggerGeofenceKind | None = Field(
     default=None,
     description='Defines the geofence kind of the trigger',
   )
 
+  @field_serializer('presence_type', when_used='always')
+  def serialize_presence_type(self, value: TriggerGeofenceKind | None) -> str | None:
+    """Serialize presence_type to its value."""
+    return value.value if value else None
+
   case_type: TriggerCaseKind | None = Field(
     default=None,
     description='Defines the case kind of the trigger',
   )
 
+  @field_serializer('case_type', when_used='always')
+  def serialize_case_type(self, value: TriggerCaseKind | None) -> str | None:
+    """Serialize case_type to its value."""
+    return value.value if value else None
+
   case_comment_pattern: TriggerCommentPattern | None = Field(
     default=None,
     description='Defines the comment pattern of the trigger',
   )
 
+  @field_serializer('case_comment_pattern', when_used='always')
+  def serialize_case_comment_pattern(self, value: TriggerCommentPattern | None) -> str | None:
+    """Serialize case_comment_pattern to its value."""
+    return value.value if value else None
+
   case_comment_value: str | None = Field(
     default=None,
     description='Defines the comment pattern value of the trigger',
@@ -72,6 +86,11 @@ class Trigger(BaseModel):
     description='Defines the weekdays of the trigger',
   )
 
+  @field_serializer('weekdays', when_used='always')
+  def serialize_weekdays(self, value: list[Weekday]) -> list[str]:
+    """Serialize weekdays to their values."""
+    return [day.value for day in value]
+
   is_plain_crontab: bool = Field(
     default=False,
     description='Defines if the trigger is a plain crontab',
@@ -145,6 +164,29 @@ class Trigger(BaseModel):
     default=None,
     description='Defines the care protocol ID of the trigger',
   )
+  has_case_expirity: bool = Field(
+    default=False,
+    description='Defines if the trigger has case expiry',
+  )
+
+  when_case_expires_delta: timedelta | None = Field(
+    default=None,
+    description='Defines when the trigger expires delta',
+  )
+
+  @field_serializer('when_case_expires_delta', when_used='always')
+  def serialize_when_case_expires_delta(self, value: timedelta | None) -> float | None:
+    """Serialize when_case_expires_delta to total seconds."""
+    return value.total_seconds() if value else None
+
+  should_stack: bool = Field(
+    default=False,
+    description='Defines if the trigger cases should stack',
+  )
+  stack_upper_limit: int | None = Field(
+    default=None,
+    description='Defines the stack upper limit of the trigger cases. None means no limit',
+  )
 
   owner_id: int | None = Field(
     default=None,
@@ -155,3 +197,8 @@ class Trigger(BaseModel):
     default=None,
     description='Defines the search time delta of the trigger',
   )
+
+  @field_serializer('search_time_delta', when_used='always')
+  def serialize_search_time_delta(self, value: timedelta | None) -> float | None:
+    """Serialize search_time_delta to total seconds."""
+    return value.total_seconds() if value else None

{layrz_sdk-4.0.21 → layrz_sdk-4.0.23/layrz_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.21
+Version: 4.0.23
 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-4.0.21 → layrz_sdk-4.0.23}/manual_deploy.py

@@ -1,6 +1,10 @@
 import os
 import shutil
 
+from dotenv import load_dotenv
+
+load_dotenv()
+
 # Remove previous build
 if os.path.exists('dist'):
   shutil.rmtree('dist')

{layrz_sdk-4.0.21 → layrz_sdk-4.0.23}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "4.0.21"
+version = "4.0.23"
 description = "Layrz SDK for Python"
 authors = [{ name = "Golden M, Inc.", email = "software@goldenm.com" }]
 requires-python = ">=3.13"

{layrz_sdk-4.0.21 → layrz_sdk-4.0.23}/uv.lock

@@ -1,5 +1,5 @@
 version = 1
-revision = 2
+revision = 3
 requires-python = ">=3.13"
 
 [[package]]
@@ -233,7 +233,7 @@ wheels = [
 
 [[package]]
 name = "layrz-sdk"
-version = "4.0.21"
+version = "4.0.23"
 source = { editable = "." }
 dependencies = [
     { name = "geopy" },

layrz_sdk-4.0.21/.gitignore

@@ -1,19 +0,0 @@
-/dist
-/build
-/*.egg-info
-/.pypirc
-/test.py
-/**/*.pyc
-/.venv
-/site
-
-/**/*/__pycache__
-
-tests.py
-*.xlsx
-
-.ruff_cache
-.mypy_cache
-.pytest_cache
-
-.env