scc-firewall-manager-sdk 1.15.293__py3-none-any.whl → 1.15.295__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of scc-firewall-manager-sdk might be problematic. Click here for more details.

@@ -15,7 +15,7 @@
15
15
  """ # noqa: E501
16
16
 
17
17
 
18
- __version__ = "1.15.293"
18
+ __version__ = "1.15.295"
19
19
 
20
20
  # import apis into sdk package
21
21
  from scc_firewall_manager_sdk.api.ai_assistant_api import AIAssistantApi
@@ -31,6 +31,7 @@ from scc_firewall_manager_sdk.api.connectors_api import ConnectorsApi
31
31
  from scc_firewall_manager_sdk.api.device_health_api import DeviceHealthApi
32
32
  from scc_firewall_manager_sdk.api.device_health_aggregations_api import DeviceHealthAggregationsApi
33
33
  from scc_firewall_manager_sdk.api.device_upgrades_api import DeviceUpgradesApi
34
+ from scc_firewall_manager_sdk.api.events_api import EventsApi
34
35
  from scc_firewall_manager_sdk.api.interface_health_aggregations_api import InterfaceHealthAggregationsApi
35
36
  from scc_firewall_manager_sdk.api.inventory_api import InventoryApi
36
37
  from scc_firewall_manager_sdk.api.msp_device_upgrades_api import MSPDeviceUpgradesApi
@@ -14,6 +14,7 @@ from scc_firewall_manager_sdk.api.connectors_api import ConnectorsApi
14
14
  from scc_firewall_manager_sdk.api.device_health_api import DeviceHealthApi
15
15
  from scc_firewall_manager_sdk.api.device_health_aggregations_api import DeviceHealthAggregationsApi
16
16
  from scc_firewall_manager_sdk.api.device_upgrades_api import DeviceUpgradesApi
17
+ from scc_firewall_manager_sdk.api.events_api import EventsApi
17
18
  from scc_firewall_manager_sdk.api.interface_health_aggregations_api import InterfaceHealthAggregationsApi
18
19
  from scc_firewall_manager_sdk.api.inventory_api import InventoryApi
19
20
  from scc_firewall_manager_sdk.api.msp_device_upgrades_api import MSPDeviceUpgradesApi
@@ -21,7 +21,6 @@ from pydantic import Field, StrictStr
21
21
  from typing import List, Optional
22
22
  from typing_extensions import Annotated
23
23
  from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
24
- from scc_firewall_manager_sdk.models.page import Page
25
24
  from scc_firewall_manager_sdk.models.sdc import Sdc
26
25
  from scc_firewall_manager_sdk.models.sdc_create_input import SdcCreateInput
27
26
  from scc_firewall_manager_sdk.models.sdc_page import SdcPage
@@ -1195,306 +1194,6 @@ class ConnectorsApi:
1195
1194
 
1196
1195
 
1197
1196
 
1198
- @validate_call
1199
- def get_search_reports(
1200
- self,
1201
- limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
1202
- offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
1203
- q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
1204
- _request_timeout: Union[
1205
- None,
1206
- Annotated[StrictFloat, Field(gt=0)],
1207
- Tuple[
1208
- Annotated[StrictFloat, Field(gt=0)],
1209
- Annotated[StrictFloat, Field(gt=0)]
1210
- ]
1211
- ] = None,
1212
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1213
- _content_type: Optional[StrictStr] = None,
1214
- _headers: Optional[Dict[StrictStr, Any]] = None,
1215
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1216
- ) -> Page:
1217
- """Get event search reports
1218
-
1219
- Get a list of reports containing the results of event log searches executed using the Report feature in the Event Logging page.
1220
-
1221
- :param limit: The number of results to retrieve.
1222
- :type limit: str
1223
- :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
1224
- :type offset: str
1225
- :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
1226
- :type q: str
1227
- :param _request_timeout: timeout setting for this request. If one
1228
- number provided, it will be total request
1229
- timeout. It can also be a pair (tuple) of
1230
- (connection, read) timeouts.
1231
- :type _request_timeout: int, tuple(int, int), optional
1232
- :param _request_auth: set to override the auth_settings for an a single
1233
- request; this effectively ignores the
1234
- authentication in the spec for a single request.
1235
- :type _request_auth: dict, optional
1236
- :param _content_type: force content-type for the request.
1237
- :type _content_type: str, Optional
1238
- :param _headers: set to override the headers for a single
1239
- request; this effectively ignores the headers
1240
- in the spec for a single request.
1241
- :type _headers: dict, optional
1242
- :param _host_index: set to override the host_index for a single
1243
- request; this effectively ignores the host_index
1244
- in the spec for a single request.
1245
- :type _host_index: int, optional
1246
- :return: Returns the result object.
1247
- """ # noqa: E501
1248
-
1249
- _param = self._get_search_reports_serialize(
1250
- limit=limit,
1251
- offset=offset,
1252
- q=q,
1253
- _request_auth=_request_auth,
1254
- _content_type=_content_type,
1255
- _headers=_headers,
1256
- _host_index=_host_index
1257
- )
1258
-
1259
- _response_types_map: Dict[str, Optional[str]] = {
1260
- '200': "Page",
1261
- '401': "AuthenticationError",
1262
- '500': "CommonApiError",
1263
- }
1264
- response_data = self.api_client.call_api(
1265
- *_param,
1266
- _request_timeout=_request_timeout
1267
- )
1268
- response_data.read()
1269
- return self.api_client.response_deserialize(
1270
- response_data=response_data,
1271
- response_types_map=_response_types_map,
1272
- ).data
1273
-
1274
-
1275
- @validate_call
1276
- def get_search_reports_with_http_info(
1277
- self,
1278
- limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
1279
- offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
1280
- q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
1281
- _request_timeout: Union[
1282
- None,
1283
- Annotated[StrictFloat, Field(gt=0)],
1284
- Tuple[
1285
- Annotated[StrictFloat, Field(gt=0)],
1286
- Annotated[StrictFloat, Field(gt=0)]
1287
- ]
1288
- ] = None,
1289
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1290
- _content_type: Optional[StrictStr] = None,
1291
- _headers: Optional[Dict[StrictStr, Any]] = None,
1292
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1293
- ) -> ApiResponse[Page]:
1294
- """Get event search reports
1295
-
1296
- Get a list of reports containing the results of event log searches executed using the Report feature in the Event Logging page.
1297
-
1298
- :param limit: The number of results to retrieve.
1299
- :type limit: str
1300
- :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
1301
- :type offset: str
1302
- :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
1303
- :type q: str
1304
- :param _request_timeout: timeout setting for this request. If one
1305
- number provided, it will be total request
1306
- timeout. It can also be a pair (tuple) of
1307
- (connection, read) timeouts.
1308
- :type _request_timeout: int, tuple(int, int), optional
1309
- :param _request_auth: set to override the auth_settings for an a single
1310
- request; this effectively ignores the
1311
- authentication in the spec for a single request.
1312
- :type _request_auth: dict, optional
1313
- :param _content_type: force content-type for the request.
1314
- :type _content_type: str, Optional
1315
- :param _headers: set to override the headers for a single
1316
- request; this effectively ignores the headers
1317
- in the spec for a single request.
1318
- :type _headers: dict, optional
1319
- :param _host_index: set to override the host_index for a single
1320
- request; this effectively ignores the host_index
1321
- in the spec for a single request.
1322
- :type _host_index: int, optional
1323
- :return: Returns the result object.
1324
- """ # noqa: E501
1325
-
1326
- _param = self._get_search_reports_serialize(
1327
- limit=limit,
1328
- offset=offset,
1329
- q=q,
1330
- _request_auth=_request_auth,
1331
- _content_type=_content_type,
1332
- _headers=_headers,
1333
- _host_index=_host_index
1334
- )
1335
-
1336
- _response_types_map: Dict[str, Optional[str]] = {
1337
- '200': "Page",
1338
- '401': "AuthenticationError",
1339
- '500': "CommonApiError",
1340
- }
1341
- response_data = self.api_client.call_api(
1342
- *_param,
1343
- _request_timeout=_request_timeout
1344
- )
1345
- response_data.read()
1346
- return self.api_client.response_deserialize(
1347
- response_data=response_data,
1348
- response_types_map=_response_types_map,
1349
- )
1350
-
1351
-
1352
- @validate_call
1353
- def get_search_reports_without_preload_content(
1354
- self,
1355
- limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
1356
- offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
1357
- q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
1358
- _request_timeout: Union[
1359
- None,
1360
- Annotated[StrictFloat, Field(gt=0)],
1361
- Tuple[
1362
- Annotated[StrictFloat, Field(gt=0)],
1363
- Annotated[StrictFloat, Field(gt=0)]
1364
- ]
1365
- ] = None,
1366
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1367
- _content_type: Optional[StrictStr] = None,
1368
- _headers: Optional[Dict[StrictStr, Any]] = None,
1369
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1370
- ) -> RESTResponseType:
1371
- """Get event search reports
1372
-
1373
- Get a list of reports containing the results of event log searches executed using the Report feature in the Event Logging page.
1374
-
1375
- :param limit: The number of results to retrieve.
1376
- :type limit: str
1377
- :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
1378
- :type offset: str
1379
- :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
1380
- :type q: str
1381
- :param _request_timeout: timeout setting for this request. If one
1382
- number provided, it will be total request
1383
- timeout. It can also be a pair (tuple) of
1384
- (connection, read) timeouts.
1385
- :type _request_timeout: int, tuple(int, int), optional
1386
- :param _request_auth: set to override the auth_settings for an a single
1387
- request; this effectively ignores the
1388
- authentication in the spec for a single request.
1389
- :type _request_auth: dict, optional
1390
- :param _content_type: force content-type for the request.
1391
- :type _content_type: str, Optional
1392
- :param _headers: set to override the headers for a single
1393
- request; this effectively ignores the headers
1394
- in the spec for a single request.
1395
- :type _headers: dict, optional
1396
- :param _host_index: set to override the host_index for a single
1397
- request; this effectively ignores the host_index
1398
- in the spec for a single request.
1399
- :type _host_index: int, optional
1400
- :return: Returns the result object.
1401
- """ # noqa: E501
1402
-
1403
- _param = self._get_search_reports_serialize(
1404
- limit=limit,
1405
- offset=offset,
1406
- q=q,
1407
- _request_auth=_request_auth,
1408
- _content_type=_content_type,
1409
- _headers=_headers,
1410
- _host_index=_host_index
1411
- )
1412
-
1413
- _response_types_map: Dict[str, Optional[str]] = {
1414
- '200': "Page",
1415
- '401': "AuthenticationError",
1416
- '500': "CommonApiError",
1417
- }
1418
- response_data = self.api_client.call_api(
1419
- *_param,
1420
- _request_timeout=_request_timeout
1421
- )
1422
- return response_data.response
1423
-
1424
-
1425
- def _get_search_reports_serialize(
1426
- self,
1427
- limit,
1428
- offset,
1429
- q,
1430
- _request_auth,
1431
- _content_type,
1432
- _headers,
1433
- _host_index,
1434
- ) -> RequestSerialized:
1435
-
1436
- _host = None
1437
-
1438
- _collection_formats: Dict[str, str] = {
1439
- }
1440
-
1441
- _path_params: Dict[str, str] = {}
1442
- _query_params: List[Tuple[str, str]] = []
1443
- _header_params: Dict[str, Optional[str]] = _headers or {}
1444
- _form_params: List[Tuple[str, str]] = []
1445
- _files: Dict[str, str] = {}
1446
- _body_params: Optional[bytes] = None
1447
-
1448
- # process the path parameters
1449
- # process the query parameters
1450
- if limit is not None:
1451
-
1452
- _query_params.append(('limit', limit))
1453
-
1454
- if offset is not None:
1455
-
1456
- _query_params.append(('offset', offset))
1457
-
1458
- if q is not None:
1459
-
1460
- _query_params.append(('q', q))
1461
-
1462
- # process the header parameters
1463
- # process the form parameters
1464
- # process the body parameter
1465
-
1466
-
1467
- # set the HTTP header `Accept`
1468
- _header_params['Accept'] = self.api_client.select_header_accept(
1469
- [
1470
- 'application/json'
1471
- ]
1472
- )
1473
-
1474
-
1475
- # authentication setting
1476
- _auth_settings: List[str] = [
1477
- 'bearerAuth'
1478
- ]
1479
-
1480
- return self.api_client.param_serialize(
1481
- method='GET',
1482
- resource_path='/v1/events/reports',
1483
- path_params=_path_params,
1484
- query_params=_query_params,
1485
- header_params=_header_params,
1486
- body=_body_params,
1487
- post_params=_form_params,
1488
- files=_files,
1489
- auth_settings=_auth_settings,
1490
- collection_formats=_collection_formats,
1491
- _host=_host,
1492
- _request_auth=_request_auth
1493
- )
1494
-
1495
-
1496
-
1497
-
1498
1197
  @validate_call
1499
1198
  def modify_sdc(
1500
1199
  self,
@@ -0,0 +1,358 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Cisco Security Cloud Control Firewall Manager API
5
+
6
+ Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer
7
+
8
+ The version of the OpenAPI document: 1.15.0
9
+ Contact: cdo.tac@cisco.com
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+ import warnings
16
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
17
+ from typing import Any, Dict, List, Optional, Tuple, Union
18
+ from typing_extensions import Annotated
19
+
20
+ from pydantic import Field, StrictStr
21
+ from typing import List, Optional
22
+ from typing_extensions import Annotated
23
+ from scc_firewall_manager_sdk.models.page import Page
24
+
25
+ from scc_firewall_manager_sdk.api_client import ApiClient, RequestSerialized
26
+ from scc_firewall_manager_sdk.api_response import ApiResponse
27
+ from scc_firewall_manager_sdk.rest import RESTResponseType
28
+
29
+
30
+ class EventsApi:
31
+ """NOTE: This class is auto generated by OpenAPI Generator
32
+ Ref: https://openapi-generator.tech
33
+
34
+ Do not edit the class manually.
35
+ """
36
+
37
+ def __init__(self, api_client=None) -> None:
38
+ if api_client is None:
39
+ api_client = ApiClient.get_default()
40
+ self.api_client = api_client
41
+
42
+
43
+ @validate_call
44
+ def get_search_reports(
45
+ self,
46
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
47
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
48
+ q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
49
+ sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
50
+ _request_timeout: Union[
51
+ None,
52
+ Annotated[StrictFloat, Field(gt=0)],
53
+ Tuple[
54
+ Annotated[StrictFloat, Field(gt=0)],
55
+ Annotated[StrictFloat, Field(gt=0)]
56
+ ]
57
+ ] = None,
58
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
59
+ _content_type: Optional[StrictStr] = None,
60
+ _headers: Optional[Dict[StrictStr, Any]] = None,
61
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
62
+ ) -> Page:
63
+ """Get event search reports
64
+
65
+ Get a list of reports containing the results of event log searches executed using the Report feature in the Event Logging page.
66
+
67
+ :param limit: The number of results to retrieve.
68
+ :type limit: str
69
+ :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
70
+ :type offset: str
71
+ :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
72
+ :type q: str
73
+ :param sort: The fields to sort results by.
74
+ :type sort: List[str]
75
+ :param _request_timeout: timeout setting for this request. If one
76
+ number provided, it will be total request
77
+ timeout. It can also be a pair (tuple) of
78
+ (connection, read) timeouts.
79
+ :type _request_timeout: int, tuple(int, int), optional
80
+ :param _request_auth: set to override the auth_settings for an a single
81
+ request; this effectively ignores the
82
+ authentication in the spec for a single request.
83
+ :type _request_auth: dict, optional
84
+ :param _content_type: force content-type for the request.
85
+ :type _content_type: str, Optional
86
+ :param _headers: set to override the headers for a single
87
+ request; this effectively ignores the headers
88
+ in the spec for a single request.
89
+ :type _headers: dict, optional
90
+ :param _host_index: set to override the host_index for a single
91
+ request; this effectively ignores the host_index
92
+ in the spec for a single request.
93
+ :type _host_index: int, optional
94
+ :return: Returns the result object.
95
+ """ # noqa: E501
96
+
97
+ _param = self._get_search_reports_serialize(
98
+ limit=limit,
99
+ offset=offset,
100
+ q=q,
101
+ sort=sort,
102
+ _request_auth=_request_auth,
103
+ _content_type=_content_type,
104
+ _headers=_headers,
105
+ _host_index=_host_index
106
+ )
107
+
108
+ _response_types_map: Dict[str, Optional[str]] = {
109
+ '200': "Page",
110
+ '401': "AuthenticationError",
111
+ '500': "CommonApiError",
112
+ }
113
+ response_data = self.api_client.call_api(
114
+ *_param,
115
+ _request_timeout=_request_timeout
116
+ )
117
+ response_data.read()
118
+ return self.api_client.response_deserialize(
119
+ response_data=response_data,
120
+ response_types_map=_response_types_map,
121
+ ).data
122
+
123
+
124
+ @validate_call
125
+ def get_search_reports_with_http_info(
126
+ self,
127
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
128
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
129
+ q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
130
+ sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
131
+ _request_timeout: Union[
132
+ None,
133
+ Annotated[StrictFloat, Field(gt=0)],
134
+ Tuple[
135
+ Annotated[StrictFloat, Field(gt=0)],
136
+ Annotated[StrictFloat, Field(gt=0)]
137
+ ]
138
+ ] = None,
139
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
140
+ _content_type: Optional[StrictStr] = None,
141
+ _headers: Optional[Dict[StrictStr, Any]] = None,
142
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
143
+ ) -> ApiResponse[Page]:
144
+ """Get event search reports
145
+
146
+ Get a list of reports containing the results of event log searches executed using the Report feature in the Event Logging page.
147
+
148
+ :param limit: The number of results to retrieve.
149
+ :type limit: str
150
+ :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
151
+ :type offset: str
152
+ :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
153
+ :type q: str
154
+ :param sort: The fields to sort results by.
155
+ :type sort: List[str]
156
+ :param _request_timeout: timeout setting for this request. If one
157
+ number provided, it will be total request
158
+ timeout. It can also be a pair (tuple) of
159
+ (connection, read) timeouts.
160
+ :type _request_timeout: int, tuple(int, int), optional
161
+ :param _request_auth: set to override the auth_settings for an a single
162
+ request; this effectively ignores the
163
+ authentication in the spec for a single request.
164
+ :type _request_auth: dict, optional
165
+ :param _content_type: force content-type for the request.
166
+ :type _content_type: str, Optional
167
+ :param _headers: set to override the headers for a single
168
+ request; this effectively ignores the headers
169
+ in the spec for a single request.
170
+ :type _headers: dict, optional
171
+ :param _host_index: set to override the host_index for a single
172
+ request; this effectively ignores the host_index
173
+ in the spec for a single request.
174
+ :type _host_index: int, optional
175
+ :return: Returns the result object.
176
+ """ # noqa: E501
177
+
178
+ _param = self._get_search_reports_serialize(
179
+ limit=limit,
180
+ offset=offset,
181
+ q=q,
182
+ sort=sort,
183
+ _request_auth=_request_auth,
184
+ _content_type=_content_type,
185
+ _headers=_headers,
186
+ _host_index=_host_index
187
+ )
188
+
189
+ _response_types_map: Dict[str, Optional[str]] = {
190
+ '200': "Page",
191
+ '401': "AuthenticationError",
192
+ '500': "CommonApiError",
193
+ }
194
+ response_data = self.api_client.call_api(
195
+ *_param,
196
+ _request_timeout=_request_timeout
197
+ )
198
+ response_data.read()
199
+ return self.api_client.response_deserialize(
200
+ response_data=response_data,
201
+ response_types_map=_response_types_map,
202
+ )
203
+
204
+
205
+ @validate_call
206
+ def get_search_reports_without_preload_content(
207
+ self,
208
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
209
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
210
+ q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
211
+ sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
212
+ _request_timeout: Union[
213
+ None,
214
+ Annotated[StrictFloat, Field(gt=0)],
215
+ Tuple[
216
+ Annotated[StrictFloat, Field(gt=0)],
217
+ Annotated[StrictFloat, Field(gt=0)]
218
+ ]
219
+ ] = None,
220
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
221
+ _content_type: Optional[StrictStr] = None,
222
+ _headers: Optional[Dict[StrictStr, Any]] = None,
223
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
224
+ ) -> RESTResponseType:
225
+ """Get event search reports
226
+
227
+ Get a list of reports containing the results of event log searches executed using the Report feature in the Event Logging page.
228
+
229
+ :param limit: The number of results to retrieve.
230
+ :type limit: str
231
+ :param offset: The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
232
+ :type offset: str
233
+ :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
234
+ :type q: str
235
+ :param sort: The fields to sort results by.
236
+ :type sort: List[str]
237
+ :param _request_timeout: timeout setting for this request. If one
238
+ number provided, it will be total request
239
+ timeout. It can also be a pair (tuple) of
240
+ (connection, read) timeouts.
241
+ :type _request_timeout: int, tuple(int, int), optional
242
+ :param _request_auth: set to override the auth_settings for an a single
243
+ request; this effectively ignores the
244
+ authentication in the spec for a single request.
245
+ :type _request_auth: dict, optional
246
+ :param _content_type: force content-type for the request.
247
+ :type _content_type: str, Optional
248
+ :param _headers: set to override the headers for a single
249
+ request; this effectively ignores the headers
250
+ in the spec for a single request.
251
+ :type _headers: dict, optional
252
+ :param _host_index: set to override the host_index for a single
253
+ request; this effectively ignores the host_index
254
+ in the spec for a single request.
255
+ :type _host_index: int, optional
256
+ :return: Returns the result object.
257
+ """ # noqa: E501
258
+
259
+ _param = self._get_search_reports_serialize(
260
+ limit=limit,
261
+ offset=offset,
262
+ q=q,
263
+ sort=sort,
264
+ _request_auth=_request_auth,
265
+ _content_type=_content_type,
266
+ _headers=_headers,
267
+ _host_index=_host_index
268
+ )
269
+
270
+ _response_types_map: Dict[str, Optional[str]] = {
271
+ '200': "Page",
272
+ '401': "AuthenticationError",
273
+ '500': "CommonApiError",
274
+ }
275
+ response_data = self.api_client.call_api(
276
+ *_param,
277
+ _request_timeout=_request_timeout
278
+ )
279
+ return response_data.response
280
+
281
+
282
+ def _get_search_reports_serialize(
283
+ self,
284
+ limit,
285
+ offset,
286
+ q,
287
+ sort,
288
+ _request_auth,
289
+ _content_type,
290
+ _headers,
291
+ _host_index,
292
+ ) -> RequestSerialized:
293
+
294
+ _host = None
295
+
296
+ _collection_formats: Dict[str, str] = {
297
+ 'sort': 'multi',
298
+ }
299
+
300
+ _path_params: Dict[str, str] = {}
301
+ _query_params: List[Tuple[str, str]] = []
302
+ _header_params: Dict[str, Optional[str]] = _headers or {}
303
+ _form_params: List[Tuple[str, str]] = []
304
+ _files: Dict[str, str] = {}
305
+ _body_params: Optional[bytes] = None
306
+
307
+ # process the path parameters
308
+ # process the query parameters
309
+ if limit is not None:
310
+
311
+ _query_params.append(('limit', limit))
312
+
313
+ if offset is not None:
314
+
315
+ _query_params.append(('offset', offset))
316
+
317
+ if q is not None:
318
+
319
+ _query_params.append(('q', q))
320
+
321
+ if sort is not None:
322
+
323
+ _query_params.append(('sort', sort))
324
+
325
+ # process the header parameters
326
+ # process the form parameters
327
+ # process the body parameter
328
+
329
+
330
+ # set the HTTP header `Accept`
331
+ _header_params['Accept'] = self.api_client.select_header_accept(
332
+ [
333
+ 'application/json'
334
+ ]
335
+ )
336
+
337
+
338
+ # authentication setting
339
+ _auth_settings: List[str] = [
340
+ 'bearerAuth'
341
+ ]
342
+
343
+ return self.api_client.param_serialize(
344
+ method='GET',
345
+ resource_path='/v1/events/reports',
346
+ path_params=_path_params,
347
+ query_params=_query_params,
348
+ header_params=_header_params,
349
+ body=_body_params,
350
+ post_params=_form_params,
351
+ files=_files,
352
+ auth_settings=_auth_settings,
353
+ collection_formats=_collection_formats,
354
+ _host=_host,
355
+ _request_auth=_request_auth
356
+ )
357
+
358
+
@@ -88,7 +88,7 @@ class ApiClient:
88
88
  self.default_headers[header_name] = header_value
89
89
  self.cookie = cookie
90
90
  # Set default User-Agent.
91
- self.user_agent = 'OpenAPI-Generator/1.15.293/python'
91
+ self.user_agent = 'OpenAPI-Generator/1.15.295/python'
92
92
  self.client_side_validation = configuration.client_side_validation
93
93
 
94
94
  def __enter__(self):
@@ -380,7 +380,7 @@ class Configuration:
380
380
  "OS: {env}\n"\
381
381
  "Python Version: {pyversion}\n"\
382
382
  "Version of the API: 1.15.0\n"\
383
- "SDK Package Version: 1.15.293".\
383
+ "SDK Package Version: 1.15.295".\
384
384
  format(env=sys.platform, pyversion=sys.version)
385
385
 
386
386
  def get_host_settings(self):
@@ -18,7 +18,7 @@ import pprint
18
18
  import re # noqa: F401
19
19
  import json
20
20
 
21
- from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
22
22
  from typing import Any, ClassVar, Dict, List, Optional, Union
23
23
  from typing import Optional, Set
24
24
  from typing_extensions import Self
@@ -27,10 +27,28 @@ class DeviceUpgradeStatusDto(BaseModel):
27
27
  """
28
28
  DeviceUpgradeStatusDto
29
29
  """ # noqa: E501
30
+ hardware_model: Optional[StrictStr] = Field(default=None, description="The hardware model of the devices being upgraded.", alias="hardwareModel")
31
+ managed_tenant_display_name: Optional[StrictStr] = Field(default=None, description="The display name of the managed tenant in CDO.", alias="managedTenantDisplayName")
32
+ managed_tenant_name: Optional[StrictStr] = Field(default=None, description="The name of the managed tenant in CDO.", alias="managedTenantName")
33
+ managed_tenant_uid: Optional[StrictStr] = Field(default=None, description="The unique identifier, represented as a UUID, of the managed tenant in Security Cloud Control that this device belongs to.", alias="managedTenantUid")
30
34
  message: Optional[StrictStr] = Field(default=None, description="A message, indicating current progress, returned from the device.")
35
+ name: Optional[StrictStr] = Field(default=None, description="The name of the device being upgraded.")
31
36
  percentage_complete: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The percentage completion of the current task being performed", alias="percentageComplete")
32
- uid: Optional[StrictStr] = Field(default=None, description="The unique identifier, represented as a UUID, of the device in SCC Firewall Manager.")
33
- __properties: ClassVar[List[str]] = ["message", "percentageComplete", "uid"]
37
+ software_version_before_upgrade: Optional[StrictStr] = Field(default=None, description="The software version of the device before the upgrade.", alias="softwareVersionBeforeUpgrade")
38
+ transaction_uid: Optional[StrictStr] = Field(default=None, description="The unique identifier, represented as a UUID, of the CDO transaction on the managed tenant that tracks this upgrade run.", alias="transactionUid")
39
+ uid: Optional[StrictStr] = Field(default=None, description="The unique identifier, represented as a UUID, of the device being upgraded.")
40
+ upgrade_run_status: Optional[StrictStr] = Field(default=None, description="The current status of the upgrade run.", alias="upgradeRunStatus")
41
+ __properties: ClassVar[List[str]] = ["hardwareModel", "managedTenantDisplayName", "managedTenantName", "managedTenantUid", "message", "name", "percentageComplete", "softwareVersionBeforeUpgrade", "transactionUid", "uid", "upgradeRunStatus"]
42
+
43
+ @field_validator('upgrade_run_status')
44
+ def upgrade_run_status_validate_enum(cls, value):
45
+ """Validates the enum"""
46
+ if value is None:
47
+ return value
48
+
49
+ if value not in set(['IN_PROGRESS', 'REBUILDING_UPGRADE_CACHE', 'PERFORMING_UPGRADE', 'UPLOADING_IMAGE', 'PERFORMING_READINESS_CHECK', 'UPGRADE_STAGED', 'UPGRADE_STAGING_FAILED', 'UGPRADE_STAGING_FAILED', 'UPGRADE_COMPLETED', 'UPGRADE_FAILED']):
50
+ raise ValueError("must be one of enum values ('IN_PROGRESS', 'REBUILDING_UPGRADE_CACHE', 'PERFORMING_UPGRADE', 'UPLOADING_IMAGE', 'PERFORMING_READINESS_CHECK', 'UPGRADE_STAGED', 'UPGRADE_STAGING_FAILED', 'UGPRADE_STAGING_FAILED', 'UPGRADE_COMPLETED', 'UPGRADE_FAILED')")
51
+ return value
34
52
 
35
53
  model_config = ConfigDict(
36
54
  populate_by_name=True,
@@ -83,9 +101,17 @@ class DeviceUpgradeStatusDto(BaseModel):
83
101
  return cls.model_validate(obj)
84
102
 
85
103
  _obj = cls.model_validate({
104
+ "hardwareModel": obj.get("hardwareModel"),
105
+ "managedTenantDisplayName": obj.get("managedTenantDisplayName"),
106
+ "managedTenantName": obj.get("managedTenantName"),
107
+ "managedTenantUid": obj.get("managedTenantUid"),
86
108
  "message": obj.get("message"),
109
+ "name": obj.get("name"),
87
110
  "percentageComplete": obj.get("percentageComplete"),
88
- "uid": obj.get("uid")
111
+ "softwareVersionBeforeUpgrade": obj.get("softwareVersionBeforeUpgrade"),
112
+ "transactionUid": obj.get("transactionUid"),
113
+ "uid": obj.get("uid"),
114
+ "upgradeRunStatus": obj.get("upgradeRunStatus")
89
115
  })
90
116
  return _obj
91
117
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: scc-firewall-manager-sdk
3
- Version: 1.15.293
3
+ Version: 1.15.295
4
4
  Summary: Cisco Security Cloud Control Firewall Manager API
5
5
  Home-page:
6
6
  Author: Cisco Security Cloud Control TAC
@@ -1,11 +1,11 @@
1
- scc_firewall_manager_sdk/__init__.py,sha256=Ac9D6Wmr4CuhwhPB9fW1kMfLJxad6hGvlbgEP_MTQf8,23529
2
- scc_firewall_manager_sdk/api_client.py,sha256=-wttHbEDPj_A8cAab7UoHertACQZ_Tc68Z4tsxN_d1o,25921
1
+ scc_firewall_manager_sdk/__init__.py,sha256=MPHpry71ZllSNWdTkBk2e0LUCKDChfCU6hK4rraxels,23591
2
+ scc_firewall_manager_sdk/api_client.py,sha256=uDtJUdjRZ4M5Z5idZdXrlZ6fZVCr8hMKf6p3KHMjOVQ,25921
3
3
  scc_firewall_manager_sdk/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
4
- scc_firewall_manager_sdk/configuration.py,sha256=CoPSeYieiGyfkzg65aVaLuq3uftWHVnAyYQwr603XAI,15993
4
+ scc_firewall_manager_sdk/configuration.py,sha256=TORrkw0gayiNSlhVLwvMQFazLQuhS_U5ABF8yODSkU4,15993
5
5
  scc_firewall_manager_sdk/exceptions.py,sha256=u5-7l5MRjP-aS2pNudBzqSw9OI4xVsIvUjw4WCA8LEk,6039
6
6
  scc_firewall_manager_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
7
  scc_firewall_manager_sdk/rest.py,sha256=cSeilvAB5y-V_10IdXcZ0kOyv5dYW8jeWVhrD6kUDa0,9309
8
- scc_firewall_manager_sdk/api/__init__.py,sha256=FXWtBN6lVNacqLSZFbx7giGlzWcAxyvpJAfEQQp7y_Y,2087
8
+ scc_firewall_manager_sdk/api/__init__.py,sha256=4QyrZUVjEAjIDVynI9stPsUyDC8aFw3czPVjv0lRKdM,2149
9
9
  scc_firewall_manager_sdk/api/ai_assistant_api.py,sha256=k4PXtChJD_MzAc5cn_EYtC1Q4YCCknDPTYhLlh4tFhA,60316
10
10
  scc_firewall_manager_sdk/api/asa_access_groups_api.py,sha256=n29L7dlwRpP8MsBlgMn9pSwV-uCXf5QHf18qiEXU4xY,60430
11
11
  scc_firewall_manager_sdk/api/asa_access_rules_api.py,sha256=zStpYuIiNHyTaIINPqu5qSSWp3-wGo9SmXodwEJEJhI,60377
@@ -15,10 +15,11 @@ scc_firewall_manager_sdk/api/change_requests_api.py,sha256=zCdwKO8E5Jv_4cHGp8PT3
15
15
  scc_firewall_manager_sdk/api/changelogs_api.py,sha256=6C4ugk1SwLgJfCM-q-_H2gnNoWB7jYqhUhpIDSUbY-4,30875
16
16
  scc_firewall_manager_sdk/api/command_line_interface_api.py,sha256=_sUPKdTkBkXNbk5m9iGH1t-eYJbFdzDLjLAuNMWJqYc,110872
17
17
  scc_firewall_manager_sdk/api/commands_api.py,sha256=U1cDPCmUAgOPnCOC8KcbcQpLGSwgOBBgHUcKH6JmWK4,33891
18
- scc_firewall_manager_sdk/api/connectors_api.py,sha256=2Qy39kPWn3OtI3DGBVfQvnXkV0ewdp_wOHHL0JkDUrc,73268
18
+ scc_firewall_manager_sdk/api/connectors_api.py,sha256=lw4asxJMtyHTm3sxM6Z7S1O2tbr4ZtbjVrZIalmYagI,59889
19
19
  scc_firewall_manager_sdk/api/device_health_aggregations_api.py,sha256=r4YyX6_HDWriUOh9dRFmjNzY08rozUatGOjpFzhkyJ4,29025
20
20
  scc_firewall_manager_sdk/api/device_health_api.py,sha256=UoxgUo10Am1kga8U0Kxhb6DDw6d7wpXxzGopsvUJ1JI,62283
21
21
  scc_firewall_manager_sdk/api/device_upgrades_api.py,sha256=nEtjWfCJ9eDVONZ0TLUApEcanm82CwcXTuax7kUVZxs,138514
22
+ scc_firewall_manager_sdk/api/events_api.py,sha256=jYkPjWxnNwNYOk1P7kMBaSp2gpe_lI8WodaxIfUKdQM,15399
22
23
  scc_firewall_manager_sdk/api/interface_health_aggregations_api.py,sha256=2fxsrkfFpI2zSx3WnviJnP0uuS2XBT8YE_sZ0FcXjk0,40990
23
24
  scc_firewall_manager_sdk/api/inventory_api.py,sha256=EJqDZzqBE4w_klxuo84rSYmrmbinGSJEbSbU6Wqs4Gg,444995
24
25
  scc_firewall_manager_sdk/api/meta_api.py,sha256=0T4mIpkOc0FyDIvEN5qhRQbKN4CzOM00_sRVY2oG59U,29963
@@ -118,7 +119,7 @@ scc_firewall_manager_sdk/models/device_metadata.py,sha256=PNCBkG35enpJhcwqiku4NH
118
119
  scc_firewall_manager_sdk/models/device_page.py,sha256=ha32rLEnC9v8JpDff_07t_rtFLa-pAJFelG7czmFl8g,3684
119
120
  scc_firewall_manager_sdk/models/device_patch_input.py,sha256=1LOG---DhQRxRYP0qA8PzzopCUX5c0bbLu7ptIySYXo,4224
120
121
  scc_firewall_manager_sdk/models/device_role.py,sha256=cqv0xYyNhsvAOoDRUpdeSwkbEE9u89hEf8gA66cAteQ,1038
121
- scc_firewall_manager_sdk/models/device_upgrade_status_dto.py,sha256=APBrvjPIxnDTUDPSsQBttDpwyTjqC77b0opzJ32A6ZY,3216
122
+ scc_firewall_manager_sdk/models/device_upgrade_status_dto.py,sha256=VyuohadpQIWv6aII44-ncHx8HXN4bdTWn9YfobH6S0c,5986
122
123
  scc_firewall_manager_sdk/models/devices_patch_input.py,sha256=lSH-tNHYdS0CjWsHcSsnzQ9kL5ZxIsaVoHMxp5_Z8n4,3836
123
124
  scc_firewall_manager_sdk/models/disk_health_metrics.py,sha256=QU7XHLFoitOo4_ijLYromfp0stM8c7tx1T20uocXGXs,2947
124
125
  scc_firewall_manager_sdk/models/domain_settings.py,sha256=QqPTLHlNLd-PDoVqviIrU0IIPXhqLdTqTokV6uVQ8ug,3852
@@ -282,7 +283,7 @@ scc_firewall_manager_sdk/models/vlan_interface_create_input.py,sha256=AKUqPJw5ku
282
283
  scc_firewall_manager_sdk/models/vlan_interface_patch_input.py,sha256=srEFTyQykscNrWsbp8KGEzbmHC07_AU3DXjJ-7Be4zc,6054
283
284
  scc_firewall_manager_sdk/models/ztp_onboarding_input.py,sha256=HAgBTdocZeHGDZP_-9NyRtzP9E7BReGtiOmn4S3J-_g,5326
284
285
  scc_firewall_manager_sdk/models/ztp_onboarding_template_configuration.py,sha256=f9Z62yGFvz4QAQ07Z4bjfHLw2bRg46ccwoLuQ8q30TE,4808
285
- scc_firewall_manager_sdk-1.15.293.dist-info/METADATA,sha256=QwyZd4pidkDGmbXarAjYrilxTW5LVCOuQ01xlNatjzM,596
286
- scc_firewall_manager_sdk-1.15.293.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
287
- scc_firewall_manager_sdk-1.15.293.dist-info/top_level.txt,sha256=_g9WfFWGagKs6ULdfhEt8e7RXknpcp9_jA9ubIL4U3I,25
288
- scc_firewall_manager_sdk-1.15.293.dist-info/RECORD,,
286
+ scc_firewall_manager_sdk-1.15.295.dist-info/METADATA,sha256=-JDaUGRQjdTGtTtfSrvzNG3aX2RjFxa5YKLtCUNYn5w,596
287
+ scc_firewall_manager_sdk-1.15.295.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
288
+ scc_firewall_manager_sdk-1.15.295.dist-info/top_level.txt,sha256=_g9WfFWGagKs6ULdfhEt8e7RXknpcp9_jA9ubIL4U3I,25
289
+ scc_firewall_manager_sdk-1.15.295.dist-info/RECORD,,