revengai 1.1.1__py3-none-any.whl

revengai/models/ann_function.py

@@ -0,0 +1,121 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.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, StrictBool, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from revengai.models.search_binary_ids import SearchBinaryIds
+from revengai.models.search_function_ids import SearchFunctionIds
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ANNFunction(BaseModel):
+    """
+    ANNFunction
+    """ # noqa: E501
+    limit: Optional[StrictInt] = Field(default=5, description="The amount of neighbours per function ID")
+    distance: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.1, description="The distance between two neighbours")
+    analysis_search_ids: Optional[List[Optional[StrictInt]]] = Field(default=None, description="Perform a search on functions within a list of analyses")
+    collection_search_ids: Optional[Annotated[List[Optional[StrictInt]], Field(max_length=5)]] = Field(default=None, description="Search only within these collections")
+    search_binary_ids: Optional[SearchBinaryIds] = None
+    search_function_ids: Optional[SearchFunctionIds] = None
+    debug_only: Optional[StrictBool] = Field(default=False, description="Searches for only functions which are debug")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["limit", "distance", "analysis_search_ids", "collection_search_ids", "search_binary_ids", "search_function_ids", "debug_only"]
+
+    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 ANNFunction 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of search_binary_ids
+        if self.search_binary_ids:
+            _dict['search_binary_ids'] = self.search_binary_ids.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of search_function_ids
+        if self.search_function_ids:
+            _dict['search_function_ids'] = self.search_function_ids.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ANNFunction from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "limit": obj.get("limit") if obj.get("limit") is not None else 5,
+            "distance": obj.get("distance") if obj.get("distance") is not None else 0.1,
+            "analysis_search_ids": obj.get("analysis_search_ids"),
+            "collection_search_ids": obj.get("collection_search_ids"),
+            "search_binary_ids": SearchBinaryIds.from_dict(obj["search_binary_ids"]) if obj.get("search_binary_ids") is not None else None,
+            "search_function_ids": SearchFunctionIds.from_dict(obj["search_function_ids"]) if obj.get("search_function_ids") is not None else None,
+            "debug_only": obj.get("debug_only") if obj.get("debug_only") is not None else False
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

revengai/models/ann_input.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ANNInput(BaseModel):
+    """
+    ANNInput
+    """ # noqa: E501
+    result_per_function: Optional[StrictInt] = None
+    debug_mode: Optional[StrictBool] = None
+    distance: Optional[Union[StrictFloat, StrictInt]] = None
+    collection: Optional[List[Optional[StrictStr]]] = None
+    __properties: ClassVar[List[str]] = ["result_per_function", "debug_mode", "distance", "collection"]
+
+    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 ANNInput 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 result_per_function (nullable) is None
+        # and model_fields_set contains the field
+        if self.result_per_function is None and "result_per_function" in self.model_fields_set:
+            _dict['result_per_function'] = None
+
+        # set to None if debug_mode (nullable) is None
+        # and model_fields_set contains the field
+        if self.debug_mode is None and "debug_mode" in self.model_fields_set:
+            _dict['debug_mode'] = None
+
+        # set to None if distance (nullable) is None
+        # and model_fields_set contains the field
+        if self.distance is None and "distance" in self.model_fields_set:
+            _dict['distance'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ANNInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "result_per_function": obj.get("result_per_function"),
+            "debug_mode": obj.get("debug_mode"),
+            "distance": obj.get("distance"),
+            "collection": obj.get("collection")
+        })
+        return _obj
+
+

revengai/models/app_api_rest_v1_analyse_schema_model_name.py

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AppApiRestV1AnalyseSchemaModelName(str, Enum):
+    """
+    Custom enum for the model name
+    """
+
+    """
+    allowed enum values
+    """
+    BINNET_MINUS_0_DOT_5_MINUS_X86_MINUS_WINDOWS = 'binnet-0.5-x86-windows'
+    BINNET_MINUS_0_DOT_5_MINUS_X86_MINUS_LINUX = 'binnet-0.5-x86-linux'
+    BINNET_MINUS_0_DOT_5_MINUS_X86_MINUS_MACOS = 'binnet-0.5-x86-macos'
+    BINNET_MINUS_0_DOT_5_MINUS_X86_MINUS_ANDROID = 'binnet-0.5-x86-android'
+    BINNET_MINUS_0_DOT_5_MINUS_X86_MINUS_32_MINUS_LINUX = 'binnet-0.5-x86-32-linux'
+    BINNET_MINUS_0_DOT_5_MINUS_X86_MINUS_32_MINUS_WINDOWS = 'binnet-0.5-x86-32-windows'
+    BINNET_MINUS_0_DOT_5_MINUS_ARM_MINUS_64_MINUS_LINUX = 'binnet-0.5-arm-64-linux'
+    BINNET_MINUS_0_DOT_5_MINUS_ARM_MINUS_64_MINUS_WINDOWS = 'binnet-0.5-arm-64-windows'
+    BINNET_MINUS_0_DOT_5 = 'binnet-0.5'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AppApiRestV1AnalyseSchemaModelName from a JSON string"""
+        return cls(json.loads(json_str))
+
+

revengai/models/app_api_rest_v1_analyse_schema_status.py

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AppApiRestV1AnalyseSchemaStatus(str, Enum):
+    """
+    Custom enum for status
+    """
+
+    """
+    allowed enum values
+    """
+    QUEUED = 'Queued'
+    PROCESSING = 'Processing'
+    COMPLETE = 'Complete'
+    ERROR = 'Error'
+    ALL = 'All'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AppApiRestV1AnalyseSchemaStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

revengai/models/app_api_rest_v1_analyse_schema_symbols.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.user_boundaries import UserBoundaries
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AppApiRestV1AnalyseSchemaSymbols(BaseModel):
+    """
+    AppApiRestV1AnalyseSchemaSymbols
+    """ # noqa: E501
+    base_addr: Optional[StrictInt] = None
+    functions: Optional[List[UserBoundaries]] = None
+    __properties: ClassVar[List[str]] = ["base_addr", "functions"]
+
+    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 AppApiRestV1AnalyseSchemaSymbols 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 functions (list)
+        _items = []
+        if self.functions:
+            for _item_functions in self.functions:
+                if _item_functions:
+                    _items.append(_item_functions.to_dict())
+            _dict['functions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AppApiRestV1AnalyseSchemaSymbols from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "base_addr": obj.get("base_addr"),
+            "functions": [UserBoundaries.from_dict(_item) for _item in obj["functions"]] if obj.get("functions") is not None else None
+        })
+        return _obj
+
+

revengai/models/app_api_rest_v1_analysis_info_responses_logs.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AppApiRestV1AnalysisInfoResponsesLogs(BaseModel):
+    """
+    AppApiRestV1AnalysisInfoResponsesLogs
+    """ # noqa: E501
+    success: Optional[Any] = None
+    logs: Optional[Any]
+    __properties: ClassVar[List[str]] = ["success", "logs"]
+
+    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 AppApiRestV1AnalysisInfoResponsesLogs 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 success (nullable) is None
+        # and model_fields_set contains the field
+        if self.success is None and "success" in self.model_fields_set:
+            _dict['success'] = None
+
+        # set to None if logs (nullable) is None
+        # and model_fields_set contains the field
+        if self.logs is None and "logs" in self.model_fields_set:
+            _dict['logs'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AppApiRestV1AnalysisInfoResponsesLogs from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "success": obj.get("success"),
+            "logs": obj.get("logs")
+        })
+        return _obj
+
+

revengai/models/app_api_rest_v1_analysis_info_schema_function_rename.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    RevEng.AI API
+
+    RevEng.AI is Similarity Search Engine for executable binaries
+
+    The version of the OpenAPI document: 0.0.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
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AppApiRestV1AnalysisInfoSchemaFunctionRename(BaseModel):
+    """
+    AppApiRestV1AnalysisInfoSchemaFunctionRename
+    """ # noqa: E501
+    new_name: Annotated[str, Field(min_length=1, strict=True)]
+    __properties: ClassVar[List[str]] = ["new_name"]
+
+    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 AppApiRestV1AnalysisInfoSchemaFunctionRename 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 AppApiRestV1AnalysisInfoSchemaFunctionRename from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "new_name": obj.get("new_name")
+        })
+        return _obj
+
+