hiddenlayer-sdk 2.0.3__py3-none-any.whl → 2.0.5__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.
- hiddenlayer/sdk/rest/__init__.py +5 -2
- hiddenlayer/sdk/rest/api/__init__.py +1 -0
- hiddenlayer/sdk/rest/api/aidr_predictive_api.py +2 -2
- hiddenlayer/sdk/rest/api/health_api.py +2 -2
- hiddenlayer/sdk/rest/api/model_api.py +559 -0
- hiddenlayer/sdk/rest/api/model_supply_chain_api.py +2 -2
- hiddenlayer/sdk/rest/api/readiness_api.py +2 -2
- hiddenlayer/sdk/rest/api/sensor_api.py +257 -2
- hiddenlayer/sdk/rest/api_client.py +2 -2
- hiddenlayer/sdk/rest/configuration.py +2 -2
- hiddenlayer/sdk/rest/exceptions.py +2 -2
- hiddenlayer/sdk/rest/models/__init__.py +4 -2
- hiddenlayer/sdk/rest/models/address.py +2 -2
- hiddenlayer/sdk/rest/models/artifact.py +2 -2
- hiddenlayer/sdk/rest/models/artifact_change.py +2 -2
- hiddenlayer/sdk/rest/models/artifact_content.py +2 -2
- hiddenlayer/sdk/rest/models/artifact_location.py +2 -2
- hiddenlayer/sdk/rest/models/attachment.py +2 -2
- hiddenlayer/sdk/rest/models/begin_multi_file_upload200_response.py +2 -2
- hiddenlayer/sdk/rest/models/begin_multipart_file_upload200_response.py +2 -2
- hiddenlayer/sdk/rest/models/begin_multipart_file_upload200_response_parts_inner.py +2 -2
- hiddenlayer/sdk/rest/models/code_flow.py +2 -2
- hiddenlayer/sdk/rest/models/configuration_override.py +2 -2
- hiddenlayer/sdk/rest/models/conversion.py +2 -2
- hiddenlayer/sdk/rest/models/create_sensor_request.py +2 -2
- hiddenlayer/sdk/rest/models/edge.py +2 -2
- hiddenlayer/sdk/rest/models/edge_traversal.py +2 -2
- hiddenlayer/sdk/rest/models/errors_inner.py +2 -2
- hiddenlayer/sdk/rest/models/exception.py +2 -2
- hiddenlayer/sdk/rest/models/external_properties.py +2 -2
- hiddenlayer/sdk/rest/models/external_property_file_reference.py +2 -2
- hiddenlayer/sdk/rest/models/external_property_file_references.py +2 -2
- hiddenlayer/sdk/rest/models/file_details_v3.py +2 -2
- hiddenlayer/sdk/rest/models/file_result_v3.py +2 -2
- hiddenlayer/sdk/rest/models/file_scan_report_v3.py +2 -2
- hiddenlayer/sdk/rest/models/file_scan_reports_v3.py +2 -2
- hiddenlayer/sdk/rest/models/fix.py +2 -2
- hiddenlayer/sdk/rest/models/get_condensed_model_scan_reports200_response.py +2 -2
- hiddenlayer/sdk/rest/models/graph.py +2 -2
- hiddenlayer/sdk/rest/models/graph_traversal.py +2 -2
- hiddenlayer/sdk/rest/models/inventory_v3.py +2 -2
- hiddenlayer/sdk/rest/models/invocation.py +2 -2
- hiddenlayer/sdk/rest/models/location.py +2 -2
- hiddenlayer/sdk/rest/models/location_inner.py +2 -2
- hiddenlayer/sdk/rest/models/location_relationship.py +2 -2
- hiddenlayer/sdk/rest/models/logical_location.py +2 -2
- hiddenlayer/sdk/rest/models/message.py +2 -2
- hiddenlayer/sdk/rest/models/mitre_atlas_inner.py +2 -2
- hiddenlayer/sdk/rest/models/model.py +103 -0
- hiddenlayer/sdk/rest/models/model_inventory_info.py +2 -2
- hiddenlayer/sdk/rest/models/model_version.py +97 -0
- hiddenlayer/sdk/rest/models/multi_file_upload_request_v3.py +2 -2
- hiddenlayer/sdk/rest/models/multiformat_message_string.py +2 -2
- hiddenlayer/sdk/rest/models/node.py +2 -2
- hiddenlayer/sdk/rest/models/notification.py +2 -2
- hiddenlayer/sdk/rest/models/notify_model_scan_completed200_response.py +2 -2
- hiddenlayer/sdk/rest/models/paged_response_with_total.py +2 -2
- hiddenlayer/sdk/rest/models/pagination_v3.py +2 -2
- hiddenlayer/sdk/rest/models/physical_location.py +2 -2
- hiddenlayer/sdk/rest/models/problem_details.py +2 -2
- hiddenlayer/sdk/rest/models/property_bag.py +2 -2
- hiddenlayer/sdk/rest/models/rectangle.py +2 -2
- hiddenlayer/sdk/rest/models/region.py +2 -2
- hiddenlayer/sdk/rest/models/replacement.py +2 -2
- hiddenlayer/sdk/rest/models/reporting_configuration.py +2 -2
- hiddenlayer/sdk/rest/models/reporting_descriptor.py +2 -2
- hiddenlayer/sdk/rest/models/reporting_descriptor_reference.py +2 -2
- hiddenlayer/sdk/rest/models/reporting_descriptor_relationship.py +2 -2
- hiddenlayer/sdk/rest/models/result.py +2 -2
- hiddenlayer/sdk/rest/models/result_provenance.py +2 -2
- hiddenlayer/sdk/rest/models/rule_details_inner.py +2 -2
- hiddenlayer/sdk/rest/models/run.py +2 -2
- hiddenlayer/sdk/rest/models/run_automation_details.py +2 -2
- hiddenlayer/sdk/rest/models/sarif210.py +2 -2
- hiddenlayer/sdk/rest/models/scan_create_request.py +2 -2
- hiddenlayer/sdk/rest/models/scan_detection_v3.py +6 -3
- hiddenlayer/sdk/rest/models/scan_detection_v31.py +6 -3
- hiddenlayer/sdk/rest/models/scan_header_v3.py +2 -2
- hiddenlayer/sdk/rest/models/scan_job.py +2 -2
- hiddenlayer/sdk/rest/models/scan_job_inventory.py +2 -2
- hiddenlayer/sdk/rest/models/scan_model_details_v3.py +2 -2
- hiddenlayer/sdk/rest/models/scan_model_ids_v3.py +2 -2
- hiddenlayer/sdk/rest/models/scan_report_v3.py +2 -2
- hiddenlayer/sdk/rest/models/scan_results_map_v3.py +2 -2
- hiddenlayer/sdk/rest/models/scan_results_v3.py +2 -2
- hiddenlayer/sdk/rest/models/security_posture.py +2 -2
- hiddenlayer/sdk/rest/models/sensor.py +2 -2
- hiddenlayer/sdk/rest/models/sensor_query_response.py +2 -2
- hiddenlayer/sdk/rest/models/sensor_sor_model_card_query_response.py +2 -2
- hiddenlayer/sdk/rest/models/sensor_sor_model_card_response.py +2 -2
- hiddenlayer/sdk/rest/models/sensor_sor_query_filter.py +2 -2
- hiddenlayer/sdk/rest/models/sensor_sor_query_request.py +2 -2
- hiddenlayer/sdk/rest/models/special_locations.py +2 -2
- hiddenlayer/sdk/rest/models/stack.py +2 -2
- hiddenlayer/sdk/rest/models/stack_frame.py +2 -2
- hiddenlayer/sdk/rest/models/submission_response.py +2 -2
- hiddenlayer/sdk/rest/models/submission_v2.py +2 -2
- hiddenlayer/sdk/rest/models/suppression.py +2 -2
- hiddenlayer/sdk/rest/models/thread_flow.py +2 -2
- hiddenlayer/sdk/rest/models/thread_flow_location.py +2 -2
- hiddenlayer/sdk/rest/models/tool.py +2 -2
- hiddenlayer/sdk/rest/models/tool_component.py +2 -2
- hiddenlayer/sdk/rest/models/tool_component_reference.py +2 -2
- hiddenlayer/sdk/rest/models/translation_metadata.py +2 -2
- hiddenlayer/sdk/rest/models/validation_error_model.py +2 -2
- hiddenlayer/sdk/rest/models/version_control_details.py +2 -2
- hiddenlayer/sdk/rest/models/web_request.py +2 -2
- hiddenlayer/sdk/rest/models/web_response.py +2 -2
- hiddenlayer/sdk/rest/rest.py +2 -2
- hiddenlayer/sdk/version.py +1 -1
- {hiddenlayer_sdk-2.0.3.dist-info → hiddenlayer_sdk-2.0.5.dist-info}/METADATA +19 -1
- hiddenlayer_sdk-2.0.5.dist-info/RECORD +125 -0
- {hiddenlayer_sdk-2.0.3.dist-info → hiddenlayer_sdk-2.0.5.dist-info}/WHEEL +1 -1
- hiddenlayer_sdk-2.0.3.dist-info/RECORD +0 -122
- {hiddenlayer_sdk-2.0.3.dist-info → hiddenlayer_sdk-2.0.5.dist-info}/LICENSE +0 -0
- {hiddenlayer_sdk-2.0.3.dist-info → hiddenlayer_sdk-2.0.5.dist-info}/top_level.txt +0 -0
@@ -1,9 +1,9 @@
|
|
1
1
|
# coding: utf-8
|
2
2
|
|
3
3
|
"""
|
4
|
-
HiddenLayer
|
4
|
+
HiddenLayer-API
|
5
5
|
|
6
|
-
HiddenLayer
|
6
|
+
HiddenLayer-API
|
7
7
|
|
8
8
|
The version of the OpenAPI document: 1
|
9
9
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
@@ -30,7 +30,7 @@ class ScanDetectionV3(BaseModel):
|
|
30
30
|
ScanDetectionV3
|
31
31
|
""" # noqa: E501
|
32
32
|
description: StrictStr = Field(description="detection description")
|
33
|
-
risk: StrictStr = Field(description="detection risk")
|
33
|
+
risk: Optional[StrictStr] = Field(default=None, description="detection risk")
|
34
34
|
severity: StrictStr = Field(description="detection severity")
|
35
35
|
detection_id: StrictStr = Field(description="unique identifier for the detection")
|
36
36
|
impact: Optional[StrictStr] = Field(default=None, description="detection impact")
|
@@ -49,6 +49,9 @@ class ScanDetectionV3(BaseModel):
|
|
49
49
|
@field_validator('risk')
|
50
50
|
def risk_validate_enum(cls, value):
|
51
51
|
"""Validates the enum"""
|
52
|
+
if value is None:
|
53
|
+
return value
|
54
|
+
|
52
55
|
if value not in set(['MALICIOUS', 'SUSPICIOUS', 'BENIGN']):
|
53
56
|
raise ValueError("must be one of enum values ('MALICIOUS', 'SUSPICIOUS', 'BENIGN')")
|
54
57
|
return value
|
@@ -1,9 +1,9 @@
|
|
1
1
|
# coding: utf-8
|
2
2
|
|
3
3
|
"""
|
4
|
-
HiddenLayer
|
4
|
+
HiddenLayer-API
|
5
5
|
|
6
|
-
HiddenLayer
|
6
|
+
HiddenLayer-API
|
7
7
|
|
8
8
|
The version of the OpenAPI document: 1
|
9
9
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
@@ -31,7 +31,7 @@ class ScanDetectionV31(BaseModel):
|
|
31
31
|
""" # noqa: E501
|
32
32
|
detection_id: StrictStr = Field(description="unique identifier for the detection")
|
33
33
|
rule_id: StrictStr = Field(description="unique identifier for the rule that sourced the detection")
|
34
|
-
risk: StrictStr = Field(description="detection risk")
|
34
|
+
risk: Optional[StrictStr] = Field(default=None, description="detection risk")
|
35
35
|
category: StrictStr = Field(description="Vulnerability category for the detection")
|
36
36
|
description: StrictStr = Field(description="detection description")
|
37
37
|
likelihood: StrictStr = Field(description="detection likelihood")
|
@@ -50,6 +50,9 @@ class ScanDetectionV31(BaseModel):
|
|
50
50
|
@field_validator('risk')
|
51
51
|
def risk_validate_enum(cls, value):
|
52
52
|
"""Validates the enum"""
|
53
|
+
if value is None:
|
54
|
+
return value
|
55
|
+
|
53
56
|
if value not in set(['MALICIOUS', 'SUSPICIOUS']):
|
54
57
|
raise ValueError("must be one of enum values ('MALICIOUS', 'SUSPICIOUS')")
|
55
58
|
return value
|
hiddenlayer/sdk/rest/rest.py
CHANGED
hiddenlayer/sdk/version.py
CHANGED
@@ -1 +1 @@
|
|
1
|
-
VERSION = "2.0.
|
1
|
+
VERSION = "2.0.5"
|
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.2
|
2
2
|
Name: hiddenlayer-sdk
|
3
|
-
Version: 2.0.
|
3
|
+
Version: 2.0.5
|
4
4
|
Summary: Official HiddenLayer Python SDK
|
5
5
|
Author-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>
|
6
6
|
Maintainer-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>
|
@@ -287,6 +287,24 @@ hl_client = HiddenlayerServiceClient(
|
|
287
287
|
)
|
288
288
|
```
|
289
289
|
|
290
|
+
If you are using the EU region, you will need to set the `HL_AUTH_URL` environment variable to the following:
|
291
|
+
|
292
|
+
```bash
|
293
|
+
export HL_AUTH_URL=https://auth.eu.hiddenlayer.ai
|
294
|
+
```
|
295
|
+
|
296
|
+
Then you will instantiate the `HiddenlayerServiceClient` as follows:
|
297
|
+
|
298
|
+
```python
|
299
|
+
from hiddenlayer import HiddenlayerServiceClient
|
300
|
+
|
301
|
+
hl_client = HiddenlayerServiceClient(
|
302
|
+
host="https://api.eu.hiddenlayer.ai",
|
303
|
+
api_id=..., # Your Hiddenlayer API Client ID
|
304
|
+
api_key=... # Your Hiddenalyer API Secret Key
|
305
|
+
)
|
306
|
+
```
|
307
|
+
|
290
308
|
### Scanning Models
|
291
309
|
|
292
310
|
```python
|