scc-firewall-manager-sdk 1.15.287__py3-none-any.whl → 1.15.563__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.
Files changed (50) hide show
  1. scc_firewall_manager_sdk/__init__.py +9 -1
  2. scc_firewall_manager_sdk/api/__init__.py +2 -0
  3. scc_firewall_manager_sdk/api/ai_assistant_api.py +12 -12
  4. scc_firewall_manager_sdk/api/asa_access_groups_api.py +12 -12
  5. scc_firewall_manager_sdk/api/asa_access_rules_api.py +12 -12
  6. scc_firewall_manager_sdk/api/asa_interfaces_api.py +72 -72
  7. scc_firewall_manager_sdk/api/audit_logs_api.py +12 -12
  8. scc_firewall_manager_sdk/api/change_requests_api.py +12 -12
  9. scc_firewall_manager_sdk/api/changelogs_api.py +12 -12
  10. scc_firewall_manager_sdk/api/command_line_interface_api.py +24 -24
  11. scc_firewall_manager_sdk/api/connectors_api.py +12 -313
  12. scc_firewall_manager_sdk/api/device_health_aggregations_api.py +6 -6
  13. scc_firewall_manager_sdk/api/device_upgrades_api.py +15 -15
  14. scc_firewall_manager_sdk/api/events_api.py +358 -0
  15. scc_firewall_manager_sdk/api/interface_health_aggregations_api.py +6 -6
  16. scc_firewall_manager_sdk/api/inventory_api.py +48 -48
  17. scc_firewall_manager_sdk/api/licensing_api.py +626 -0
  18. scc_firewall_manager_sdk/api/msp_device_upgrades_api.py +53 -24
  19. scc_firewall_manager_sdk/api/msp_inventory_api.py +48 -48
  20. scc_firewall_manager_sdk/api/msp_tenant_management_api.py +41 -12
  21. scc_firewall_manager_sdk/api/msp_user_management_api.py +24 -24
  22. scc_firewall_manager_sdk/api/remote_access_monitoring_api.py +24 -24
  23. scc_firewall_manager_sdk/api/tenant_management_api.py +21 -18
  24. scc_firewall_manager_sdk/api/users_api.py +30 -30
  25. scc_firewall_manager_sdk/api_client.py +1 -1
  26. scc_firewall_manager_sdk/configuration.py +1 -1
  27. scc_firewall_manager_sdk/models/__init__.py +6 -0
  28. scc_firewall_manager_sdk/models/access_group.py +1 -1
  29. scc_firewall_manager_sdk/models/cdo_transaction.py +12 -12
  30. scc_firewall_manager_sdk/models/common_api_error.py +3 -3
  31. scc_firewall_manager_sdk/models/completion_status_dto.py +104 -0
  32. scc_firewall_manager_sdk/models/device_license_dto.py +133 -0
  33. scc_firewall_manager_sdk/models/device_license_page.py +102 -0
  34. scc_firewall_manager_sdk/models/device_upgrade_status_dto.py +13 -7
  35. scc_firewall_manager_sdk/models/enable_cd_fmc_for_tenant_request.py +88 -0
  36. scc_firewall_manager_sdk/models/log_settings.py +1 -1
  37. scc_firewall_manager_sdk/models/msp_calculate_compatible_upgrade_versions_input.py +1 -1
  38. scc_firewall_manager_sdk/models/msp_managed_device.py +7 -1
  39. scc_firewall_manager_sdk/models/msp_managed_device_distinct_attribute_values.py +5 -1
  40. scc_firewall_manager_sdk/models/msp_upgrade_ftd_devices_input.py +97 -0
  41. scc_firewall_manager_sdk/models/msp_upgrade_run_dto.py +9 -9
  42. scc_firewall_manager_sdk/models/msp_upgrade_runs_attribute_values.py +18 -3
  43. scc_firewall_manager_sdk/models/smart_account.py +90 -0
  44. scc_firewall_manager_sdk/models/tenant_settings.py +3 -1
  45. scc_firewall_manager_sdk/models/upgrade_run_dto.py +1 -1
  46. scc_firewall_manager_sdk/models/upgrade_run_metadata_dto.py +1 -1
  47. {scc_firewall_manager_sdk-1.15.287.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/METADATA +1 -1
  48. {scc_firewall_manager_sdk-1.15.287.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/RECORD +50 -42
  49. {scc_firewall_manager_sdk-1.15.287.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/WHEEL +0 -0
  50. {scc_firewall_manager_sdk-1.15.287.dist-info → scc_firewall_manager_sdk-1.15.563.dist-info}/top_level.txt +0 -0
@@ -48,7 +48,7 @@ class DeviceHealthAggregationsApi:
48
48
  threshold: Annotated[StrictStr, Field(description="The metric threshold (e.g. CRITICAL).")],
49
49
  aggregation_period: Annotated[Optional[StrictStr], Field(description="The aggregation period of the metrics returned.")] = None,
50
50
  managed_tenant_uid: Annotated[Optional[StrictStr], Field(description="A managed tenant UUID to filter list, if applicable.")] = None,
51
- q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.")] = None,
51
+ q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.")] = None,
52
52
  _request_timeout: Union[
53
53
  None,
54
54
  Annotated[StrictFloat, Field(gt=0)],
@@ -74,7 +74,7 @@ class DeviceHealthAggregationsApi:
74
74
  :type aggregation_period: str
75
75
  :param managed_tenant_uid: A managed tenant UUID to filter list, if applicable.
76
76
  :type managed_tenant_uid: str
77
- :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.
77
+ :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.
78
78
  :type q: str
79
79
  :param _request_timeout: timeout setting for this request. If one
80
80
  number provided, it will be total request
@@ -136,7 +136,7 @@ class DeviceHealthAggregationsApi:
136
136
  threshold: Annotated[StrictStr, Field(description="The metric threshold (e.g. CRITICAL).")],
137
137
  aggregation_period: Annotated[Optional[StrictStr], Field(description="The aggregation period of the metrics returned.")] = None,
138
138
  managed_tenant_uid: Annotated[Optional[StrictStr], Field(description="A managed tenant UUID to filter list, if applicable.")] = None,
139
- q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.")] = None,
139
+ q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.")] = None,
140
140
  _request_timeout: Union[
141
141
  None,
142
142
  Annotated[StrictFloat, Field(gt=0)],
@@ -162,7 +162,7 @@ class DeviceHealthAggregationsApi:
162
162
  :type aggregation_period: str
163
163
  :param managed_tenant_uid: A managed tenant UUID to filter list, if applicable.
164
164
  :type managed_tenant_uid: str
165
- :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.
165
+ :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.
166
166
  :type q: str
167
167
  :param _request_timeout: timeout setting for this request. If one
168
168
  number provided, it will be total request
@@ -224,7 +224,7 @@ class DeviceHealthAggregationsApi:
224
224
  threshold: Annotated[StrictStr, Field(description="The metric threshold (e.g. CRITICAL).")],
225
225
  aggregation_period: Annotated[Optional[StrictStr], Field(description="The aggregation period of the metrics returned.")] = None,
226
226
  managed_tenant_uid: Annotated[Optional[StrictStr], Field(description="A managed tenant UUID to filter list, if applicable.")] = None,
227
- q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.")] = None,
227
+ q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.")] = None,
228
228
  _request_timeout: Union[
229
229
  None,
230
230
  Annotated[StrictFloat, Field(gt=0)],
@@ -250,7 +250,7 @@ class DeviceHealthAggregationsApi:
250
250
  :type aggregation_period: str
251
251
  :param managed_tenant_uid: A managed tenant UUID to filter list, if applicable.
252
252
  :type managed_tenant_uid: str
253
- :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.
253
+ :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.
254
254
  :type q: str
255
255
  :param _request_timeout: timeout setting for this request. If one
256
256
  number provided, it will be total request
@@ -1444,8 +1444,8 @@ class DeviceUpgradesApi:
1444
1444
  @validate_call
1445
1445
  def get_device_upgrade_runs(
1446
1446
  self,
1447
- limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
1448
- 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,
1447
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
1448
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
1449
1449
  q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
1450
1450
  sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
1451
1451
  _request_timeout: Union[
@@ -1463,11 +1463,11 @@ class DeviceUpgradesApi:
1463
1463
  ) -> FtdUpgradeRunDtoPage:
1464
1464
  """Get Device Upgrade Runs
1465
1465
 
1466
- Get a list of FTD device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
1466
+ Get a list of device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
1467
1467
 
1468
- :param limit: The number of results to retrieve.
1468
+ :param limit: Number of results to retrieve.
1469
1469
  :type limit: str
1470
- :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.
1470
+ :param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
1471
1471
  :type offset: str
1472
1472
  :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
1473
1473
  :type q: str
@@ -1527,8 +1527,8 @@ class DeviceUpgradesApi:
1527
1527
  @validate_call
1528
1528
  def get_device_upgrade_runs_with_http_info(
1529
1529
  self,
1530
- limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
1531
- 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,
1530
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
1531
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
1532
1532
  q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
1533
1533
  sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
1534
1534
  _request_timeout: Union[
@@ -1546,11 +1546,11 @@ class DeviceUpgradesApi:
1546
1546
  ) -> ApiResponse[FtdUpgradeRunDtoPage]:
1547
1547
  """Get Device Upgrade Runs
1548
1548
 
1549
- Get a list of FTD device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
1549
+ Get a list of device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
1550
1550
 
1551
- :param limit: The number of results to retrieve.
1551
+ :param limit: Number of results to retrieve.
1552
1552
  :type limit: str
1553
- :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.
1553
+ :param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
1554
1554
  :type offset: str
1555
1555
  :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
1556
1556
  :type q: str
@@ -1610,8 +1610,8 @@ class DeviceUpgradesApi:
1610
1610
  @validate_call
1611
1611
  def get_device_upgrade_runs_without_preload_content(
1612
1612
  self,
1613
- limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="The number of results to retrieve.")] = None,
1614
- 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,
1613
+ limit: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Number of results to retrieve.")] = None,
1614
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.")] = None,
1615
1615
  q: Annotated[Optional[StrictStr], Field(description="The query to execute. Use the Lucene Query Syntax to construct your query.")] = None,
1616
1616
  sort: Annotated[Optional[List[StrictStr]], Field(description="The fields to sort results by.")] = None,
1617
1617
  _request_timeout: Union[
@@ -1629,11 +1629,11 @@ class DeviceUpgradesApi:
1629
1629
  ) -> RESTResponseType:
1630
1630
  """Get Device Upgrade Runs
1631
1631
 
1632
- Get a list of FTD device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
1632
+ Get a list of device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.
1633
1633
 
1634
- :param limit: The number of results to retrieve.
1634
+ :param limit: Number of results to retrieve.
1635
1635
  :type limit: str
1636
- :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.
1636
+ :param offset: Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.
1637
1637
  :type offset: str
1638
1638
  :param q: The query to execute. Use the Lucene Query Syntax to construct your query.
1639
1639
  :type q: str
@@ -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="Number of results to retrieve.")] = None,
47
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use 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: Number of results to retrieve.
68
+ :type limit: str
69
+ :param offset: Offset of the results retrieved. The Security Cloud Control APIs use 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="Number of results to retrieve.")] = None,
128
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use 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: Number of results to retrieve.
149
+ :type limit: str
150
+ :param offset: Offset of the results retrieved. The Security Cloud Control APIs use 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="Number of results to retrieve.")] = None,
209
+ offset: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Offset of the results retrieved. The Security Cloud Control APIs use 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: Number of results to retrieve.
230
+ :type limit: str
231
+ :param offset: Offset of the results retrieved. The Security Cloud Control APIs use 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
+
@@ -49,7 +49,7 @@ class InterfaceHealthAggregationsApi:
49
49
  threshold: Annotated[StrictStr, Field(description="The metric threshold (e.g. CRITICAL).")],
50
50
  aggregation_period: Annotated[Optional[StrictStr], Field(description="The aggregation period of the metrics returned.")] = None,
51
51
  managed_tenant_uid: Annotated[Optional[StrictStr], Field(description="A managed tenant UUID to filter list, if applicable.")] = None,
52
- q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.")] = None,
52
+ q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.")] = None,
53
53
  _request_timeout: Union[
54
54
  None,
55
55
  Annotated[StrictFloat, Field(gt=0)],
@@ -75,7 +75,7 @@ class InterfaceHealthAggregationsApi:
75
75
  :type aggregation_period: str
76
76
  :param managed_tenant_uid: A managed tenant UUID to filter list, if applicable.
77
77
  :type managed_tenant_uid: str
78
- :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.
78
+ :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.
79
79
  :type q: str
80
80
  :param _request_timeout: timeout setting for this request. If one
81
81
  number provided, it will be total request
@@ -137,7 +137,7 @@ class InterfaceHealthAggregationsApi:
137
137
  threshold: Annotated[StrictStr, Field(description="The metric threshold (e.g. CRITICAL).")],
138
138
  aggregation_period: Annotated[Optional[StrictStr], Field(description="The aggregation period of the metrics returned.")] = None,
139
139
  managed_tenant_uid: Annotated[Optional[StrictStr], Field(description="A managed tenant UUID to filter list, if applicable.")] = None,
140
- q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.")] = None,
140
+ q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.")] = None,
141
141
  _request_timeout: Union[
142
142
  None,
143
143
  Annotated[StrictFloat, Field(gt=0)],
@@ -163,7 +163,7 @@ class InterfaceHealthAggregationsApi:
163
163
  :type aggregation_period: str
164
164
  :param managed_tenant_uid: A managed tenant UUID to filter list, if applicable.
165
165
  :type managed_tenant_uid: str
166
- :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.
166
+ :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.
167
167
  :type q: str
168
168
  :param _request_timeout: timeout setting for this request. If one
169
169
  number provided, it will be total request
@@ -225,7 +225,7 @@ class InterfaceHealthAggregationsApi:
225
225
  threshold: Annotated[StrictStr, Field(description="The metric threshold (e.g. CRITICAL).")],
226
226
  aggregation_period: Annotated[Optional[StrictStr], Field(description="The aggregation period of the metrics returned.")] = None,
227
227
  managed_tenant_uid: Annotated[Optional[StrictStr], Field(description="A managed tenant UUID to filter list, if applicable.")] = None,
228
- q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.")] = None,
228
+ q: Annotated[Optional[StrictStr], Field(description="Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.")] = None,
229
229
  _request_timeout: Union[
230
230
  None,
231
231
  Annotated[StrictFloat, Field(gt=0)],
@@ -251,7 +251,7 @@ class InterfaceHealthAggregationsApi:
251
251
  :type aggregation_period: str
252
252
  :param managed_tenant_uid: A managed tenant UUID to filter list, if applicable.
253
253
  :type managed_tenant_uid: str
254
- :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) are supported for filtering.
254
+ :param q: Lucene-style query filter. Only prefix queries (e.g. field:value*) and wildcard queries (e.g. field:*value or field:*value*) are supported for filtering.
255
255
  :type q: str
256
256
  :param _request_timeout: timeout setting for this request. If one
257
257
  number provided, it will be total request