Add organization_id support for Events API (#259)

* Add organization_id * lint
workos · Apr 26, 2024 · 772c26b · 772c26b
1 parent 2c25582
commit 772c26b
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/tests/test_events.py b/tests/test_events.py
@@ -19,6 +19,7 @@ def mock_events(self):
                 "params": {
                     "events": None,
                     "limit": None,
+                    "organization_id": None,
                     "after": None,
                     "range_start": None,
                     "range_end": None,
@@ -43,3 +44,16 @@ def test_list_events_returns_metadata(self, mock_events, mock_request_method):
         )
 
         assert events["metadata"]["params"]["events"] == ["dsync.user.created"]
+
+    def test_list_events_with_organization_id_returns_metadata(
+        self, mock_events, mock_request_method
+    ):
+        mock_request_method("get", mock_events, 200)
+
+        events = self.events.list_events(
+            events=["dsync.user.created"],
+            organization_id="org_1234",
+        )
+
+        assert events["metadata"]["params"]["organization_id"] == "org_1234"
+        assert events["metadata"]["params"]["events"] == ["dsync.user.created"]
diff --git a/tests/utils/fixtures/mock_event.py b/tests/utils/fixtures/mock_event.py
@@ -7,9 +7,7 @@ def __init__(self, id):
         self.object = "event"
         self.id = id
         self.event = "dsync.user.created"
-        self.data = {
-            "id": "event_01234ABCD",
-        }
+        self.data = {"id": "event_01234ABCD", "organization_id": "org_1234"}
         self.created_at = datetime.datetime.now()
 
     OBJECT_FIELDS = [

diff --git a/workos/events.py b/workos/events.py
@@ -28,6 +28,7 @@ def list_events(
         self,
         events=None,
         limit=None,
+        organization_id=None,
         after=None,
         range_start=None,
         range_end=None,
@@ -36,6 +37,7 @@ def list_events(
         Kwargs:
             events (list): Filter to only return events of particular types. (Optional)
             limit (int): Maximum number of records to return. (Optional)
+            organization_id(str): Organization ID limits scope of events to a single organization. (Optional)
             after (str): Pagination cursor to receive records after a provided Event ID. (Optional)
             range_start (str): Date range start for stream of events. (Optional)
             range_end (str): Date range end for stream of events. (Optional)
@@ -53,6 +55,7 @@ def list_events(
             "events": events,
             "limit": limit,
             "after": after,
+            "organization_id": organization_id,
             "range_start": range_start,
             "range_end": range_end,
         }