Skip to content

Commit

Permalink
fix(Events)!: Add missing parameter stream_position to get_admin_ev…
Browse files Browse the repository at this point in the history
…ents method (#648)
  • Loading branch information
arjankowski committed Dec 21, 2021
1 parent 9b3397f commit 3c08b42
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
8 changes: 7 additions & 1 deletion boxsdk/object/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ def get_events(self, limit=100, stream_position=0, stream_type=UserEventsStreamT
return self.translator.translate(self._session, response_object=response)

@api_call
def get_admin_events(self, limit=None, created_after=None, created_before=None, event_types=None):
def get_admin_events(self, limit=None, stream_position=0, created_after=None, created_before=None, event_types=None):
"""
Get Box Admin events from a datetime, to a datetime, or between datetimes with a given event type for a enterprise
stream type. Used for historical querying (up to one year). Works for Enterprise admin_logs type.
Expand All @@ -102,6 +102,10 @@ def get_admin_events(self, limit=None, created_after=None, created_before=None,
(optional) Maximum number of events to return.
:type limit:
`int` or None
:param stream_position:
The location in the stream from which to start getting events. 0 is the beginning of time.
:type stream_position:
`unicode`
:param created_after:
(optional) Start date in datetime format to pull events from
Defaults to `None`
Expand Down Expand Up @@ -132,6 +136,8 @@ def get_admin_events(self, limit=None, created_after=None, created_before=None,
params['limit'] = limit
if event_types is not None:
params['event_type'] = ','.join(event_types)
if stream_position is not None:
params['stream_position'] = stream_position
box_response = self._session.get(url, params=params)
response = box_response.json()
return self.translator.translate(self._session, response_object=response)
Expand Down
3 changes: 3 additions & 0 deletions test/unit/object/test_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -221,18 +221,21 @@ def test_get_admin_events(
mock_box_session.get.return_value = events_response
events = test_events.get_admin_events(
limit=limit,
stream_position=0,
created_after='2019-07-01T22:02:24-07:00',
created_before='2019-08-07T22:02:24-07:00',
event_types=['ITEM_CREATE', "LOGIN"],
)
expected_params = dict(
stream_position=0,
created_after='2019-07-01T22:02:24-07:00',
created_before='2019-08-07T22:02:24-07:00',
event_type='ITEM_CREATE,LOGIN',
stream_type='admin_logs',
)
if limit:
expected_params = dict(
stream_position=0,
created_after='2019-07-01T22:02:24-07:00',
created_before='2019-08-07T22:02:24-07:00',
event_type='ITEM_CREATE,LOGIN',
Expand Down

0 comments on commit 3c08b42

Please sign in to comment.