@@ -62,8 +62,32 @@ def list(
62
62
timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
63
63
) -> SyncEntriesPage [EventListResponse ]:
64
64
"""
65
- ListAuditLogs retrieves a paginated list of audit logs for the specified
66
- organization
65
+ Lists audit logs with filtering and pagination options.
66
+
67
+ Use this method to:
68
+
69
+ - View audit history
70
+ - Track user actions
71
+ - Monitor system changes
72
+
73
+ ### Examples
74
+
75
+ - List all logs:
76
+
77
+ ```yaml
78
+ pagination:
79
+ pageSize: 20
80
+ ```
81
+
82
+ - Filter by actor:
83
+
84
+ ```yaml
85
+ filter:
86
+ actorIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
87
+ actorPrincipals: ["PRINCIPAL_USER"]
88
+ pagination:
89
+ pageSize: 20
90
+ ```
67
91
68
92
Args:
69
93
pagination: pagination contains the pagination options for listing environments
@@ -116,7 +140,23 @@ def watch(
116
140
timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
117
141
) -> JSONLDecoder [EventWatchResponse ]:
118
142
"""
119
- WatchEvents streams all requests events to the client
143
+ Streams events for all projects, runners, environments, tasks, and services
144
+ based on the specified scope.
145
+
146
+ Use this method to:
147
+
148
+ - Monitor resource changes in real-time
149
+ - Track system events
150
+ - Receive notifications
151
+
152
+ The scope parameter determines which events to watch:
153
+
154
+ - Organization scope (default): Watch all organization-wide events including
155
+ projects, runners and environments. Task and service events are not included.
156
+ Use by setting organization=true or omitting the scope.
157
+ - Environment scope: Watch events for a specific environment, including its
158
+ tasks, task executions, and services. Use by setting environment_id to the
159
+ UUID of the environment to watch.
120
160
121
161
Args:
122
162
environment_id: Environment scope produces events for the environment itself, all tasks, task
@@ -187,8 +227,32 @@ def list(
187
227
timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
188
228
) -> AsyncPaginator [EventListResponse , AsyncEntriesPage [EventListResponse ]]:
189
229
"""
190
- ListAuditLogs retrieves a paginated list of audit logs for the specified
191
- organization
230
+ Lists audit logs with filtering and pagination options.
231
+
232
+ Use this method to:
233
+
234
+ - View audit history
235
+ - Track user actions
236
+ - Monitor system changes
237
+
238
+ ### Examples
239
+
240
+ - List all logs:
241
+
242
+ ```yaml
243
+ pagination:
244
+ pageSize: 20
245
+ ```
246
+
247
+ - Filter by actor:
248
+
249
+ ```yaml
250
+ filter:
251
+ actorIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
252
+ actorPrincipals: ["PRINCIPAL_USER"]
253
+ pagination:
254
+ pageSize: 20
255
+ ```
192
256
193
257
Args:
194
258
pagination: pagination contains the pagination options for listing environments
@@ -241,7 +305,23 @@ async def watch(
241
305
timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
242
306
) -> AsyncJSONLDecoder [EventWatchResponse ]:
243
307
"""
244
- WatchEvents streams all requests events to the client
308
+ Streams events for all projects, runners, environments, tasks, and services
309
+ based on the specified scope.
310
+
311
+ Use this method to:
312
+
313
+ - Monitor resource changes in real-time
314
+ - Track system events
315
+ - Receive notifications
316
+
317
+ The scope parameter determines which events to watch:
318
+
319
+ - Organization scope (default): Watch all organization-wide events including
320
+ projects, runners and environments. Task and service events are not included.
321
+ Use by setting organization=true or omitting the scope.
322
+ - Environment scope: Watch events for a specific environment, including its
323
+ tasks, task executions, and services. Use by setting environment_id to the
324
+ UUID of the environment to watch.
245
325
246
326
Args:
247
327
environment_id: Environment scope produces events for the environment itself, all tasks, task
0 commit comments