-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathevents_api.py
More file actions
423 lines (365 loc) · 18.2 KB
/
events_api.py
File metadata and controls
423 lines (365 loc) · 18.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
# coding: utf-8
"""
Opal API
The Opal API is a RESTful API that allows you to interact with the Opal Security platform programmatically.
The version of the OpenAPI document: 1.0
Contact: hello@opal.dev
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from pydantic import Field, StrictStr
from typing import Optional
from typing_extensions import Annotated
from uuid import UUID
from opal_security.models.paginated_event_list import PaginatedEventList
from opal_security.api_client import ApiClient, RequestSerialized
from opal_security.api_response import ApiResponse
from opal_security.rest import RESTResponseType
class EventsApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def events(
self,
start_date_filter: Annotated[Optional[StrictStr], Field(description="A start date filter for the events.")] = None,
end_date_filter: Annotated[Optional[StrictStr], Field(description="An end date filter for the events.")] = None,
actor_filter: Annotated[Optional[UUID], Field(description="An actor filter for the events. Supply the ID of the actor.")] = None,
object_filter: Annotated[Optional[UUID], Field(description="An object filter for the events. Supply the ID of the object.")] = None,
event_type_filter: Annotated[Optional[StrictStr], Field(description="An event type filter for the events.")] = None,
api_token_filter: Annotated[Optional[StrictStr], Field(description="An API filter for the events. Supply the name and preview of the API token.")] = None,
cursor: Annotated[Optional[StrictStr], Field(description="The pagination cursor value.")] = None,
page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True)]], Field(description="Number of results to return per page. Default is 200.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> PaginatedEventList:
"""events
Returns a list of `Event` objects.
:param start_date_filter: A start date filter for the events.
:type start_date_filter: str
:param end_date_filter: An end date filter for the events.
:type end_date_filter: str
:param actor_filter: An actor filter for the events. Supply the ID of the actor.
:type actor_filter: UUID
:param object_filter: An object filter for the events. Supply the ID of the object.
:type object_filter: UUID
:param event_type_filter: An event type filter for the events.
:type event_type_filter: str
:param api_token_filter: An API filter for the events. Supply the name and preview of the API token.
:type api_token_filter: str
:param cursor: The pagination cursor value.
:type cursor: str
:param page_size: Number of results to return per page. Default is 200.
:type page_size: int
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._events_serialize(
start_date_filter=start_date_filter,
end_date_filter=end_date_filter,
actor_filter=actor_filter,
object_filter=object_filter,
event_type_filter=event_type_filter,
api_token_filter=api_token_filter,
cursor=cursor,
page_size=page_size,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "PaginatedEventList",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def events_with_http_info(
self,
start_date_filter: Annotated[Optional[StrictStr], Field(description="A start date filter for the events.")] = None,
end_date_filter: Annotated[Optional[StrictStr], Field(description="An end date filter for the events.")] = None,
actor_filter: Annotated[Optional[UUID], Field(description="An actor filter for the events. Supply the ID of the actor.")] = None,
object_filter: Annotated[Optional[UUID], Field(description="An object filter for the events. Supply the ID of the object.")] = None,
event_type_filter: Annotated[Optional[StrictStr], Field(description="An event type filter for the events.")] = None,
api_token_filter: Annotated[Optional[StrictStr], Field(description="An API filter for the events. Supply the name and preview of the API token.")] = None,
cursor: Annotated[Optional[StrictStr], Field(description="The pagination cursor value.")] = None,
page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True)]], Field(description="Number of results to return per page. Default is 200.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[PaginatedEventList]:
"""events
Returns a list of `Event` objects.
:param start_date_filter: A start date filter for the events.
:type start_date_filter: str
:param end_date_filter: An end date filter for the events.
:type end_date_filter: str
:param actor_filter: An actor filter for the events. Supply the ID of the actor.
:type actor_filter: UUID
:param object_filter: An object filter for the events. Supply the ID of the object.
:type object_filter: UUID
:param event_type_filter: An event type filter for the events.
:type event_type_filter: str
:param api_token_filter: An API filter for the events. Supply the name and preview of the API token.
:type api_token_filter: str
:param cursor: The pagination cursor value.
:type cursor: str
:param page_size: Number of results to return per page. Default is 200.
:type page_size: int
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._events_serialize(
start_date_filter=start_date_filter,
end_date_filter=end_date_filter,
actor_filter=actor_filter,
object_filter=object_filter,
event_type_filter=event_type_filter,
api_token_filter=api_token_filter,
cursor=cursor,
page_size=page_size,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "PaginatedEventList",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def events_without_preload_content(
self,
start_date_filter: Annotated[Optional[StrictStr], Field(description="A start date filter for the events.")] = None,
end_date_filter: Annotated[Optional[StrictStr], Field(description="An end date filter for the events.")] = None,
actor_filter: Annotated[Optional[UUID], Field(description="An actor filter for the events. Supply the ID of the actor.")] = None,
object_filter: Annotated[Optional[UUID], Field(description="An object filter for the events. Supply the ID of the object.")] = None,
event_type_filter: Annotated[Optional[StrictStr], Field(description="An event type filter for the events.")] = None,
api_token_filter: Annotated[Optional[StrictStr], Field(description="An API filter for the events. Supply the name and preview of the API token.")] = None,
cursor: Annotated[Optional[StrictStr], Field(description="The pagination cursor value.")] = None,
page_size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True)]], Field(description="Number of results to return per page. Default is 200.")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""events
Returns a list of `Event` objects.
:param start_date_filter: A start date filter for the events.
:type start_date_filter: str
:param end_date_filter: An end date filter for the events.
:type end_date_filter: str
:param actor_filter: An actor filter for the events. Supply the ID of the actor.
:type actor_filter: UUID
:param object_filter: An object filter for the events. Supply the ID of the object.
:type object_filter: UUID
:param event_type_filter: An event type filter for the events.
:type event_type_filter: str
:param api_token_filter: An API filter for the events. Supply the name and preview of the API token.
:type api_token_filter: str
:param cursor: The pagination cursor value.
:type cursor: str
:param page_size: Number of results to return per page. Default is 200.
:type page_size: int
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._events_serialize(
start_date_filter=start_date_filter,
end_date_filter=end_date_filter,
actor_filter=actor_filter,
object_filter=object_filter,
event_type_filter=event_type_filter,
api_token_filter=api_token_filter,
cursor=cursor,
page_size=page_size,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "PaginatedEventList",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _events_serialize(
self,
start_date_filter,
end_date_filter,
actor_filter,
object_filter,
event_type_filter,
api_token_filter,
cursor,
page_size,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if start_date_filter is not None:
_query_params.append(('start_date_filter', start_date_filter))
if end_date_filter is not None:
_query_params.append(('end_date_filter', end_date_filter))
if actor_filter is not None:
_query_params.append(('actor_filter', actor_filter))
if object_filter is not None:
_query_params.append(('object_filter', object_filter))
if event_type_filter is not None:
_query_params.append(('event_type_filter', event_type_filter))
if api_token_filter is not None:
_query_params.append(('api_token_filter', api_token_filter))
if cursor is not None:
_query_params.append(('cursor', cursor))
if page_size is not None:
_query_params.append(('page_size', page_size))
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'BearerAuth'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/events',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)