valentina-python-client 1.23.0__tar.gz → 2.1.0__tar.gz

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: valentina-python-client
-Version: 1.23.0
+Version: 2.1.0
 Summary: Async Python client library for the Valentina Noir API
 Author: Nate Landau
 Author-email: Nate Landau <github@natenate.org>
@@ -15,11 +15,11 @@ License: MIT License
          THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: anyio>=4.13.0
+Requires-Dist: anyio>=4.13.0,<5.0.0
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: loguru>=0.7.3
-Requires-Dist: polyfactory>=3.3.0
-Requires-Dist: pydantic[email]>=2.12.5
+Requires-Dist: polyfactory>=3.3.0,<4.0.0
+Requires-Dist: pydantic[email]>=2.13.4,<3.0.0
 Requires-Dist: polyfactory>=3.3.0 ; extra == 'testing'
 Requires-Python: >=3.13
 Project-URL: Homepage, https://docs.valentina-noir.com/python-api-client/

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/pyproject.toml

@@ -5,18 +5,18 @@
         "Programming Language :: Python :: 3.14",
     ]
     dependencies = [
-        "anyio>=4.13.0",
+        "anyio>=4.13.0, <5.0.0",
         "httpx>=0.28.1",
         "loguru>=0.7.3",
-        "polyfactory>=3.3.0",
-        "pydantic[email]>=2.12.5",
+        "polyfactory>=3.3.0, <4.0.0",
+        "pydantic[email]>=2.13.4, <3.0.0",
     ]
     description = "Async Python client library for the Valentina Noir API"
     license = { file = "LICENSE" }
     name = "valentina-python-client"
     readme = "README.md"
     requires-python = ">=3.13"
-    version = "1.23.0"
+    version = "2.1.0"
 
     [project.optional-dependencies]
         testing = ["polyfactory>=3.3.0"]
@@ -27,35 +27,35 @@
 
 [build-system]
     build-backend = "uv_build"
-    requires      = ["uv_build>=0.9.26,<0.10.0"]
+    requires      = ["uv_build>=0.11.15,<0.12.0"]
 
 [tool.uv.build-backend]
     module-name = "vclient"
 
 [dependency-groups]
     dev = [
-        "commitizen>=4.13.9",
-        "coverage>=7.13.5",
+        "commitizen>=4.16.2",
+        "coverage>=7.14.0",
         "duty>=1.9.0",
-        "prek>=0.3.8",
+        "prek>=0.4.1",
         "pytest-anyio>=0.0.0",
         "pytest-clarity>=1.0.1",
         "pytest-cov>=7.1.0",
-        "pytest-devtools>=1.0.0",
+        "pytest-devtools>=1.2.0",
         "pytest-mock>=3.15.1",
         "pytest-repeat>=0.9.4",
         "pytest-sugar>=1.1.1",
         "pytest-xdist>=3.8.0",
-        "pytest>=9.0.2",
-        "respx>=0.22.0",
-        "ruff>=0.15.9",
+        "pytest>=9.0.3",
+        "respx>=0.23.1",
+        "ruff>=0.15.14",
         "shellcheck-py>=0.11.0.1",
-        "ty>=0.0.29",
-        "typos>=1.45.0",
+        "ty>=0.0.39",
+        "typos>=1.46.2",
         "vulture>=2.16",
         "yamllint>=1.38.0",
     ]
-    docs = ["zensical>=0.0.31"]
+    docs = ["zensical>=0.0.43"]
 
 [tool.commitizen]
     bump_message               = "bump(release): v$current_version → v$new_version"

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/src/vclient/__init__.py

@@ -113,4 +113,4 @@ __all__ = (
     "users_service",
 )
 
-__version__ = "1.23.0"
+__version__ = "2.1.0"

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/src/vclient/_sync/services/companies.py

@@ -115,7 +115,7 @@ class SyncCompaniesService(SyncBaseService):
             request: A CompanyCreate model, OR pass fields as keyword arguments.
             **kwargs: Fields for CompanyCreate if request is not provided.
                 Accepts: name (str, required), email (str, required),
-                description (str | None), settings (CompanySettings | None).
+                description (str | None), settings (CompanySettingsCreate | None).
 
         Returns:
             The newly created NewCompanyResponse object containing the company and admin user.
@@ -141,7 +141,7 @@ class SyncCompaniesService(SyncBaseService):
             request: A CompanyUpdate model, OR pass fields as keyword arguments.
             **kwargs: Fields for CompanyUpdate if request is not provided.
                 Accepts: name (str | None), email (str | None),
-                description (str | None), settings (CompanySettings | None).
+                description (str | None), settings (CompanySettingsUpdate | None).
 
         Returns:
             The updated Company object.

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/src/vclient/_sync/services/dicerolls.py

@@ -5,7 +5,7 @@ from collections.abc import Iterator
 from typing import TYPE_CHECKING
 
 from vclient._sync.services.base import SyncBaseService
-from vclient.constants import DEFAULT_PAGE_LIMIT
+from vclient.constants import DEFAULT_PAGE_LIMIT, CharacterType
 from vclient.endpoints import Endpoints
 from vclient.models import Diceroll, DicerollCreate, PaginatedResponse, _DicerollQuickrollCreate
 
@@ -40,15 +40,32 @@ class SyncDicerollService(SyncBaseService):
         userid: str | None = None,
         characterid: str | None = None,
         campaignid: str | None = None,
+        character_type: CharacterType | None = None,
     ) -> PaginatedResponse[Diceroll]:
-        """Retrieve a paginated page of dice rolls."""
+        """Retrieve a paginated page of dice rolls.
+
+        Args:
+            limit: Maximum number of items to return (0-100, default 10).
+            offset: Number of items to skip from the beginning (default 0).
+            userid: Filter by user ID.
+            characterid: Filter by character ID.
+            campaignid: Filter by campaign ID.
+            character_type: Filter by the associated character's type. Rolls with
+                no character are excluded when this filter is set.
+
+        Returns:
+            A PaginatedResponse containing Diceroll objects and pagination metadata.
+        """
         return self._get_paginated_as(
             self._format_endpoint(Endpoints.DICEROLLS),
             Diceroll,
             limit=limit,
             offset=offset,
             params=self._build_params(
-                userid=userid, characterid=characterid, campaignid=campaignid
+                userid=userid,
+                characterid=characterid,
+                campaignid=campaignid,
+                character_type=character_type,
             ),
         )
 
@@ -58,12 +75,27 @@ class SyncDicerollService(SyncBaseService):
         userid: str | None = None,
         characterid: str | None = None,
         campaignid: str | None = None,
+        character_type: CharacterType | None = None,
     ) -> list[Diceroll]:
-        """Retrieve all dice rolls."""
+        """Retrieve all dice rolls.
+
+        Args:
+            userid: Filter by user ID.
+            characterid: Filter by character ID.
+            campaignid: Filter by campaign ID.
+            character_type: Filter by the associated character's type. Rolls with
+                no character are excluded when this filter is set.
+
+        Returns:
+            A list of all Diceroll objects.
+        """
         return [
             diceroll
             for diceroll in self.iter_all(
-                userid=userid, characterid=characterid, campaignid=campaignid
+                userid=userid,
+                characterid=characterid,
+                campaignid=campaignid,
+                character_type=character_type,
             )
         ]
 
@@ -73,14 +105,30 @@ class SyncDicerollService(SyncBaseService):
         userid: str | None = None,
         characterid: str | None = None,
         campaignid: str | None = None,
+        character_type: CharacterType | None = None,
         limit: int = 100,
     ) -> Iterator[Diceroll]:
-        """Iterate through all dice rolls."""
+        """Iterate through all dice rolls.
+
+        Args:
+            userid: Filter by user ID.
+            characterid: Filter by character ID.
+            campaignid: Filter by campaign ID.
+            character_type: Filter by the associated character's type. Rolls with
+                no character are excluded when this filter is set.
+            limit: Items per page (default 100 for efficiency).
+
+        Yields:
+            Individual Diceroll objects.
+        """
         for item in self._iter_all_pages(
             self._format_endpoint(Endpoints.DICEROLLS),
             limit=limit,
             params=self._build_params(
-                userid=userid, characterid=characterid, campaignid=campaignid
+                userid=userid,
+                characterid=characterid,
+                campaignid=campaignid,
+                character_type=character_type,
             ),
         ):
             yield Diceroll.model_validate(item)

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/src/vclient/models/__init__.py

@@ -73,6 +73,8 @@ from .companies import (
     CompanyCreate,
     CompanyPermissions,
     CompanySettings,
+    CompanySettingsCreate,
+    CompanySettingsUpdate,
     CompanyUpdate,
     NewCompanyResponse,
     _GrantAccess as _GrantAccess,
@@ -177,6 +179,8 @@ __all__ = [
     "CompanyCreate",
     "CompanyPermissions",
     "CompanySettings",
+    "CompanySettingsCreate",
+    "CompanySettingsUpdate",
     "CompanyUpdate",
     "CreateAutogenerateDTO",
     "Developer",

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/src/vclient/models/companies.py

@@ -16,14 +16,46 @@ from vclient.models.users import User
 
 
 class CompanySettings(BaseModel):
-    """Settings configuration for a company.
+    """Company configuration settings as returned by the API.
 
-    Controls various permissions and configuration options for the company.
-    Used in both response and request contexts; defaults support partial updates.
+    Strict response model — every field is always populated by the server.
+    For partial create/update payloads, use CompanySettingsCreate or
+    CompanySettingsUpdate instead.
+    """
+
+    character_autogen_xp_cost: int
+    character_autogen_num_choices: int
+    character_autogen_starting_points: int
+    permission_manage_campaign: ManageCampaignPermission
+    permission_grant_xp: GrantXPPermission
+    permission_free_trait_changes: FreeTraitChangesPermission
+    permission_recoup_xp: RecoupXPPermission
+
+
+class CompanySettingsCreate(BaseModel):
+    """Partial CompanySettings payload for POST /companies.
+
+    All fields optional — the server applies defaults for anything omitted.
+    """
+
+    character_autogen_xp_cost: int | None = None
+    character_autogen_num_choices: int | None = None
+    character_autogen_starting_points: int | None = None
+    permission_manage_campaign: ManageCampaignPermission | None = None
+    permission_grant_xp: GrantXPPermission | None = None
+    permission_free_trait_changes: FreeTraitChangesPermission | None = None
+    permission_recoup_xp: RecoupXPPermission | None = None
+
+
+class CompanySettingsUpdate(BaseModel):
+    """Partial CompanySettings payload for PATCH /companies/{id}.
+
+    All fields optional — omitted fields remain unchanged on the server.
     """
 
     character_autogen_xp_cost: int | None = None
     character_autogen_num_choices: int | None = None
+    character_autogen_starting_points: int | None = None
     permission_manage_campaign: ManageCampaignPermission | None = None
     permission_grant_xp: GrantXPPermission | None = None
     permission_free_trait_changes: FreeTraitChangesPermission | None = None
@@ -86,7 +118,7 @@ class CompanyCreate(BaseModel):
     name: str = Field(min_length=3, max_length=50)
     email: str
     description: Annotated[str, Field(min_length=3)] | None = None
-    settings: CompanySettings | None = None
+    settings: CompanySettingsCreate | None = None
 
 
 class CompanyUpdate(BaseModel):
@@ -98,7 +130,7 @@ class CompanyUpdate(BaseModel):
     name: Annotated[str, Field(min_length=3, max_length=50)] | None = None
     email: str | None = None
     description: Annotated[str, Field(min_length=3)] | None = None
-    settings: CompanySettings | None = None
+    settings: CompanySettingsUpdate | None = None
 
 
 class _GrantAccess(BaseModel):
@@ -113,6 +145,8 @@ __all__ = [
     "CompanyCreate",
     "CompanyPermissions",
     "CompanySettings",
+    "CompanySettingsCreate",
+    "CompanySettingsUpdate",
     "CompanyUpdate",
     "NewCompanyResponse",
     "_GrantAccess",

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/src/vclient/models/system.py

@@ -7,9 +7,12 @@ class SystemHealth(BaseModel):
     """Response model for system health check.
 
     Represents the health status of the API and its dependencies including
-    database and cache connectivity.
+    database and cache connectivity, latency metrics, and uptime information.
     """
 
     database_status: str
     cache_status: str
+    database_latency_ms: float | None
+    cache_latency_ms: float | None
+    uptime: str
     version: str

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/src/vclient/services/companies.py

@@ -126,7 +126,7 @@ class CompaniesService(BaseService):
             request: A CompanyCreate model, OR pass fields as keyword arguments.
             **kwargs: Fields for CompanyCreate if request is not provided.
                 Accepts: name (str, required), email (str, required),
-                description (str | None), settings (CompanySettings | None).
+                description (str | None), settings (CompanySettingsCreate | None).
 
         Returns:
             The newly created NewCompanyResponse object containing the company and admin user.
@@ -157,7 +157,7 @@ class CompaniesService(BaseService):
             request: A CompanyUpdate model, OR pass fields as keyword arguments.
             **kwargs: Fields for CompanyUpdate if request is not provided.
                 Accepts: name (str | None), email (str | None),
-                description (str | None), settings (CompanySettings | None).
+                description (str | None), settings (CompanySettingsUpdate | None).
 
         Returns:
             The updated Company object.

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/src/vclient/services/dicerolls.py

@@ -3,7 +3,7 @@
 from collections.abc import AsyncIterator
 from typing import TYPE_CHECKING
 
-from vclient.constants import DEFAULT_PAGE_LIMIT
+from vclient.constants import DEFAULT_PAGE_LIMIT, CharacterType
 from vclient.endpoints import Endpoints
 from vclient.models import (
     Diceroll,
@@ -48,8 +48,22 @@ class DicerollService(BaseService):
         userid: str | None = None,
         characterid: str | None = None,
         campaignid: str | None = None,
+        character_type: CharacterType | None = None,
     ) -> PaginatedResponse[Diceroll]:
-        """Retrieve a paginated page of dice rolls."""
+        """Retrieve a paginated page of dice rolls.
+
+        Args:
+            limit: Maximum number of items to return (0-100, default 10).
+            offset: Number of items to skip from the beginning (default 0).
+            userid: Filter by user ID.
+            characterid: Filter by character ID.
+            campaignid: Filter by campaign ID.
+            character_type: Filter by the associated character's type. Rolls with
+                no character are excluded when this filter is set.
+
+        Returns:
+            A PaginatedResponse containing Diceroll objects and pagination metadata.
+        """
         return await self._get_paginated_as(
             self._format_endpoint(Endpoints.DICEROLLS),
             Diceroll,
@@ -59,6 +73,7 @@ class DicerollService(BaseService):
                 userid=userid,
                 characterid=characterid,
                 campaignid=campaignid,
+                character_type=character_type,
             ),
         )
 
@@ -68,12 +83,27 @@ class DicerollService(BaseService):
         userid: str | None = None,
         characterid: str | None = None,
         campaignid: str | None = None,
+        character_type: CharacterType | None = None,
     ) -> list[Diceroll]:
-        """Retrieve all dice rolls."""
+        """Retrieve all dice rolls.
+
+        Args:
+            userid: Filter by user ID.
+            characterid: Filter by character ID.
+            campaignid: Filter by campaign ID.
+            character_type: Filter by the associated character's type. Rolls with
+                no character are excluded when this filter is set.
+
+        Returns:
+            A list of all Diceroll objects.
+        """
         return [
             diceroll
             async for diceroll in self.iter_all(
-                userid=userid, characterid=characterid, campaignid=campaignid
+                userid=userid,
+                characterid=characterid,
+                campaignid=campaignid,
+                character_type=character_type,
             )
         ]
 
@@ -83,9 +113,22 @@ class DicerollService(BaseService):
         userid: str | None = None,
         characterid: str | None = None,
         campaignid: str | None = None,
+        character_type: CharacterType | None = None,
         limit: int = 100,
     ) -> AsyncIterator[Diceroll]:
-        """Iterate through all dice rolls."""
+        """Iterate through all dice rolls.
+
+        Args:
+            userid: Filter by user ID.
+            characterid: Filter by character ID.
+            campaignid: Filter by campaign ID.
+            character_type: Filter by the associated character's type. Rolls with
+                no character are excluded when this filter is set.
+            limit: Items per page (default 100 for efficiency).
+
+        Yields:
+            Individual Diceroll objects.
+        """
         async for item in self._iter_all_pages(
             self._format_endpoint(Endpoints.DICEROLLS),
             limit=limit,
@@ -93,6 +136,7 @@ class DicerollService(BaseService):
                 userid=userid,
                 characterid=characterid,
                 campaignid=campaignid,
+                character_type=character_type,
             ),
         ):
             yield Diceroll.model_validate(item)

{valentina_python_client-1.23.0 → valentina_python_client-2.1.0}/src/vclient/services/users.py

@@ -63,9 +63,7 @@ class UsersService(BaseService):
         """Format an endpoint with the scoped company_id plus any extra params."""
         return endpoint.format(company_id=self._company_id, **kwargs)
 
-    # -------------------------------------------------------------------------
     # Unapproved User Methods
-    # -------------------------------------------------------------------------
 
     async def get_unapproved_page(
         self,
@@ -202,9 +200,7 @@ class UsersService(BaseService):
         )
         return User.model_validate(response.json())
 
-    # -------------------------------------------------------------------------
     # User CRUD Methods
-    # -------------------------------------------------------------------------
 
     async def get_page(
         self,
@@ -445,9 +441,7 @@ class UsersService(BaseService):
         )
         return RollStatistics.model_validate(response.json())
 
-    # -------------------------------------------------------------------------
     # Asset Methods
-    # -------------------------------------------------------------------------
 
     async def get_assets_page(
         self,
@@ -604,9 +598,7 @@ class UsersService(BaseService):
         )
         return Asset.model_validate(response.json())
 
-    # -------------------------------------------------------------------------
     # Experience Methods
-    # -------------------------------------------------------------------------
 
     async def get_experience(
         self,
@@ -740,9 +732,7 @@ class UsersService(BaseService):
         )
         return CampaignExperience.model_validate(response.json())
 
-    # -------------------------------------------------------------------------
     # Notes Methods
-    # -------------------------------------------------------------------------
 
     async def get_notes_page(
         self,
@@ -931,9 +921,7 @@ class UsersService(BaseService):
             self._format_endpoint(Endpoints.USER_NOTE, user_id=user_id, note_id=note_id)
         )
 
-    # -------------------------------------------------------------------------
     # Quickroll Methods
-    # -------------------------------------------------------------------------
 
     async def get_quickrolls_page(
         self,