Skip to content

Commit 3c08b42

Browse files
authored
fix(Events)!: Add missing parameter stream_position to get_admin_events method (#648)
1 parent 9b3397f commit 3c08b42

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

boxsdk/object/events.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ def get_events(self, limit=100, stream_position=0, stream_type=UserEventsStreamT
9393
return self.translator.translate(self._session, response_object=response)
9494

9595
@api_call
96-
def get_admin_events(self, limit=None, created_after=None, created_before=None, event_types=None):
96+
def get_admin_events(self, limit=None, stream_position=0, created_after=None, created_before=None, event_types=None):
9797
"""
9898
Get Box Admin events from a datetime, to a datetime, or between datetimes with a given event type for a enterprise
9999
stream type. Used for historical querying (up to one year). Works for Enterprise admin_logs type.
@@ -102,6 +102,10 @@ def get_admin_events(self, limit=None, created_after=None, created_before=None,
102102
(optional) Maximum number of events to return.
103103
:type limit:
104104
`int` or None
105+
:param stream_position:
106+
The location in the stream from which to start getting events. 0 is the beginning of time.
107+
:type stream_position:
108+
`unicode`
105109
:param created_after:
106110
(optional) Start date in datetime format to pull events from
107111
Defaults to `None`
@@ -132,6 +136,8 @@ def get_admin_events(self, limit=None, created_after=None, created_before=None,
132136
params['limit'] = limit
133137
if event_types is not None:
134138
params['event_type'] = ','.join(event_types)
139+
if stream_position is not None:
140+
params['stream_position'] = stream_position
135141
box_response = self._session.get(url, params=params)
136142
response = box_response.json()
137143
return self.translator.translate(self._session, response_object=response)

test/unit/object/test_events.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,18 +221,21 @@ def test_get_admin_events(
221221
mock_box_session.get.return_value = events_response
222222
events = test_events.get_admin_events(
223223
limit=limit,
224+
stream_position=0,
224225
created_after='2019-07-01T22:02:24-07:00',
225226
created_before='2019-08-07T22:02:24-07:00',
226227
event_types=['ITEM_CREATE', "LOGIN"],
227228
)
228229
expected_params = dict(
230+
stream_position=0,
229231
created_after='2019-07-01T22:02:24-07:00',
230232
created_before='2019-08-07T22:02:24-07:00',
231233
event_type='ITEM_CREATE,LOGIN',
232234
stream_type='admin_logs',
233235
)
234236
if limit:
235237
expected_params = dict(
238+
stream_position=0,
236239
created_after='2019-07-01T22:02:24-07:00',
237240
created_before='2019-08-07T22:02:24-07:00',
238241
event_type='ITEM_CREATE,LOGIN',

0 commit comments

Comments
 (0)