exa-py 1.9.0__py3-none-any.whl → 1.10.0__py3-none-any.whl

exa_py/websets/core/base.py

@@ -0,0 +1,41 @@
+
+from __future__ import annotations
+
+from pydantic import ConfigDict
+
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel
+
+class ExaBaseModel(BaseModel):
+    """Base model for all Exa models with common configuration."""
+    model_config = ConfigDict(populate_by_name=True)
+
+class WebsetsBaseClient:
+    base_url: str
+
+    """Base client for Exa API resources."""
+
+    def __init__(self, client):
+        """Initialize the client.
+        
+        Args:
+            client: The parent Exa client.
+        """
+        self._client = client
+        
+    def request(self, endpoint: str, data: Optional[Dict[str, Any]] = None, 
+                method: str = "POST", params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+        """Make a request to the Exa API.
+        
+        Args:
+            endpoint (str): The API endpoint to request.
+            data (Dict[str, Any], optional): The request data. Defaults to None.
+            method (str, optional): The HTTP method. Defaults to "POST".
+            params (Dict[str, Any], optional): The query parameters. Defaults to None.
+            
+        Returns:
+            Dict[str, Any]: The API response.
+        """
+        return self._client.request("/websets/" + endpoint, data=data, method=method, params=params) 
+    

exa_py/websets/enrichments/__init__.py

@@ -0,0 +1,3 @@
+from .client import WebsetEnrichmentsClient
+
+__all__ = ["WebsetEnrichmentsClient"] 

exa_py/websets/enrichments/client.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from ..types import (
+    CreateEnrichmentParameters,
+    WebsetEnrichment,
+)
+from ..core.base import WebsetsBaseClient
+
+class WebsetEnrichmentsClient(WebsetsBaseClient):
+    """Client for managing Webset Enrichments."""
+    
+    def __init__(self, client):
+        super().__init__(client)
+
+    def create(self, webset_id: str, params: CreateEnrichmentParameters) -> WebsetEnrichment:
+        """Create an Enrichment for a Webset.
+        
+        Args:
+            webset_id (str): The id of the Webset.
+            params (CreateEnrichmentParameters): The parameters for creating an enrichment.
+        
+        Returns:
+            WebsetEnrichment: The created enrichment.
+        """
+        response = self.request(f"/v0/websets/{webset_id}/enrichments", data=params.model_dump(by_alias=True, exclude_none=True))
+        return WebsetEnrichment.model_validate(response)
+
+    def get(self, webset_id: str, id: str) -> WebsetEnrichment:
+        """Get an Enrichment by ID.
+        
+        Args:
+            webset_id (str): The id of the Webset.
+            id (str): The id of the Enrichment.
+        
+        Returns:
+            WebsetEnrichment: The retrieved enrichment.
+        """
+        response = self.request(f"/v0/websets/{webset_id}/enrichments/{id}", method="GET")
+        return WebsetEnrichment.model_validate(response)
+
+    def delete(self, webset_id: str, id: str) -> WebsetEnrichment:
+        """Delete an Enrichment.
+        
+        Args:
+            webset_id (str): The id of the Webset.
+            id (str): The id of the Enrichment.
+        
+        Returns:
+            WebsetEnrichment: The deleted enrichment.
+        """
+        response = self.request(f"/v0/websets/{webset_id}/enrichments/{id}", method="DELETE")
+        return WebsetEnrichment.model_validate(response)
+
+    def cancel(self, webset_id: str, id: str) -> WebsetEnrichment:
+        """Cancel a running Enrichment.
+        
+        Args:
+            webset_id (str): The id of the Webset.
+            id (str): The id of the Enrichment.
+        
+        Returns:
+            WebsetEnrichment: The canceled enrichment.
+        """
+        response = self.request(f"/v0/websets/{webset_id}/enrichments/{id}/cancel", method="POST")
+        return WebsetEnrichment.model_validate(response) 

exa_py/websets/items/__init__.py

@@ -0,0 +1,3 @@
+from .client import WebsetItemsClient
+
+__all__ = ["WebsetItemsClient"] 

exa_py/websets/items/client.py

@@ -0,0 +1,78 @@
+from __future__ import annotations
+
+from typing import  Optional, Iterator
+
+from ..types import (
+    WebsetItem,
+    ListWebsetItemResponse,
+)
+from ..core.base import WebsetsBaseClient
+
+class WebsetItemsClient(WebsetsBaseClient):
+    """Client for managing Webset Items."""
+    
+    def __init__(self, client):
+        super().__init__(client)
+
+    def list(self, webset_id: str, *, cursor: Optional[str] = None, 
+             limit: Optional[int] = None) -> ListWebsetItemResponse:
+        """List all Items for a Webset.
+        
+        Args:
+            webset_id (str): The id or externalId of the Webset.
+            cursor (str, optional): The cursor to paginate through the results.
+            limit (int, optional): The number of results to return (max 200).
+        
+        Returns:
+            ListWebsetItemResponse: List of webset items.
+        """
+        params = {k: v for k, v in {"cursor": cursor, "limit": limit}.items() if v is not None}
+        response = self.request(f"/v0/websets/{webset_id}/items", params=params, method="GET")
+        return ListWebsetItemResponse.model_validate(response)
+
+    def list_all(self, webset_id: str, *, limit: Optional[int] = None) -> Iterator[WebsetItem]:
+        """Iterate through all Items in a Webset, handling pagination automatically.
+        
+        Args:
+            webset_id (str): The id or externalId of the Webset.
+            limit (int, optional): The number of results to return per page (max 200).
+            
+        Yields:
+            WebsetItem: Each item in the webset.
+        """
+        cursor = None
+        while True:
+            response = self.list(webset_id, cursor=cursor, limit=limit)
+            for item in response.data:
+                yield item
+            
+            if not response.has_more or not response.next_cursor:
+                break
+                
+            cursor = response.next_cursor
+
+    def get(self, webset_id: str, id: str) -> WebsetItem:
+        """Get an Item by ID.
+        
+        Args:
+            webset_id (str): The id or externalId of the Webset.
+            id (str): The id of the Webset item.
+        
+        Returns:
+            WebsetItem: The retrieved item.
+        """
+        response = self.request(f"/v0/websets/{webset_id}/items/{id}", method="GET")
+        return WebsetItem.model_validate(response)
+
+    def delete(self, webset_id: str, id: str) -> WebsetItem:
+        """Delete an Item.
+        
+        Args:
+            webset_id (str): The id or externalId of the Webset.
+            id (str): The id of the Webset item.
+        
+        Returns:
+            WebsetItem: The deleted item.
+        """
+        response = self.request(f"/v0/websets/{webset_id}/items/{id}", method="DELETE")
+        return WebsetItem.model_validate(response) 

exa_py/websets/searches/__init__.py

@@ -0,0 +1,3 @@
+from .client import WebsetSearchesClient
+
+__all__ = ["WebsetSearchesClient"] 

exa_py/websets/searches/client.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from ..types import (
+    CreateWebsetSearchParameters,
+    WebsetSearch,
+)
+from ..core.base import WebsetsBaseClient
+
+class WebsetSearchesClient(WebsetsBaseClient):
+    """Client for managing Webset Searches."""
+    
+    def __init__(self, client):
+        super().__init__(client)
+
+    def create(self, webset_id: str, params: CreateWebsetSearchParameters) -> WebsetSearch:
+        """Create a new Search for the Webset.
+        
+        Args:
+            webset_id (str): The id of the Webset.
+            params (CreateWebsetSearchParameters): The parameters for creating a search.
+        
+        Returns:
+            WebsetSearch: The created search.
+        """
+        response = self.request(f"/v0/websets/{webset_id}/searches", data=params.model_dump(by_alias=True, exclude_none=True))
+        return WebsetSearch.model_validate(response)
+
+    def get(self, webset_id: str, id: str) -> WebsetSearch:
+        """Get a Search by ID.
+        
+        Args:
+            webset_id (str): The id of the Webset.
+            id (str): The id of the Search.
+        
+        Returns:
+            WebsetSearch: The retrieved search.
+        """
+        response = self.request(f"/v0/websets/{webset_id}/searches/{id}", method="GET")
+        return WebsetSearch.model_validate(response)
+
+    def cancel(self, webset_id: str, id: str) -> WebsetSearch:
+        """Cancel a running Search.
+        
+        Args:
+            webset_id (str): The id of the Webset.
+            id (str): The id of the Search.
+        
+        Returns:
+            WebsetSearch: The canceled search.
+        """
+        response = self.request(f"/v0/websets/{webset_id}/searches/{id}/cancel", method="POST")
+        return WebsetSearch.model_validate(response)