Skip to content

Commit 772c26b

Browse files
authored
Add organization_id support for Events API (#259)
* Add organization_id * lint
1 parent 2c25582 commit 772c26b

File tree

3 files changed

+18
-3
lines changed

3 files changed

+18
-3
lines changed

tests/test_events.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ def mock_events(self):
1919
"params": {
2020
"events": None,
2121
"limit": None,
22+
"organization_id": None,
2223
"after": None,
2324
"range_start": None,
2425
"range_end": None,
@@ -43,3 +44,16 @@ def test_list_events_returns_metadata(self, mock_events, mock_request_method):
4344
)
4445

4546
assert events["metadata"]["params"]["events"] == ["dsync.user.created"]
47+
48+
def test_list_events_with_organization_id_returns_metadata(
49+
self, mock_events, mock_request_method
50+
):
51+
mock_request_method("get", mock_events, 200)
52+
53+
events = self.events.list_events(
54+
events=["dsync.user.created"],
55+
organization_id="org_1234",
56+
)
57+
58+
assert events["metadata"]["params"]["organization_id"] == "org_1234"
59+
assert events["metadata"]["params"]["events"] == ["dsync.user.created"]

tests/utils/fixtures/mock_event.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ def __init__(self, id):
77
self.object = "event"
88
self.id = id
99
self.event = "dsync.user.created"
10-
self.data = {
11-
"id": "event_01234ABCD",
12-
}
10+
self.data = {"id": "event_01234ABCD", "organization_id": "org_1234"}
1311
self.created_at = datetime.datetime.now()
1412

1513
OBJECT_FIELDS = [

workos/events.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ def list_events(
2828
self,
2929
events=None,
3030
limit=None,
31+
organization_id=None,
3132
after=None,
3233
range_start=None,
3334
range_end=None,
@@ -36,6 +37,7 @@ def list_events(
3637
Kwargs:
3738
events (list): Filter to only return events of particular types. (Optional)
3839
limit (int): Maximum number of records to return. (Optional)
40+
organization_id(str): Organization ID limits scope of events to a single organization. (Optional)
3941
after (str): Pagination cursor to receive records after a provided Event ID. (Optional)
4042
range_start (str): Date range start for stream of events. (Optional)
4143
range_end (str): Date range end for stream of events. (Optional)
@@ -53,6 +55,7 @@ def list_events(
5355
"events": events,
5456
"limit": limit,
5557
"after": after,
58+
"organization_id": organization_id,
5659
"range_start": range_start,
5760
"range_end": range_end,
5861
}

0 commit comments

Comments
 (0)