hiddenlayer-sdk 1.2.1__py3-none-any.whl → 2.0.1__py3-none-any.whl

hiddenlayer/sdk/rest/models/{detections.py → multi_file_upload_request_v3.py}

@@ -17,29 +17,20 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class Detections(BaseModel):
+class MultiFileUploadRequestV3(BaseModel):
     """
-    Detections
+    MultiFileUploadRequestV3
     """ # noqa: E501
-    description: Optional[StrictStr] = None
-    message: Optional[StrictStr] = None
-    severity: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["description", "message", "severity"]
-
-    @field_validator('severity')
-    def severity_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['MISS', 'SAFE', 'SUSPICIOUS', 'UNSAFE', 'MALICIOUS']):
-            raise ValueError("must be one of enum values ('MISS', 'SAFE', 'SUSPICIOUS', 'UNSAFE', 'MALICIOUS')")
-        return value
+    model_version: StrictStr = Field(description="Model version")
+    model_name: StrictStr = Field(description="Model name")
+    requesting_entity: StrictStr = Field(description="Requesting entity")
+    location_alias: Optional[StrictStr] = Field(default=None, description="Requested location alias")
+    __properties: ClassVar[List[str]] = ["model_version", "model_name", "requesting_entity", "location_alias"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -59,7 +50,7 @@ class Detections(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of Detections from a JSON string"""
+        """Create an instance of MultiFileUploadRequestV3 from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -84,7 +75,7 @@ class Detections(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of Detections from a dict"""
+        """Create an instance of MultiFileUploadRequestV3 from a dict"""
         if obj is None:
             return None
 
@@ -92,9 +83,10 @@ class Detections(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "description": obj.get("description"),
-            "message": obj.get("message"),
-            "severity": obj.get("severity")
+            "model_version": obj.get("model_version"),
+            "model_name": obj.get("model_name"),
+            "requesting_entity": obj.get("requesting_entity"),
+            "location_alias": obj.get("location_alias")
         })
         return _obj
 

hiddenlayer/sdk/rest/models/{model_scan_api_v3_scan_model_version_id_patch200_response.py → notify_model_scan_completed200_response.py}

@@ -22,9 +22,9 @@ from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
 
-class ModelScanApiV3ScanModelVersionIdPatch200Response(BaseModel):
+class NotifyModelScanCompleted200Response(BaseModel):
     """
-    ModelScanApiV3ScanModelVersionIdPatch200Response
+    NotifyModelScanCompleted200Response
     """ # noqa: E501
     message: StrictStr = Field(description="Request to resource is successful")
     __properties: ClassVar[List[str]] = ["message"]
@@ -47,7 +47,7 @@ class ModelScanApiV3ScanModelVersionIdPatch200Response(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of ModelScanApiV3ScanModelVersionIdPatch200Response from a JSON string"""
+        """Create an instance of NotifyModelScanCompleted200Response from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -72,7 +72,7 @@ class ModelScanApiV3ScanModelVersionIdPatch200Response(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ModelScanApiV3ScanModelVersionIdPatch200Response from a dict"""
+        """Create an instance of NotifyModelScanCompleted200Response from a dict"""
         if obj is None:
             return None
 

hiddenlayer/sdk/rest/models/pagination_v3.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PaginationV3(BaseModel):
+    """
+    PaginationV3
+    """ # noqa: E501
+    var_self: StrictStr = Field(alias="self")
+    first: StrictStr
+    prev: StrictStr
+    next: StrictStr
+    last: StrictStr
+    __properties: ClassVar[List[str]] = ["self", "first", "prev", "next", "last"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PaginationV3 from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaginationV3 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "self": obj.get("self"),
+            "first": obj.get("first"),
+            "prev": obj.get("prev"),
+            "next": obj.get("next"),
+            "last": obj.get("last")
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/problem_details.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from hiddenlayer.sdk.rest.models.errors_inner import ErrorsInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ProblemDetails(BaseModel):
+    """
+    ProblemDetails
+    """ # noqa: E501
+    type: Optional[StrictStr] = Field(default=None, description="https://www.rfc-editor.org/rfc/rfc9457.html#name-type")
+    title: Optional[StrictStr] = Field(default=None, description="https://www.rfc-editor.org/rfc/rfc9457.html#name-title")
+    detail: Optional[StrictStr] = Field(default=None, description="https://www.rfc-editor.org/rfc/rfc9457.html#name-detail")
+    instance: Optional[StrictStr] = Field(default=None, description="https://www.rfc-editor.org/rfc/rfc9457.html#name-instance")
+    errors: List[ErrorsInner] = Field(description="Error details")
+    __properties: ClassVar[List[str]] = ["type", "title", "detail", "instance", "errors"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ProblemDetails from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in errors (list)
+        _items = []
+        if self.errors:
+            for _item in self.errors:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['errors'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ProblemDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "type": obj.get("type"),
+            "title": obj.get("title"),
+            "detail": obj.get("detail"),
+            "instance": obj.get("instance"),
+            "errors": [ErrorsInner.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/scan_detection_v31.py

@@ -0,0 +1,155 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from hiddenlayer.sdk.rest.models.mitre_atlas_inner import MITREAtlasInner
+from hiddenlayer.sdk.rest.models.rule_details_inner import RuleDetailsInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScanDetectionV31(BaseModel):
+    """
+    ScanDetectionV31
+    """ # noqa: E501
+    detection_id: StrictStr = Field(description="unique identifier for the detection")
+    rule_id: StrictStr = Field(description="unique identifier for the rule that sourced the detection")
+    risk: StrictStr = Field(description="detection risk")
+    category: StrictStr = Field(description="Vulnerability category for the detection")
+    description: StrictStr = Field(description="detection description")
+    likelihood: StrictStr = Field(description="detection likelihood")
+    impact: StrictStr = Field(description="detection impact")
+    severity: StrictStr = Field(description="detection severity")
+    rule_details: Optional[List[RuleDetailsInner]] = None
+    mitre_atlas: List[MITREAtlasInner]
+    owasp: List[Annotated[str, Field(strict=True)]]
+    cve: List[Annotated[str, Field(strict=True)]]
+    cwe: Annotated[str, Field(strict=True)]
+    cwe_href: StrictStr = Field(description="CWE URL for the detection")
+    technical_blog_hrefs: Optional[List[StrictStr]] = Field(default=None, description="Hiddenlayer Technical Blog URLs for the detection")
+    technical_blog_href: Optional[StrictStr] = Field(default=None, description="Hiddenlayer Technical Blog URL for the detection")
+    __properties: ClassVar[List[str]] = ["detection_id", "rule_id", "risk", "category", "description", "likelihood", "impact", "severity", "rule_details", "mitre_atlas", "owasp", "cve", "cwe", "cwe_href", "technical_blog_hrefs", "technical_blog_href"]
+
+    @field_validator('risk')
+    def risk_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['MALICIOUS', 'SUSPICIOUS']):
+            raise ValueError("must be one of enum values ('MALICIOUS', 'SUSPICIOUS')")
+        return value
+
+    @field_validator('severity')
+    def severity_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['low', 'medium', 'high', 'critical']):
+            raise ValueError("must be one of enum values ('low', 'medium', 'high', 'critical')")
+        return value
+
+    @field_validator('cwe')
+    def cwe_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^CWE-\d{1,4}.*$|^$", value):
+            raise ValueError(r"must validate the regular expression /^CWE-\d{1,4}.*$|^$/")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ScanDetectionV31 from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in rule_details (list)
+        _items = []
+        if self.rule_details:
+            for _item in self.rule_details:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['rule_details'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in mitre_atlas (list)
+        _items = []
+        if self.mitre_atlas:
+            for _item in self.mitre_atlas:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['mitre_atlas'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScanDetectionV31 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "detection_id": obj.get("detection_id"),
+            "rule_id": obj.get("rule_id"),
+            "risk": obj.get("risk"),
+            "category": obj.get("category"),
+            "description": obj.get("description"),
+            "likelihood": obj.get("likelihood"),
+            "impact": obj.get("impact"),
+            "severity": obj.get("severity"),
+            "rule_details": [RuleDetailsInner.from_dict(_item) for _item in obj["rule_details"]] if obj.get("rule_details") is not None else None,
+            "mitre_atlas": [MITREAtlasInner.from_dict(_item) for _item in obj["mitre_atlas"]] if obj.get("mitre_atlas") is not None else None,
+            "owasp": obj.get("owasp"),
+            "cve": obj.get("cve"),
+            "cwe": obj.get("cwe"),
+            "cwe_href": obj.get("cwe_href"),
+            "technical_blog_hrefs": obj.get("technical_blog_hrefs"),
+            "technical_blog_href": obj.get("technical_blog_href")
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/scan_model_details_v3.py

@@ -28,7 +28,7 @@ class ScanModelDetailsV3(BaseModel):
     """ # noqa: E501
     model_name: StrictStr = Field(description="name of the model")
     model_version: StrictStr = Field(description="version of the model")
-    model_source: StrictStr = Field(description="source (provider) info")
+    model_source: Optional[StrictStr] = Field(default=None, description="source (provider) info")
     requested_scan_location: StrictStr = Field(description="Location to be scanned")
     requesting_entity: Optional[StrictStr] = Field(default=None, description="Entity that requested the scan")
     __properties: ClassVar[List[str]] = ["model_name", "model_version", "model_source", "requested_scan_location", "requesting_entity"]

hiddenlayer/sdk/rest/models/scan_results_map_v3.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan V2
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict
+from typing import Any, ClassVar, Dict, List
+from hiddenlayer.sdk.rest.models.pagination_v3 import PaginationV3
+from hiddenlayer.sdk.rest.models.scan_results_v3 import ScanResultsV3
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScanResultsMapV3(BaseModel):
+    """
+    ScanResultsMapV3
+    """ # noqa: E501
+    page: List[PaginationV3]
+    items: List[ScanResultsV3]
+    __properties: ClassVar[List[str]] = ["page", "items"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ScanResultsMapV3 from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in page (list)
+        _items = []
+        if self.page:
+            for _item in self.page:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['page'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in items (list)
+        _items = []
+        if self.items:
+            for _item in self.items:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScanResultsMapV3 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "page": [PaginationV3.from_dict(_item) for _item in obj["page"]] if obj.get("page") is not None else None,
+            "items": [ScanResultsV3.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None
+        })
+        return _obj
+
+