valentina-python-client 1.5.2__tar.gz → 1.6.0__tar.gz

{valentina_python_client-1.5.2 → valentina_python_client-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: valentina-python-client
-Version: 1.5.2
+Version: 1.6.0
 Summary: Async Python client library for the Valentina Noir API
 Author: Nate Landau
 Author-email: Nate Landau <github@natenate.org>

{valentina_python_client-1.5.2 → valentina_python_client-1.6.0}/pyproject.toml

@@ -10,7 +10,7 @@
     name = "valentina-python-client"
     readme = "README.md"
     requires-python = ">=3.13"
-    version = "1.5.2"
+    version = "1.6.0"
 
     [project.urls]
         Homepage   = "https://docs.valentina-noir.com/python-api-client/"

{valentina_python_client-1.5.2 → valentina_python_client-1.6.0}/src/vclient/__init__.py

@@ -71,4 +71,4 @@ __all__ = (
     "users_service",
 )
 
-__version__ = "1.5.2"
+__version__ = "1.6.0"

{valentina_python_client-1.5.2 → valentina_python_client-1.6.0}/src/vclient/endpoints.py

@@ -32,6 +32,7 @@ class Endpoints:
     COMPANIES = f"{_BASE}/companies"
     COMPANY = f"{COMPANIES}/{{company_id}}"
     COMPANY_ACCESS = f"{COMPANY}/access"
+    COMPANY_STATISTICS = f"{COMPANY}/statistics"
 
     # User endpoints
     USERS = f"{COMPANY}/users"

{valentina_python_client-1.5.2 → valentina_python_client-1.6.0}/src/vclient/services/companies.py

@@ -11,6 +11,7 @@ from vclient.models import (
     CompanyUpdate,
     NewCompanyResponse,
     PaginatedResponse,
+    RollStatistics,
     _GrantAccess,
 )
 from vclient.services.base import BaseService
@@ -213,3 +214,31 @@ class CompaniesService(BaseService):
             json=body.model_dump(mode="json"),
         )
         return CompanyPermissions.model_validate(response.json())
+
+    async def get_statistics(
+        self,
+        company_id: str,
+        *,
+        num_top_traits: int = 5,
+    ) -> RollStatistics:
+        """Retrieve aggregated dice roll statistics for a specific company.
+
+        Includes success rates, critical frequencies, most-used traits, etc.
+        across all users and campaigns in the company.
+
+        Args:
+            company_id: The ID of the company to get statistics for.
+            num_top_traits: Number of top traits to include (default 5).
+
+        Returns:
+            RollStatistics object with aggregated statistics.
+
+        Raises:
+            NotFoundError: If the company does not exist.
+            AuthorizationError: If you don't have access to the company.
+        """
+        response = await self._get(
+            Endpoints.COMPANY_STATISTICS.format(company_id=company_id),
+            params={"num_top_traits": num_top_traits},
+        )
+        return RollStatistics.model_validate(response.json())