Handle optional before in list metadata

workos · Jul 24, 2024 · 9667433 · 9667433
1 parent 0f3367c
commit 9667433
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 38 deletions.
diff --git a/workos/directory_sync.py b/workos/directory_sync.py
@@ -4,7 +4,6 @@
 from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
 from workos.utils.pagination_order import PaginationOrder
 from workos.utils.request import REQUEST_METHOD_DELETE, REQUEST_METHOD_GET
-
 from workos.utils.validation import DIRECTORY_SYNC_MODULE, validate_settings
 from workos.resources.directory_sync import (
     DirectoryGroup,
@@ -51,8 +50,7 @@ def list_users(
         before: Optional[str] = None,
         after: Optional[str] = None,
         order: PaginationOrder = "desc",
-    ) -> SyncOrAsyncListResource:
-        ...
+    ) -> SyncOrAsyncListResource: ...
 
     def list_groups(
         self,
@@ -62,17 +60,13 @@ def list_groups(
         before: Optional[str] = None,
         after: Optional[str] = None,
         order: PaginationOrder = "desc",
-    ) -> SyncOrAsyncListResource:
-        ...
+    ) -> SyncOrAsyncListResource: ...
 
-    def get_user(self, user: str) -> SyncOrAsync[DirectoryUser]:
-        ...
+    def get_user(self, user: str) -> SyncOrAsync[DirectoryUser]: ...
 
-    def get_group(self, group: str) -> SyncOrAsync[DirectoryGroup]:
-        ...
+    def get_group(self, group: str) -> SyncOrAsync[DirectoryGroup]: ...
 
-    def get_directory(self, directory: str) -> SyncOrAsync[Directory]:
-        ...
+    def get_directory(self, directory: str) -> SyncOrAsync[Directory]: ...
 
     def list_directories(
         self,
@@ -83,11 +77,9 @@ def list_directories(
         after: Optional[str] = None,
         organization: Optional[str] = None,
         order: PaginationOrder = "desc",
-    ) -> SyncOrAsyncListResource:
-        ...
+    ) -> SyncOrAsyncListResource: ...
 
-    def delete_directory(self, directory: str) -> SyncOrAsync[None]:
-        ...
+    def delete_directory(self, directory: str) -> SyncOrAsync[None]: ...
 
 
 class DirectorySync(DirectorySyncModule):

diff --git a/workos/events.py b/workos/events.py
@@ -9,7 +9,6 @@
 from workos.resources.list import (
     ListArgs,
     ListPage,
-    WorkOSListResource,
     WorkOsListResource,
 )
 
@@ -38,7 +37,7 @@ def list_events(
     ) -> SyncOrAsync[EventsListResource]: ...
 
 
-class Events(EventsModule, WorkOSListResource):
+class Events(EventsModule):
     """Offers methods through the WorkOS Events service."""
 
     _http_client: SyncHTTPClient
@@ -77,9 +76,6 @@ def list_events(
             "organization_id": organization,
             "range_start": range_start,
             "range_end": range_end,
-            # TODO: This is a hack, and it's wrong. Events does not support before or order
-            "before": None,
-            "order": "desc",
         }
 
         response = self._http_client.request(
@@ -88,15 +84,14 @@ def list_events(
             params=params,
             token=workos.api_key,
         )
-
         return WorkOsListResource(
             list_method=self.list_events,
             list_args=params,
-            **ListPage[Event](**response).model_dump(),
+            **ListPage[Event](**response).model_dump(exclude_unset=True),
         )
 
 
-class AsyncEvents(EventsModule, WorkOSListResource):
+class AsyncEvents(EventsModule):
     """Offers methods through the WorkOS Events service."""
 
     _http_client: AsyncHTTPClient
@@ -134,9 +129,6 @@ async def list_events(
             "organization_id": organization_id,
             "range_start": range_start,
             "range_end": range_end,
-            # TODO: THis is wrong, Events does not support before or order
-            "before": None,
-            "order": "desc",
         }
 
         response = await self._http_client.request(
@@ -149,5 +141,5 @@ async def list_events(
         return WorkOsListResource(
             list_method=self.list_events,
             list_args=params,
-            **ListPage[Event](**response).model_dump(),
+            **ListPage[Event](**response).model_dump(exclude_unset=True),
         )
diff --git a/workos/resources/list.py b/workos/resources/list.py
@@ -2,14 +2,17 @@
 from typing import (
     AsyncIterator,
     Awaitable,
+    Dict,
     List,
     Literal,
+    Required,
     TypeVar,
     Generic,
     Callable,
     Iterator,
     Optional,
     Union,
+    cast,
 )
 from typing_extensions import TypedDict
 from workos.resources.base import WorkOSBaseResource
@@ -122,8 +125,11 @@ def auto_paging_iter(self):
 )
 
 
-class ListMetadata(BaseModel):
+class ListAfterMetadata(BaseModel):
     after: Optional[str] = None
+
+
+class ListMetadata(ListAfterMetadata):
     before: Optional[str] = None
 
 
@@ -133,14 +139,15 @@ class ListPage(WorkOSModel, Generic[ListableResource]):
     list_metadata: ListMetadata
 
 
-class ListArgs(TypedDict):
-    limit: int
+class ListArgs(TypedDict, total=False):
     before: Optional[str]
     after: Optional[str]
-    order: Literal["asc", "desc"]
+    limit: Required[int]
+    order: Optional[Literal["asc", "desc"]]
 
 
 ListAndFilterParams = TypeVar("ListAndFilterParams", bound=ListArgs)
+ListMetadataType = TypeVar("ListMetadataType", ListAfterMetadata, ListMetadata)
 
 
 class BaseWorkOsListResource(
@@ -149,16 +156,22 @@ class BaseWorkOsListResource(
 ):
     object: Literal["list"]
     data: List[ListableResource]
-    list_metadata: ListMetadata
+    list_metadata: Union[ListAfterMetadata, ListMetadata]
 
     list_method: Callable = Field(exclude=True)
     list_args: ListAndFilterParams = Field(exclude=True)
 
     def _parse_params(self):
-        fixed_pagination_params = {
-            "order": self.list_args["order"],
-            "limit": self.list_args["limit"],
-        }
+        fixed_pagination_params = cast(
+            # Type hints consider this a mismatch because it assume the dictionary is dict[str, int]
+            Dict[str, Union[int, str, None]],
+            {
+                "limit": self.list_args["limit"],
+            },
+        )
+        if "order" in self.list_args:
+            fixed_pagination_params["order"] = self.list_args["order"]
+
         # Omit common list parameters
         filter_params = {
             k: v
@@ -171,8 +184,7 @@ def _parse_params(self):
     @abc.abstractmethod
     def auto_paging_iter(
         self,
-    ) -> Union[AsyncIterator[ListableResource], Iterator[ListableResource]]:
-        ...
+    ) -> Union[AsyncIterator[ListableResource], Iterator[ListableResource]]: ...
 
 
 class WorkOsListResource(