vysion 2.0.3__py3-none-any.whl → 2.0.5__py3-none-any.whl

vysion/client/client.py

@@ -26,9 +26,19 @@ from urllib.parse import quote, urlencode, urljoin
 # from pydantic import validate_arguments
 import requests
 
-import vysion.dto as dto
 from vysion.client.error import APIError
-from vysion.dto import Error
+from vysion.dto import (
+    Error,
+    DocumentHit,
+    VysionResponse,
+    RansomwareHit,
+    Stat,
+    Network,
+    Language,
+    ImChannelHit,
+    ImMessageHit,
+    ImProfileHit,
+)
 from vysion.version import __version__ as vysion_version
 
 # All API endpoints start with this prefix, you don't need to include the
@@ -106,7 +116,7 @@ class BaseClient:
         query = "?" + urlencode(query_params_initialzed)
         return urljoin(base, query)
 
-    def _make_request(self, url: str) -> dto.VysionResponse:
+    def _make_request(self, url: str) -> VysionResponse:
         session = self.__get_session__()
         r = session.get(url)
 
@@ -122,14 +132,12 @@ class BaseClient:
 
             raise APIError(code, message)
 
-        payload = r.json()
-
-        result = dto.VysionResponse.model_validate(payload)
+        result = r.json()
 
         return result
 
 
-def vysion_error_manager(method) -> Union[dto.VysionResponse, Error]:
+def vysion_error_manager(method) -> Union[VysionResponse, Error]:
     def manage(*args, **kwargs):
         try:
             result = method(*args, **kwargs)
@@ -161,11 +169,11 @@ class Client(BaseClient):
         gte: datetime = None,
         page: int = 1,
         page_size: int = 10,
-        network: dto.Network = None,
-        language: dto.Language = None,
+        network: Network = None,
+        language: Language = None,
         include_tag: str = None,
         exclude_tag: str = None,
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__(
             "document/search",
             q=q,
@@ -179,14 +187,14 @@ class Client(BaseClient):
             exclude_tag=exclude_tag,
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
-    def get_document(self, document_id: str) -> dto.VysionResponse:
+    def get_document(self, document_id: str) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__("document", document_id)
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -196,28 +204,28 @@ class Client(BaseClient):
         page: int = 1,
         lte: datetime = None,
         gte: datetime = None,
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__("document/url", url, page=page, lte=lte, gte=gte)
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
-    def get_tag(self, tag: str) -> dto.VysionResponse:
+    def get_tag(self, tag: str) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__("document/tag", tag)
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def find_email(
         self, email: str, page: int = 1, lte: datetime = None, gte: datetime = None
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__(
             "document/email", email, page=page, lte=lte, gte=gte
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -228,16 +236,16 @@ class Client(BaseClient):
         page: int = 1,
         lte: datetime = None,
         gte: datetime = None,
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__(
-            "document/phone",
-            country_code + "/" + phone_number,
+            "document/phone/" + country_code,
+            phone_number,
             page=page,
             lte=lte,
             gte=gte,
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -248,12 +256,12 @@ class Client(BaseClient):
         page: int = 1,
         lte: datetime = None,
         gte: datetime = None,
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__(
-            "document/wallet", chain + "/" + address, page=page, lte=lte, gte=gte
+            "document/wallet/" + chain, address, page=page, lte=lte, gte=gte
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -276,10 +284,10 @@ class Client(BaseClient):
         gte: datetime = None,
         page: int = 1,
         page_size: int = 10,
-        network: dto.Network = None,
+        network: Network = None,
         country: str = None,
-        language: dto.Language = None,
-    ) -> dto.VysionResponse:
+        language: Language = None,
+    ) -> VysionResponse[RansomwareHit]:
         url = self._build_api_url__(
             "victim/search",
             q=q,
@@ -292,14 +300,14 @@ class Client(BaseClient):
             language=language,
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[RansomwareHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
-    def get_ransomware_victim(self, document_id: str) -> dto.VysionResponse:
+    def get_ransomware_victim(self, document_id: str) -> VysionResponse[RansomwareHit]:
         url = self._build_api_url__("victim", document_id)
 
-        result = self._make_request(url)
+        result = VysionResponse[RansomwareHit].model_validate(self._make_request(url))
         return result.data
 
     #
@@ -312,10 +320,12 @@ class Client(BaseClient):
         countries: str = None,
         gte: datetime = None,
         lte: datetime = None,
-    ) -> dto.VysionResponse[dto.Stat]:
-        url = self._build_api_url__("stats/countries", countries=countries, gte=gte, lte=lte)
+    ) -> VysionResponse[Stat]:
+        url = self._build_api_url__(
+            "stats/countries", countries=countries, gte=gte, lte=lte
+        )
 
-        result = self._make_request(url)
+        result = VysionResponse[Stat].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -324,10 +334,12 @@ class Client(BaseClient):
         countries: str = None,
         gte: datetime = None,
         lte: datetime = None,
-    ) -> dto.VysionResponse[dto.Stat]:
-        url = self._build_api_url__("stats/groups", countries=countries, gte=gte, lte=lte)
+    ) -> VysionResponse[Stat]:
+        url = self._build_api_url__(
+            "stats/groups", countries=countries, gte=gte, lte=lte
+        )
 
-        result = self._make_request(url)
+        result = VysionResponse[Stat].model_validate(self._make_request(url))
         return result.data
 
     #
@@ -343,7 +355,7 @@ class Client(BaseClient):
         lte: datetime = None,
         page: int = 1,
         username: str = None,
-    ) -> dto.VysionResponse[dto.ImMessageHit]:
+    ) -> VysionResponse[ImMessageHit]:
         url = self._build_api_url__(
             "im/" + platform + "/search",
             q=q,
@@ -353,43 +365,45 @@ class Client(BaseClient):
             username=username,
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[ImMessageHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def get_im_chat(
         self, platform: str, channelId: str, gte: datetime = None, lte: datetime = None
-    ) -> dto.VysionResponse[dto.ImMessageHit]:
-        url = self._build_api_url__("im/" + platform + "/chat/" + channelId, gte=gte, lte=lte)
+    ) -> VysionResponse[ImMessageHit]:
+        url = self._build_api_url__(
+            "im/" + platform + "/chat/" + channelId, gte=gte, lte=lte
+        )
 
-        result = self._make_request(url)
+        result = VysionResponse[ImMessageHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def get_im_profile(
         self, platform: str, userId: str
-    ) -> dto.VysionResponse[dto.ImProfileHit]:
+    ) -> VysionResponse[ImProfileHit]:
         url = self._build_api_url__("im/" + platform + "/profile/", userId)
 
-        result = self._make_request(url)
+        result = VysionResponse[ImProfileHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def get_im_message(
         self, platform: str, messageId: str
-    ) -> dto.VysionResponse[dto.ImMessageHit]:
+    ) -> VysionResponse[ImMessageHit]:
         url = self._build_api_url__("im/" + platform + "/message/", messageId)
 
-        result = self._make_request(url)
+        result = VysionResponse[ImMessageHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def get_im_channel(
         self, platform: str, channelId: str
-    ) -> dto.VysionResponse[dto.ImChannelHit]:
+    ) -> VysionResponse[ImChannelHit]:
         url = self._build_api_url__("im/" + platform + "/channel/", channelId)
 
-        result = self._make_request(url)
+        result = VysionResponse[ImChannelHit].model_validate(self._make_request(url))
         return result.data
 
     #

vysion/dto/dto.py

@@ -399,8 +399,7 @@ T = TypeVar("T")
 
 class Result(BaseModel, Generic[T]):
     total: int = 0
-    hits: Union[List[DocumentHit],List[Stat],List[ImChannelHit],List[ImMessageHit],
-                List[ImProfileHit],List[RansomFeedHit],List[RansomwareHit]] = Field(default_factory=lambda: [])
+    hits: List[T] = Field(default_factory=lambda: [])
     
     def __init__(self, **kwargs):
         super().__init__(**kwargs)

vysion/dto/tag.py

@@ -58,4 +58,4 @@ class Tag(BaseModel):
         return f"Tag<{self}>"
 
     def __str__(self):
-        return f'''{self.namespace}:{self.predicate}:"{self.value}"'''
+        return f'''{self.namespace}:{self.predicate}="{self.value}"'''

vysion/dto/util.py

@@ -111,7 +111,7 @@ class MISPProcessor:
 
         self.misp_event.add_object(misp_object)
 
-    def process(self, result: dto.Result, **kwargs) -> MISPEvent:
+    def process(self, result: dto.Result[DocumentHit|RansomFeedHit], **kwargs) -> MISPEvent:
         
         processor = {
             DocumentHit: self.parse_hit,

vysion/version.py

@@ -15,4 +15,4 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
-__version__ = "2.0.3"
+__version__ = "2.0.5"

{vysion-2.0.3.dist-info → vysion-2.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vysion
-Version: 2.0.3
+Version: 2.0.5
 Summary: The official Python client library for Vysion
 Home-page: https://vysion.ai
 License: Apache-2.0
@@ -29,7 +29,7 @@ Welcome to the PyPi webpage for Vysion, our implementation as a Python library t
 
 You can request a demo for the web app or an API-key to use in this library at [vysion.ai](https://vysion.ai).
 
-Latest version: [2.0.3](https://pypi.org/project/vysion/)
+Latest version: [2.0.5](https://pypi.org/project/vysion/)
 
 You can visit [the documentation](https://developers.vysion.ai/?python) for more information on the searches and requests performed with the library or directly on the API.
 

{vysion-2.0.3.dist-info → vysion-2.0.5.dist-info}/RECORD

@@ -1,11 +1,11 @@
 vysion/__init__.py,sha256=yxJiM-S29q8GB3PBff9tV70P2nvydd8aKLEprLkXw5o,664
 vysion/client/__init__.py,sha256=aVHmBuetPdybp7TgcNzUx4HkxTjEuXYzSdDYiYfFQd0,630
-vysion/client/client.py,sha256=HUUePwG7btGVwQWSN8atxf0scMbOOAKyLwFGMOblZZ4,11729
+vysion/client/client.py,sha256=ce61pZP9nWhHnzGpzWA8TAt2DC14W_3UqJexHHBRHrc,12558
 vysion/client/error.py,sha256=-3NGr9ngTGSy-ctqk6S9eMBAvtY3lnjv9i0KiuRjd5g,1158
 vysion/dto/__init__.py,sha256=ct8JxVMfJ0APiOTgr9ju-JIuBlXOrPkx7n2qISSXUts,605
-vysion/dto/dto.py,sha256=ud5Kk1xz48_sRfVYe4K7gtg1LrnTh5P4neiLRNx4mD8,13200
-vysion/dto/tag.py,sha256=_Dn4-_xiC1PD4udp3m4FsDdyHVCSgrq7NFJomjsMYtU,1503
-vysion/dto/util.py,sha256=WESBTKWWBGtMmXCKL9hqQqLJjAY5MIxyqhbTPEZW3mM,4433
+vysion/dto/dto.py,sha256=kRwN3ElHt0GxM4bHuGgDa-IFRqVul0R3CBDfZBh7R-s,13058
+vysion/dto/tag.py,sha256=whGPsdasgYm8oijrL7MRSMmapzaoCmKNeaJ5ih0aBIk,1503
+vysion/dto/util.py,sha256=bs-DXwHakGU1E3463P3fzNQ5C5d7EwvLIN3xqKT8Ahw,4460
 vysion/model/__init__.py,sha256=rJX9eNW9-jQGTgwm97W04jhZa-dV_dSTTTFcbWg73w0,606
 vysion/model/enum/__init__.py,sha256=lhG6rgaYjrFBR8_IfJL0OoT0L7vooR5_ht4zUahQcOc,690
 vysion/model/enum/languages.py,sha256=yrYDwLEM2lK5iqdLR16n8xeCeSmsCsIj4sTiuNz33FM,4204
@@ -15,8 +15,8 @@ vysion/model/enum/services.py,sha256=fUfZEO0RNNctU4Gzae5TV3c7BU5A_cEwaEb1tzqgcr0
 vysion/taxonomy/__init__.py,sha256=Bc364AYxRCyjIn26-XBPeEDCPe3Hma4r5RAI8R8eblU,635
 vysion/taxonomy/flavours.py,sha256=ubImHBE8v0zhzFy_2YozAQk2SzN1XDQwHAxb2RebtCo,2347
 vysion/taxonomy/taxonomy.py,sha256=mG6vHX5Eyp38AKyJBgfBDqdpEmDMbkv8TA8YUBzko54,12227
-vysion/version.py,sha256=TooJDNm5IH_y6jx2DbfRXgSqx_Mum1MW68HyMQcSLO4,610
-vysion-2.0.3.dist-info/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-vysion-2.0.3.dist-info/METADATA,sha256=XIc4kKDHD7MrzxPaZQ6UKdnT3NIL7-Uq_LMpJsWByec,2122
-vysion-2.0.3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-vysion-2.0.3.dist-info/RECORD,,
+vysion/version.py,sha256=vxtas-jndirPiYaFbGS7QFsPL4wNV43j6SwiSecUGQI,610
+vysion-2.0.5.dist-info/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+vysion-2.0.5.dist-info/METADATA,sha256=_brYLMOQDb5E7cxIcyQRm_HDVLzk-VpiUkmE5fwF7PM,2122
+vysion-2.0.5.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+vysion-2.0.5.dist-info/RECORD,,