@@ -43,12 +43,12 @@ def stream(self, actor_sid=values.unset, event_type=values.unset,
43
43
is reached.
44
44
The results are returned as a generator, so this operation is memory efficient.
45
45
46
- :param unicode actor_sid: The actor_sid
47
- :param unicode event_type: The event_type
48
- :param unicode resource_sid: The resource_sid
49
- :param unicode source_ip_address: The source_ip_address
50
- :param datetime start_date: The start_date
51
- :param datetime end_date: The end_date
46
+ :param unicode actor_sid: Only include Events initiated by this Actor
47
+ :param unicode event_type: Only include Events of this EventType
48
+ :param unicode resource_sid: Only include Events referring to this resource
49
+ :param unicode source_ip_address: Only include Events that originated from this IP address
50
+ :param datetime start_date: Only show events on or after this date
51
+ :param datetime end_date: Only show events on or before this date
52
52
:param int limit: Upper limit for the number of records to return. stream()
53
53
guarantees to never return more than limit. Default is no limit
54
54
:param int page_size: Number of records to fetch per request, when not set will use
@@ -82,12 +82,12 @@ def list(self, actor_sid=values.unset, event_type=values.unset,
82
82
Unlike stream(), this operation is eager and will load `limit` records into
83
83
memory before returning.
84
84
85
- :param unicode actor_sid: The actor_sid
86
- :param unicode event_type: The event_type
87
- :param unicode resource_sid: The resource_sid
88
- :param unicode source_ip_address: The source_ip_address
89
- :param datetime start_date: The start_date
90
- :param datetime end_date: The end_date
85
+ :param unicode actor_sid: Only include Events initiated by this Actor
86
+ :param unicode event_type: Only include Events of this EventType
87
+ :param unicode resource_sid: Only include Events referring to this resource
88
+ :param unicode source_ip_address: Only include Events that originated from this IP address
89
+ :param datetime start_date: Only show events on or after this date
90
+ :param datetime end_date: Only show events on or before this date
91
91
:param int limit: Upper limit for the number of records to return. list() guarantees
92
92
never to return more than limit. Default is no limit
93
93
:param int page_size: Number of records to fetch per request, when not set will use
@@ -118,12 +118,12 @@ def page(self, actor_sid=values.unset, event_type=values.unset,
118
118
Retrieve a single page of EventInstance records from the API.
119
119
Request is executed immediately
120
120
121
- :param unicode actor_sid: The actor_sid
122
- :param unicode event_type: The event_type
123
- :param unicode resource_sid: The resource_sid
124
- :param unicode source_ip_address: The source_ip_address
125
- :param datetime start_date: The start_date
126
- :param datetime end_date: The end_date
121
+ :param unicode actor_sid: Only include Events initiated by this Actor
122
+ :param unicode event_type: Only include Events of this EventType
123
+ :param unicode resource_sid: Only include Events referring to this resource
124
+ :param unicode source_ip_address: Only include Events that originated from this IP address
125
+ :param datetime start_date: Only show events on or after this date
126
+ :param datetime end_date: Only show events on or before this date
127
127
:param str page_token: PageToken provided by the API
128
128
:param int page_number: Page Number, this value is simply for client state
129
129
:param int page_size: Number of records to return, defaults to 50
@@ -172,7 +172,7 @@ def get(self, sid):
172
172
"""
173
173
Constructs a EventContext
174
174
175
- :param sid: The sid
175
+ :param sid: A 34 character string that uniquely identifies this event.
176
176
177
177
:returns: twilio.rest.monitor.v1.event.EventContext
178
178
:rtype: twilio.rest.monitor.v1.event.EventContext
@@ -183,7 +183,7 @@ def __call__(self, sid):
183
183
"""
184
184
Constructs a EventContext
185
185
186
- :param sid: The sid
186
+ :param sid: A 34 character string that uniquely identifies this event.
187
187
188
188
:returns: twilio.rest.monitor.v1.event.EventContext
189
189
:rtype: twilio.rest.monitor.v1.event.EventContext
@@ -247,7 +247,7 @@ def __init__(self, version, sid):
247
247
Initialize the EventContext
248
248
249
249
:param Version version: Version that contains the resource
250
- :param sid: The sid
250
+ :param sid: A 34 character string that uniquely identifies this event.
251
251
252
252
:returns: twilio.rest.monitor.v1.event.EventContext
253
253
:rtype: twilio.rest.monitor.v1.event.EventContext
@@ -336,23 +336,23 @@ def _proxy(self):
336
336
@property
337
337
def account_sid (self ):
338
338
"""
339
- :returns: The account_sid
339
+ :returns: A 34 character string identifying the Account for which this Event was recorded.
340
340
:rtype: unicode
341
341
"""
342
342
return self ._properties ['account_sid' ]
343
343
344
344
@property
345
345
def actor_sid (self ):
346
346
"""
347
- :returns: The actor_sid
347
+ :returns: If available, a 34 character string identifying the actor that caused this event. May be null.
348
348
:rtype: unicode
349
349
"""
350
350
return self ._properties ['actor_sid' ]
351
351
352
352
@property
353
353
def actor_type (self ):
354
354
"""
355
- :returns: The actor_type
355
+ :returns: The type of actor that caused this event
356
356
:rtype: unicode
357
357
"""
358
358
return self ._properties ['actor_type' ]
@@ -368,39 +368,39 @@ def description(self):
368
368
@property
369
369
def event_data (self ):
370
370
"""
371
- :returns: The event_data
371
+ :returns: A freeform json object encoding additional data about the event
372
372
:rtype: dict
373
373
"""
374
374
return self ._properties ['event_data' ]
375
375
376
376
@property
377
377
def event_date (self ):
378
378
"""
379
- :returns: The event_date
379
+ :returns: The date-time the event was recorded
380
380
:rtype: datetime
381
381
"""
382
382
return self ._properties ['event_date' ]
383
383
384
384
@property
385
385
def event_type (self ):
386
386
"""
387
- :returns: The event_type
387
+ :returns: The event's type, as a string.
388
388
:rtype: unicode
389
389
"""
390
390
return self ._properties ['event_type' ]
391
391
392
392
@property
393
393
def resource_sid (self ):
394
394
"""
395
- :returns: The resource_sid
395
+ :returns: A 34 character string identifying the resource that was affected.
396
396
:rtype: unicode
397
397
"""
398
398
return self ._properties ['resource_sid' ]
399
399
400
400
@property
401
401
def resource_type (self ):
402
402
"""
403
- :returns: The resource_type
403
+ :returns: The type of resource that was affected
404
404
:rtype: unicode
405
405
"""
406
406
return self ._properties ['resource_type' ]
@@ -424,7 +424,7 @@ def source(self):
424
424
@property
425
425
def source_ip_address (self ):
426
426
"""
427
- :returns: The source_ip_address
427
+ :returns: The IP address of the source
428
428
:rtype: unicode
429
429
"""
430
430
return self ._properties ['source_ip_address' ]
0 commit comments