hiddenlayer-sdk 0.1.2__py3-none-any.whl → 1.1.0__py3-none-any.whl

hiddenlayer/sdk/rest/models/__init__.py

@@ -2,7 +2,7 @@
 
 # flake8: noqa
 """
-    HiddenLayer ModelScan
+    HiddenLayer ModelScan V2
 
     HiddenLayer ModelScan API for scanning of models
 
@@ -14,17 +14,91 @@
 
 
 # import models into model package
+from hiddenlayer.sdk.rest.models.address import Address
+from hiddenlayer.sdk.rest.models.artifact import Artifact
+from hiddenlayer.sdk.rest.models.artifact_change import ArtifactChange
+from hiddenlayer.sdk.rest.models.artifact_content import ArtifactContent
+from hiddenlayer.sdk.rest.models.artifact_location import ArtifactLocation
+from hiddenlayer.sdk.rest.models.attachment import Attachment
+from hiddenlayer.sdk.rest.models.code_flow import CodeFlow
+from hiddenlayer.sdk.rest.models.configuration_override import ConfigurationOverride
+from hiddenlayer.sdk.rest.models.conversion import Conversion
 from hiddenlayer.sdk.rest.models.create_sensor_request import CreateSensorRequest
-from hiddenlayer.sdk.rest.models.file_info import FileInfo
+from hiddenlayer.sdk.rest.models.detections import Detections
+from hiddenlayer.sdk.rest.models.edge import Edge
+from hiddenlayer.sdk.rest.models.edge_traversal import EdgeTraversal
+from hiddenlayer.sdk.rest.models.exception import Exception
+from hiddenlayer.sdk.rest.models.external_properties import ExternalProperties
+from hiddenlayer.sdk.rest.models.external_property_file_reference import ExternalPropertyFileReference
+from hiddenlayer.sdk.rest.models.external_property_file_references import ExternalPropertyFileReferences
+from hiddenlayer.sdk.rest.models.file_details_v3 import FileDetailsV3
+from hiddenlayer.sdk.rest.models.file_scan_report_v3 import FileScanReportV3
+from hiddenlayer.sdk.rest.models.file_scan_reports_v3 import FileScanReportsV3
+from hiddenlayer.sdk.rest.models.fix import Fix
 from hiddenlayer.sdk.rest.models.get_multipart_upload_response import GetMultipartUploadResponse
+from hiddenlayer.sdk.rest.models.graph import Graph
+from hiddenlayer.sdk.rest.models.graph_traversal import GraphTraversal
+from hiddenlayer.sdk.rest.models.invocation import Invocation
+from hiddenlayer.sdk.rest.models.location import Location
+from hiddenlayer.sdk.rest.models.location_inner import LocationInner
+from hiddenlayer.sdk.rest.models.location_relationship import LocationRelationship
+from hiddenlayer.sdk.rest.models.logical_location import LogicalLocation
+from hiddenlayer.sdk.rest.models.mitre_atlas_inner import MITREAtlasInner
+from hiddenlayer.sdk.rest.models.message import Message
 from hiddenlayer.sdk.rest.models.model import Model
+from hiddenlayer.sdk.rest.models.model_inventory_info import ModelInventoryInfo
 from hiddenlayer.sdk.rest.models.model_query_response import ModelQueryResponse
+from hiddenlayer.sdk.rest.models.model_scan_api_v3_scan_model_version_id_patch200_response import ModelScanApiV3ScanModelVersionIdPatch200Response
+from hiddenlayer.sdk.rest.models.model_scan_api_v3_scan_query200_response import ModelScanApiV3ScanQuery200Response
+from hiddenlayer.sdk.rest.models.multiformat_message_string import MultiformatMessageString
 from hiddenlayer.sdk.rest.models.multipart_upload_part import MultipartUploadPart
+from hiddenlayer.sdk.rest.models.node import Node
+from hiddenlayer.sdk.rest.models.notification import Notification
+from hiddenlayer.sdk.rest.models.paged_response_with_total import PagedResponseWithTotal
+from hiddenlayer.sdk.rest.models.physical_location import PhysicalLocation
+from hiddenlayer.sdk.rest.models.property_bag import PropertyBag
+from hiddenlayer.sdk.rest.models.rectangle import Rectangle
+from hiddenlayer.sdk.rest.models.region import Region
+from hiddenlayer.sdk.rest.models.replacement import Replacement
+from hiddenlayer.sdk.rest.models.reporting_configuration import ReportingConfiguration
+from hiddenlayer.sdk.rest.models.reporting_descriptor import ReportingDescriptor
+from hiddenlayer.sdk.rest.models.reporting_descriptor_reference import ReportingDescriptorReference
+from hiddenlayer.sdk.rest.models.reporting_descriptor_relationship import ReportingDescriptorRelationship
+from hiddenlayer.sdk.rest.models.result import Result
+from hiddenlayer.sdk.rest.models.result_provenance import ResultProvenance
+from hiddenlayer.sdk.rest.models.rule_details_inner import RuleDetailsInner
+from hiddenlayer.sdk.rest.models.run import Run
+from hiddenlayer.sdk.rest.models.run_automation_details import RunAutomationDetails
+from hiddenlayer.sdk.rest.models.sarif210 import Sarif210
+from hiddenlayer.sdk.rest.models.scan_create_request import ScanCreateRequest
+from hiddenlayer.sdk.rest.models.scan_detection_v3 import ScanDetectionV3
+from hiddenlayer.sdk.rest.models.scan_header_v3 import ScanHeaderV3
+from hiddenlayer.sdk.rest.models.scan_job import ScanJob
+from hiddenlayer.sdk.rest.models.scan_job_inventory import ScanJobInventory
+from hiddenlayer.sdk.rest.models.scan_model_details_v3 import ScanModelDetailsV3
+from hiddenlayer.sdk.rest.models.scan_model_ids_v3 import ScanModelIdsV3
 from hiddenlayer.sdk.rest.models.scan_model_request import ScanModelRequest
+from hiddenlayer.sdk.rest.models.scan_report_v3 import ScanReportV3
+from hiddenlayer.sdk.rest.models.scan_results import ScanResults
 from hiddenlayer.sdk.rest.models.scan_results_v2 import ScanResultsV2
+from hiddenlayer.sdk.rest.models.security_posture import SecurityPosture
+from hiddenlayer.sdk.rest.models.sensor_sor_model_card_query_response import SensorSORModelCardQueryResponse
+from hiddenlayer.sdk.rest.models.sensor_sor_model_card_response import SensorSORModelCardResponse
 from hiddenlayer.sdk.rest.models.sensor_sor_query_filter import SensorSORQueryFilter
 from hiddenlayer.sdk.rest.models.sensor_sor_query_request import SensorSORQueryRequest
+from hiddenlayer.sdk.rest.models.special_locations import SpecialLocations
+from hiddenlayer.sdk.rest.models.stack import Stack
+from hiddenlayer.sdk.rest.models.stack_frame import StackFrame
 from hiddenlayer.sdk.rest.models.submission_response import SubmissionResponse
 from hiddenlayer.sdk.rest.models.submission_v2 import SubmissionV2
+from hiddenlayer.sdk.rest.models.suppression import Suppression
+from hiddenlayer.sdk.rest.models.thread_flow import ThreadFlow
+from hiddenlayer.sdk.rest.models.thread_flow_location import ThreadFlowLocation
+from hiddenlayer.sdk.rest.models.tool import Tool
+from hiddenlayer.sdk.rest.models.tool_component import ToolComponent
+from hiddenlayer.sdk.rest.models.tool_component_reference import ToolComponentReference
+from hiddenlayer.sdk.rest.models.translation_metadata import TranslationMetadata
 from hiddenlayer.sdk.rest.models.validation_error_model import ValidationErrorModel
-from hiddenlayer.sdk.rest.models.validation_error_model_loc_inner import ValidationErrorModelLocInner
+from hiddenlayer.sdk.rest.models.version_control_details import VersionControlDetails
+from hiddenlayer.sdk.rest.models.web_request import WebRequest
+from hiddenlayer.sdk.rest.models.web_response import WebResponse

hiddenlayer/sdk/rest/models/address.py

@@ -0,0 +1,110 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from hiddenlayer.sdk.rest.models.property_bag import PropertyBag
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Address(BaseModel):
+    """
+    A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).
+    """ # noqa: E501
+    absolute_address: Optional[Annotated[int, Field(strict=True, ge=-1)]] = Field(default=-1, description="The address expressed as a byte offset from the start of the addressable region.", alias="absoluteAddress")
+    relative_address: Optional[StrictInt] = Field(default=None, description="The address expressed as a byte offset from the absolute address of the top-most parent object.", alias="relativeAddress")
+    length: Optional[StrictInt] = Field(default=None, description="The number of bytes in this range of addresses.")
+    kind: Optional[StrictStr] = Field(default=None, description="An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.")
+    name: Optional[StrictStr] = Field(default=None, description="A name that is associated with the address, e.g., '.text'.")
+    fully_qualified_name: Optional[StrictStr] = Field(default=None, description="A human-readable fully qualified name that is associated with the address.", alias="fullyQualifiedName")
+    offset_from_parent: Optional[StrictInt] = Field(default=None, description="The byte offset of this address from the absolute or relative address of the parent object.", alias="offsetFromParent")
+    index: Optional[Annotated[int, Field(strict=True, ge=-1)]] = Field(default=-1, description="The index within run.addresses of the cached object for this address.")
+    parent_index: Optional[Annotated[int, Field(strict=True, ge=-1)]] = Field(default=-1, description="The index within run.addresses of the parent object.", alias="parentIndex")
+    properties: Optional[PropertyBag] = None
+    __properties: ClassVar[List[str]] = ["absoluteAddress", "relativeAddress", "length", "kind", "name", "fullyQualifiedName", "offsetFromParent", "index", "parentIndex", "properties"]
+
+    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 Address 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 properties
+        if self.properties:
+            _dict['properties'] = self.properties.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Address from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "absoluteAddress": obj.get("absoluteAddress") if obj.get("absoluteAddress") is not None else -1,
+            "relativeAddress": obj.get("relativeAddress"),
+            "length": obj.get("length"),
+            "kind": obj.get("kind"),
+            "name": obj.get("name"),
+            "fullyQualifiedName": obj.get("fullyQualifiedName"),
+            "offsetFromParent": obj.get("offsetFromParent"),
+            "index": obj.get("index") if obj.get("index") is not None else -1,
+            "parentIndex": obj.get("parentIndex") if obj.get("parentIndex") is not None else -1,
+            "properties": PropertyBag.from_dict(obj["properties"]) if obj.get("properties") is not None else None
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/artifact.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 datetime import datetime
+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.artifact_content import ArtifactContent
+from hiddenlayer.sdk.rest.models.artifact_location import ArtifactLocation
+from hiddenlayer.sdk.rest.models.message import Message
+from hiddenlayer.sdk.rest.models.property_bag import PropertyBag
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Artifact(BaseModel):
+    """
+    A single artifact. In some cases, this artifact might be nested within another artifact.
+    """ # noqa: E501
+    description: Optional[Message] = None
+    location: Optional[ArtifactLocation] = None
+    parent_index: Optional[Annotated[int, Field(strict=True, ge=-1)]] = Field(default=-1, description="Identifies the index of the immediate parent of the artifact, if this artifact is nested.", alias="parentIndex")
+    offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The offset in bytes of the artifact within its containing artifact.")
+    length: Optional[Annotated[int, Field(strict=True, ge=-1)]] = Field(default=-1, description="The length of the artifact in bytes.")
+    roles: Optional[Annotated[List[StrictStr], Field(min_length=0)]] = Field(default=None, description="The role or roles played by the artifact in the analysis.")
+    mime_type: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The MIME type (RFC 2045) of the artifact.", alias="mimeType")
+    contents: Optional[ArtifactContent] = None
+    encoding: Optional[StrictStr] = Field(default=None, description="Specifies the encoding for an artifact object that refers to a text file.")
+    source_language: Optional[StrictStr] = Field(default=None, description="Specifies the source language for any artifact object that refers to a text file that contains source code.", alias="sourceLanguage")
+    hashes: Optional[Dict[str, StrictStr]] = Field(default=None, description="A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.")
+    last_modified_time_utc: Optional[datetime] = Field(default=None, description="The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See \"Date/time properties\" in the SARIF spec for the required format.", alias="lastModifiedTimeUtc")
+    properties: Optional[PropertyBag] = None
+    __properties: ClassVar[List[str]] = ["description", "location", "parentIndex", "offset", "length", "roles", "mimeType", "contents", "encoding", "sourceLanguage", "hashes", "lastModifiedTimeUtc", "properties"]
+
+    @field_validator('roles')
+    def roles_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['analysisTarget', 'attachment', 'responseFile', 'resultFile', 'standardStream', 'tracedFile', 'unmodified', 'modified', 'added', 'deleted', 'renamed', 'uncontrolled', 'driver', 'extension', 'translation', 'taxonomy', 'policy', 'referencedOnCommandLine', 'memoryContents', 'directory', 'userSpecifiedConfiguration', 'toolSpecifiedConfiguration', 'debugOutputFile']):
+                raise ValueError("each list item must be one of ('analysisTarget', 'attachment', 'responseFile', 'resultFile', 'standardStream', 'tracedFile', 'unmodified', 'modified', 'added', 'deleted', 'renamed', 'uncontrolled', 'driver', 'extension', 'translation', 'taxonomy', 'policy', 'referencedOnCommandLine', 'memoryContents', 'directory', 'userSpecifiedConfiguration', 'toolSpecifiedConfiguration', 'debugOutputFile')")
+        return value
+
+    @field_validator('mime_type')
+    def mime_type_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"[^\/]+\/.+", value):
+            raise ValueError(r"must validate the regular expression /[^\/]+\/.+/")
+        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 Artifact 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 description
+        if self.description:
+            _dict['description'] = self.description.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of location
+        if self.location:
+            _dict['location'] = self.location.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of contents
+        if self.contents:
+            _dict['contents'] = self.contents.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of properties
+        if self.properties:
+            _dict['properties'] = self.properties.to_dict()
+        # set to None if description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict['description'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Artifact from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "description": Message.from_dict(obj["description"]) if obj.get("description") is not None else None,
+            "location": ArtifactLocation.from_dict(obj["location"]) if obj.get("location") is not None else None,
+            "parentIndex": obj.get("parentIndex") if obj.get("parentIndex") is not None else -1,
+            "offset": obj.get("offset"),
+            "length": obj.get("length") if obj.get("length") is not None else -1,
+            "roles": obj.get("roles"),
+            "mimeType": obj.get("mimeType"),
+            "contents": ArtifactContent.from_dict(obj["contents"]) if obj.get("contents") is not None else None,
+            "encoding": obj.get("encoding"),
+            "sourceLanguage": obj.get("sourceLanguage"),
+            "hashes": obj.get("hashes"),
+            "lastModifiedTimeUtc": obj.get("lastModifiedTimeUtc"),
+            "properties": PropertyBag.from_dict(obj["properties"]) if obj.get("properties") is not None else None
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/artifact_change.py

@@ -0,0 +1,108 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from hiddenlayer.sdk.rest.models.artifact_location import ArtifactLocation
+from hiddenlayer.sdk.rest.models.property_bag import PropertyBag
+from hiddenlayer.sdk.rest.models.replacement import Replacement
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ArtifactChange(BaseModel):
+    """
+    A change to a single artifact.
+    """ # noqa: E501
+    artifact_location: ArtifactLocation = Field(alias="artifactLocation")
+    replacements: Annotated[List[Replacement], Field(min_length=1)] = Field(description="An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.")
+    properties: Optional[PropertyBag] = None
+    __properties: ClassVar[List[str]] = ["artifactLocation", "replacements", "properties"]
+
+    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 ArtifactChange 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 artifact_location
+        if self.artifact_location:
+            _dict['artifactLocation'] = self.artifact_location.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in replacements (list)
+        _items = []
+        if self.replacements:
+            for _item in self.replacements:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['replacements'] = _items
+        # override the default output from pydantic by calling `to_dict()` of properties
+        if self.properties:
+            _dict['properties'] = self.properties.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ArtifactChange from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "artifactLocation": ArtifactLocation.from_dict(obj["artifactLocation"]) if obj.get("artifactLocation") is not None else None,
+            "replacements": [Replacement.from_dict(_item) for _item in obj["replacements"]] if obj.get("replacements") is not None else None,
+            "properties": PropertyBag.from_dict(obj["properties"]) if obj.get("properties") is not None else None
+        })
+        return _obj
+
+

hiddenlayer/sdk/rest/models/artifact_content.py

@@ -0,0 +1,101 @@
+# 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.multiformat_message_string import MultiformatMessageString
+from hiddenlayer.sdk.rest.models.property_bag import PropertyBag
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ArtifactContent(BaseModel):
+    """
+    Represents the contents of an artifact.
+    """ # noqa: E501
+    text: Optional[StrictStr] = Field(default=None, description="UTF-8-encoded content from a text artifact.")
+    binary: Optional[StrictStr] = Field(default=None, description="MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.")
+    rendered: Optional[MultiformatMessageString] = None
+    properties: Optional[PropertyBag] = None
+    __properties: ClassVar[List[str]] = ["text", "binary", "rendered", "properties"]
+
+    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 ArtifactContent 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 rendered
+        if self.rendered:
+            _dict['rendered'] = self.rendered.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of properties
+        if self.properties:
+            _dict['properties'] = self.properties.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ArtifactContent from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text"),
+            "binary": obj.get("binary"),
+            "rendered": MultiformatMessageString.from_dict(obj["rendered"]) if obj.get("rendered") is not None else None,
+            "properties": PropertyBag.from_dict(obj["properties"]) if obj.get("properties") is not None else None
+        })
+        return _obj
+
+