fix: Update events methods params (#93)

* Update events methods' params

* Update docs for events methods

Author: andrii-balitskyi

seamapi/events.py

@@ -1,10 +1,19 @@
 from seamapi.types import (
+    AccessCode,
+    ConnectedAccount,
+    Device,
     Event,
     AbstractEvents,
     AbstractSeam as Seam,
 )
-from typing import List, Optional
+from typing import List, Optional, Union
 import requests
+from seamapi.utils.convert_to_id import (
+    to_access_code_id,
+    to_connected_account_id,
+    to_device_id,
+    to_event_id,
+)
 
 from seamapi.utils.report_error import report_error
 
@@ -22,8 +31,11 @@ class Events(AbstractEvents):
 
     Methods
     -------
-    list(since, device_id=None, device_ids=None, event_type=None, event_types=None)
+    list(since=None, between=None, device_id=None, device_ids=None, access_code_id=None, access_code_ids=None, event_type=None, event_types=None, connected_account_id=None)
         Gets a list of events
+
+    get(device_id=None, event_id=None, event_type=None)
+        Gets an event
     """
 
     seam: Seam
@@ -33,33 +45,45 @@ def __init__(self, seam: Seam):
         Parameters
         ----------
         seam : Seam
-          Intial seam class
+          Initial seam class
         """
         self.seam = seam
 
     @report_error
     def list(
         self,
-        since: str,
-        device_id: Optional[str] = None,
+        since: Optional[str] = None,
+        between: Optional[list] = None,
+        device_id: Union[str, Device] = None,
         device_ids: Optional[list] = None,
+        access_code_id: Union[str, AccessCode] = None,
+        access_code_ids: Optional[list] = None,
         event_type: Optional[str] = None,
         event_types: Optional[list] = None,
+        connected_account_id: Union[str, ConnectedAccount] = None,
     ) -> List[Event]:
         """Gets a list of events.
 
         Parameters
         ----------
-        since : str
+        since : Optional[str]
             ISO 8601 timestamp of the earliest event to return
-        device_id : Optional[str]
-            Device ID to filter events by
+        between : Optional[list]
+            List of two ISO 8601 timestamps to specify a date range for filtering events
+        device_id : Union[str, Device]
+            Device ID or Device to filter events by
         device_ids : Optional[list]
             Device IDs to filter events by
+        access_code_id : Union[str, AccessCode]
+            Access Code ID or AccessCode to filter events by
+        access_code_ids : Optional[list]
+            Access Code IDs to filter events by
         event_type : Optional[str]
             Event type to filter events by
         event_types : Optional[list]
             Event types to filter events by
+        connected_account_id : Union[str, ConnectedAccount]
+            Connected Account ID or ConnectedAccount to filter events by
 
         Raises
         ------
@@ -70,18 +94,27 @@ def list(
         ------
             A list of events.
         """
-        if not since:
-            raise Exception("'since' is required")
-
-        params = {
-            "since": since,
-        }
+        device_id = to_device_id(device_id) if device_id else None
+        access_code_id = (
+            to_access_code_id(access_code_id) if access_code_id else None
+        )
+        connected_account_id = (
+            to_connected_account_id(connected_account_id)
+            if connected_account_id
+            else None
+        )
 
+        params = {}
         arguments = {
+            "since": since,
+            "between": between,
             "device_id": device_id,
             "device_ids": device_ids,
+            "access_code_id": access_code_id,
+            "access_code_ids": access_code_ids,
             "event_type": event_type,
             "event_types": event_types,
+            "connected_account_id": connected_account_id,
         }
 
         for name in arguments:
@@ -99,20 +132,20 @@ def list(
     @report_error
     def get(
         self,
-        event_id: Optional[str] = None,
+        event_id: Union[str, Event] = None,
         event_type: Optional[str] = None,
-        device_id: Optional[str] = None,
+        device_id: Union[str, Device] = None,
     ) -> Event:
         """Get an Event.
 
         Parameters
         ----------
-            event_id : Optional[str]
-                Event ID to filter events by
+            event_id : Union[str, Event]
+                Event ID or Event to filter events by
             event_type : Optional[str]
                 Event type to filter events by
-            device_id : Optional[str]
-                Device ID to filter events by
+            device_id : Union[str, Device]
+                Device ID or Device to filter events by
 
         Raises
         ------
@@ -123,8 +156,10 @@ def get(
         ------
             An event or None.
         """
-        params = {}
+        device_id = to_device_id(device_id) if device_id else None
+        event_id = to_event_id(event_id) if event_id else None
 
+        params = {}
         arguments = {
             "event_id": event_id,
             "event_type": event_type,

seamapi/types.py

@@ -9,6 +9,7 @@
 AccessCodeId = str
 ActionAttemptId = str
 DeviceId = str
+EventId = str
 AcceptedProvider = str  # e.g. august or noiseaware
 ConnectWebviewId = str
 ConnectedAccountId = str

seamapi/utils/convert_to_id.py

@@ -13,6 +13,8 @@
     DeviceId,
     Workspace,
     WorkspaceId,
+    Event,
+    EventId,
 )
 
 
@@ -56,3 +58,9 @@ def to_workspace_id(workspace: Union[WorkspaceId, Workspace]) -> str:
     if isinstance(workspace, str):
         return workspace
     return workspace.workspace_id
+
+
+def to_event_id(event: Union[EventId, Event]) -> str:
+    if isinstance(event, str):
+        return event
+    return event.event_id