revengai 2.74.0__py3-none-any.whl

revengai/models/base_response_ttps.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.error_model import ErrorModel
+from revengai.models.meta_model import MetaModel
+from revengai.models.ttps import TTPS
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BaseResponseTTPS(BaseModel):
+    """
+    BaseResponseTTPS
+    """ # noqa: E501
+    status: Optional[StrictBool] = Field(default=True, description="Response status on whether the request succeeded")
+    data: Optional[TTPS] = None
+    message: Optional[StrictStr] = None
+    errors: Optional[List[ErrorModel]] = None
+    meta: Optional[MetaModel] = Field(default=None, description="Metadata")
+    __properties: ClassVar[List[str]] = ["status", "data", "message", "errors", "meta"]
+
+    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 BaseResponseTTPS 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in errors (list)
+        _items = []
+        if self.errors:
+            for _item_errors in self.errors:
+                if _item_errors:
+                    _items.append(_item_errors.to_dict())
+            _dict['errors'] = _items
+        # override the default output from pydantic by calling `to_dict()` of meta
+        if self.meta:
+            _dict['meta'] = self.meta.to_dict()
+        # set to None if data (nullable) is None
+        # and model_fields_set contains the field
+        if self.data is None and "data" in self.model_fields_set:
+            _dict['data'] = None
+
+        # set to None if message (nullable) is None
+        # and model_fields_set contains the field
+        if self.message is None and "message" in self.model_fields_set:
+            _dict['message'] = None
+
+        # set to None if errors (nullable) is None
+        # and model_fields_set contains the field
+        if self.errors is None and "errors" in self.model_fields_set:
+            _dict['errors'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BaseResponseTTPS from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status") if obj.get("status") is not None else True,
+            "data": TTPS.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "message": obj.get("message"),
+            "errors": [ErrorModel.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None,
+            "meta": MetaModel.from_dict(obj["meta"]) if obj.get("meta") is not None else None
+        })
+        return _obj
+
+

revengai/models/base_response_upload_response.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.error_model import ErrorModel
+from revengai.models.meta_model import MetaModel
+from revengai.models.upload_response import UploadResponse
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BaseResponseUploadResponse(BaseModel):
+    """
+    BaseResponseUploadResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = Field(default=True, description="Response status on whether the request succeeded")
+    data: Optional[UploadResponse] = None
+    message: Optional[StrictStr] = None
+    errors: Optional[List[ErrorModel]] = None
+    meta: Optional[MetaModel] = Field(default=None, description="Metadata")
+    __properties: ClassVar[List[str]] = ["status", "data", "message", "errors", "meta"]
+
+    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 BaseResponseUploadResponse 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in errors (list)
+        _items = []
+        if self.errors:
+            for _item_errors in self.errors:
+                if _item_errors:
+                    _items.append(_item_errors.to_dict())
+            _dict['errors'] = _items
+        # override the default output from pydantic by calling `to_dict()` of meta
+        if self.meta:
+            _dict['meta'] = self.meta.to_dict()
+        # set to None if data (nullable) is None
+        # and model_fields_set contains the field
+        if self.data is None and "data" in self.model_fields_set:
+            _dict['data'] = None
+
+        # set to None if message (nullable) is None
+        # and model_fields_set contains the field
+        if self.message is None and "message" in self.model_fields_set:
+            _dict['message'] = None
+
+        # set to None if errors (nullable) is None
+        # and model_fields_set contains the field
+        if self.errors is None and "errors" in self.model_fields_set:
+            _dict['errors'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BaseResponseUploadResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status") if obj.get("status") is not None else True,
+            "data": UploadResponse.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "message": obj.get("message"),
+            "errors": [ErrorModel.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None,
+            "meta": MetaModel.from_dict(obj["meta"]) if obj.get("meta") is not None else None
+        })
+        return _obj
+
+

revengai/models/base_response_vulnerabilities.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.error_model import ErrorModel
+from revengai.models.meta_model import MetaModel
+from revengai.models.vulnerabilities import Vulnerabilities
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BaseResponseVulnerabilities(BaseModel):
+    """
+    BaseResponseVulnerabilities
+    """ # noqa: E501
+    status: Optional[StrictBool] = Field(default=True, description="Response status on whether the request succeeded")
+    data: Optional[Vulnerabilities] = None
+    message: Optional[StrictStr] = None
+    errors: Optional[List[ErrorModel]] = None
+    meta: Optional[MetaModel] = Field(default=None, description="Metadata")
+    __properties: ClassVar[List[str]] = ["status", "data", "message", "errors", "meta"]
+
+    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 BaseResponseVulnerabilities 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in errors (list)
+        _items = []
+        if self.errors:
+            for _item_errors in self.errors:
+                if _item_errors:
+                    _items.append(_item_errors.to_dict())
+            _dict['errors'] = _items
+        # override the default output from pydantic by calling `to_dict()` of meta
+        if self.meta:
+            _dict['meta'] = self.meta.to_dict()
+        # set to None if data (nullable) is None
+        # and model_fields_set contains the field
+        if self.data is None and "data" in self.model_fields_set:
+            _dict['data'] = None
+
+        # set to None if message (nullable) is None
+        # and model_fields_set contains the field
+        if self.message is None and "message" in self.model_fields_set:
+            _dict['message'] = None
+
+        # set to None if errors (nullable) is None
+        # and model_fields_set contains the field
+        if self.errors is None and "errors" in self.model_fields_set:
+            _dict['errors'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BaseResponseVulnerabilities from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status") if obj.get("status") is not None else True,
+            "data": Vulnerabilities.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            "message": obj.get("message"),
+            "errors": [ErrorModel.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None,
+            "meta": MetaModel.from_dict(obj["meta"]) if obj.get("meta") is not None else None
+        })
+        return _obj
+
+

revengai/models/basic.py

@@ -0,0 +1,116 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Basic(BaseModel):
+    """
+    Basic
+    """ # noqa: E501
+    binary_name: StrictStr = Field(description="The name of the binary uploaded")
+    binary_size: StrictInt = Field(description="The size of the binary uploaded (bytes)")
+    creation: datetime = Field(description="When the binary was uploaded")
+    sha_256_hash: StrictStr = Field(description="The hash of the binary uploaded")
+    model_name: StrictStr = Field(description="The model name used for analysis")
+    model_id: StrictInt = Field(description="The model ID used for analysis")
+    owner_username: StrictStr = Field(description="The name of the owner of the binary")
+    analysis_scope: StrictStr = Field(description="The scope of the analysis")
+    is_owner: StrictBool = Field(description="Whether the current user is the owner")
+    debug: StrictBool = Field(description="Whether the current analysis was analysed with debug symbols")
+    function_count: StrictInt = Field(description="The number of functions in the binary")
+    is_advanced: StrictBool = Field(description="Whether the analysis was advanced")
+    base_address: Optional[StrictInt]
+    __properties: ClassVar[List[str]] = ["binary_name", "binary_size", "creation", "sha_256_hash", "model_name", "model_id", "owner_username", "analysis_scope", "is_owner", "debug", "function_count", "is_advanced", "base_address"]
+
+    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 Basic 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,
+        )
+        # set to None if base_address (nullable) is None
+        # and model_fields_set contains the field
+        if self.base_address is None and "base_address" in self.model_fields_set:
+            _dict['base_address'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Basic from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "binary_name": obj.get("binary_name"),
+            "binary_size": obj.get("binary_size"),
+            "creation": obj.get("creation"),
+            "sha_256_hash": obj.get("sha_256_hash"),
+            "model_name": obj.get("model_name"),
+            "model_id": obj.get("model_id"),
+            "owner_username": obj.get("owner_username"),
+            "analysis_scope": obj.get("analysis_scope"),
+            "is_owner": obj.get("is_owner"),
+            "debug": obj.get("debug"),
+            "function_count": obj.get("function_count"),
+            "is_advanced": obj.get("is_advanced"),
+            "base_address": obj.get("base_address")
+        })
+        return _obj
+
+

revengai/models/binary_additional_details_data_response.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    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, Optional
+from revengai.models.elf_model import ELFModel
+from revengai.models.file_metadata import FileMetadata
+from revengai.models.pe_model import PEModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BinaryAdditionalDetailsDataResponse(BaseModel):
+    """
+    BinaryAdditionalDetailsDataResponse
+    """ # noqa: E501
+    file: FileMetadata
+    pe: Optional[PEModel] = None
+    elf: Optional[ELFModel] = None
+    __properties: ClassVar[List[str]] = ["file", "pe", "elf"]
+
+    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 BinaryAdditionalDetailsDataResponse 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 file
+        if self.file:
+            _dict['file'] = self.file.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pe
+        if self.pe:
+            _dict['pe'] = self.pe.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of elf
+        if self.elf:
+            _dict['elf'] = self.elf.to_dict()
+        # set to None if pe (nullable) is None
+        # and model_fields_set contains the field
+        if self.pe is None and "pe" in self.model_fields_set:
+            _dict['pe'] = None
+
+        # set to None if elf (nullable) is None
+        # and model_fields_set contains the field
+        if self.elf is None and "elf" in self.model_fields_set:
+            _dict['elf'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BinaryAdditionalDetailsDataResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file": FileMetadata.from_dict(obj["file"]) if obj.get("file") is not None else None,
+            "pe": PEModel.from_dict(obj["pe"]) if obj.get("pe") is not None else None,
+            "elf": ELFModel.from_dict(obj["elf"]) if obj.get("elf") is not None else None
+        })
+        return _obj
+
+