revengai 1.1.1__py3-none-any.whl

revengai/models/collection_count.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 CollectionCount(BaseModel):
+    """
+    CollectionCount
+    """ # noqa: E501
+    success: Optional[Any] = None
+    count: Optional[Any]
+    __properties: ClassVar[List[str]] = ["success", "count"]
+
+    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 CollectionCount 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 count (nullable) is None
+        # and model_fields_set contains the field
+        if self.count is None and "count" in self.model_fields_set:
+            _dict['count'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CollectionCount 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"),
+            "count": obj.get("count")
+        })
+        return _obj
+
+

revengai/models/collection_create_request.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.collection_scope import CollectionScope
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CollectionCreateRequest(BaseModel):
+    """
+    CollectionCreateRequest
+    """ # noqa: E501
+    collection_name: StrictStr
+    description: StrictStr
+    collection_scope: Optional[CollectionScope] = None
+    tags: Optional[List[StrictStr]] = None
+    binaries: Optional[List[StrictInt]] = None
+    model_id: StrictInt
+    __properties: ClassVar[List[str]] = ["collection_name", "description", "collection_scope", "tags", "binaries", "model_id"]
+
+    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 CollectionCreateRequest 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 tags (nullable) is None
+        # and model_fields_set contains the field
+        if self.tags is None and "tags" in self.model_fields_set:
+            _dict['tags'] = None
+
+        # set to None if binaries (nullable) is None
+        # and model_fields_set contains the field
+        if self.binaries is None and "binaries" in self.model_fields_set:
+            _dict['binaries'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CollectionCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "collection_name": obj.get("collection_name"),
+            "description": obj.get("description"),
+            "collection_scope": obj.get("collection_scope"),
+            "tags": obj.get("tags"),
+            "binaries": obj.get("binaries"),
+            "model_id": obj.get("model_id")
+        })
+        return _obj
+
+

revengai/models/collection_list_item.py

@@ -0,0 +1,113 @@
+# 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 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 CollectionListItem(BaseModel):
+    """
+    CollectionListItem
+    """ # noqa: E501
+    collection_name: StrictStr = Field(description="The name of the collection")
+    description: StrictStr = Field(description="The description of the collection")
+    collection_scope: StrictStr = Field(description="The scope of the collection")
+    collection_owner: StrictStr = Field(description="The owner of the collection")
+    official_collection: StrictBool = Field(description="Whether the collection is maintained by RevEng.AI")
+    collection_tags: Optional[List[StrictStr]] = Field(default=None, description="The tags of the collection")
+    collection_size: StrictInt = Field(description="The size of the collection")
+    collection_id: StrictInt = Field(description="The ID of the collection")
+    creation: datetime = Field(description="The current status of analysis")
+    model_name: StrictStr = Field(description="The model being used for the collection")
+    team_id: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["collection_name", "description", "collection_scope", "collection_owner", "official_collection", "collection_tags", "collection_size", "collection_id", "creation", "model_name", "team_id"]
+
+    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 CollectionListItem 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 team_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.team_id is None and "team_id" in self.model_fields_set:
+            _dict['team_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CollectionListItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "collection_name": obj.get("collection_name"),
+            "description": obj.get("description"),
+            "collection_scope": obj.get("collection_scope"),
+            "collection_owner": obj.get("collection_owner"),
+            "official_collection": obj.get("official_collection"),
+            "collection_tags": obj.get("collection_tags"),
+            "collection_size": obj.get("collection_size"),
+            "collection_id": obj.get("collection_id"),
+            "creation": obj.get("creation"),
+            "model_name": obj.get("model_name"),
+            "team_id": obj.get("team_id")
+        })
+        return _obj
+
+

revengai/models/collection_response.py

@@ -0,0 +1,132 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.collection_response_binaries_inner import CollectionResponseBinariesInner
+from revengai.models.collection_scope import CollectionScope
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CollectionResponse(BaseModel):
+    """
+    CollectionResponse
+    """ # noqa: E501
+    collection_id: StrictInt = Field(description="Collection ID")
+    collection_name: StrictStr = Field(description="Collection name")
+    description: StrictStr = Field(description="Collection description")
+    model_id: StrictInt = Field(description="Collection model ID")
+    user_id: StrictInt = Field(description="Collection user ID")
+    team_id: Optional[StrictInt] = None
+    collection_scope: CollectionScope = Field(description="Collection public status")
+    created_at: datetime = Field(description="Collection creation date")
+    updated_at: datetime = Field(description="Collection last update date")
+    tags: Optional[List[StrictStr]] = None
+    binaries: Optional[List[CollectionResponseBinariesInner]] = None
+    __properties: ClassVar[List[str]] = ["collection_id", "collection_name", "description", "model_id", "user_id", "team_id", "collection_scope", "created_at", "updated_at", "tags", "binaries"]
+
+    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 CollectionResponse 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 binaries (list)
+        _items = []
+        if self.binaries:
+            for _item_binaries in self.binaries:
+                if _item_binaries:
+                    _items.append(_item_binaries.to_dict())
+            _dict['binaries'] = _items
+        # set to None if team_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.team_id is None and "team_id" in self.model_fields_set:
+            _dict['team_id'] = None
+
+        # set to None if tags (nullable) is None
+        # and model_fields_set contains the field
+        if self.tags is None and "tags" in self.model_fields_set:
+            _dict['tags'] = None
+
+        # set to None if binaries (nullable) is None
+        # and model_fields_set contains the field
+        if self.binaries is None and "binaries" in self.model_fields_set:
+            _dict['binaries'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CollectionResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "collection_id": obj.get("collection_id"),
+            "collection_name": obj.get("collection_name"),
+            "description": obj.get("description"),
+            "model_id": obj.get("model_id"),
+            "user_id": obj.get("user_id"),
+            "team_id": obj.get("team_id"),
+            "collection_scope": obj.get("collection_scope"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "tags": obj.get("tags"),
+            "binaries": [CollectionResponseBinariesInner.from_dict(_item) for _item in obj["binaries"]] if obj.get("binaries") is not None else None
+        })
+        return _obj
+
+

revengai/models/collection_response_binaries_inner.py

@@ -0,0 +1,136 @@
+# 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
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, ValidationError, field_validator
+from typing import Optional
+from revengai.models.collection_binary_response import CollectionBinaryResponse
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+COLLECTIONRESPONSEBINARIESINNER_ANY_OF_SCHEMAS = ["CollectionBinaryResponse", "int"]
+
+class CollectionResponseBinariesInner(BaseModel):
+    """
+    CollectionResponseBinariesInner
+    """
+
+    # data type: int
+    anyof_schema_1_validator: Optional[StrictInt] = None
+    # data type: CollectionBinaryResponse
+    anyof_schema_2_validator: Optional[CollectionBinaryResponse] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[CollectionBinaryResponse, int]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "CollectionBinaryResponse", "int" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = CollectionResponseBinariesInner.model_construct()
+        error_messages = []
+        # validate data type: int
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: CollectionBinaryResponse
+        if not isinstance(v, CollectionBinaryResponse):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CollectionBinaryResponse`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in CollectionResponseBinariesInner with anyOf schemas: CollectionBinaryResponse, int. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # deserialize data into int
+        try:
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[CollectionBinaryResponse] = None
+        try:
+            instance.actual_instance = CollectionBinaryResponse.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into CollectionResponseBinariesInner with anyOf schemas: CollectionBinaryResponse, int. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], CollectionBinaryResponse, int]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

revengai/models/collection_scope.py

@@ -0,0 +1,39 @@
+# 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 CollectionScope(str, Enum):
+    """
+    CollectionScope
+    """
+
+    """
+    allowed enum values
+    """
+    PRIVATE = 'PRIVATE'
+    PUBLIC = 'PUBLIC'
+    PROTECTED = 'PROTECTED'
+    TEAM = 'TEAM'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CollectionScope from a JSON string"""
+        return cls(json.loads(json_str))
+
+