valentina-python-client 1.22.1__tar.gz → 2.0.0__tar.gz

{valentina_python_client-1.22.1 → valentina_python_client-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: valentina-python-client
-Version: 1.22.1
+Version: 2.0.0
 Summary: Async Python client library for the Valentina Noir API
 Author: Nate Landau
 Author-email: Nate Landau <github@natenate.org>
@@ -19,7 +19,7 @@ Requires-Dist: anyio>=4.13.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: pydantic[email]>=2.13.1
 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.22.1 → valentina_python_client-2.0.0}/pyproject.toml

@@ -9,14 +9,14 @@
         "httpx>=0.28.1",
         "loguru>=0.7.3",
         "polyfactory>=3.3.0",
-        "pydantic[email]>=2.12.5",
+        "pydantic[email]>=2.13.1",
     ]
     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.22.1"
+    version = "2.0.0"
 
     [project.optional-dependencies]
         testing = ["polyfactory>=3.3.0"]
@@ -34,10 +34,10 @@
 
 [dependency-groups]
     dev = [
-        "commitizen>=4.13.9",
+        "commitizen>=4.13.10",
         "coverage>=7.13.5",
         "duty>=1.9.0",
-        "prek>=0.3.8",
+        "prek>=0.3.9",
         "pytest-anyio>=0.0.0",
         "pytest-clarity>=1.0.1",
         "pytest-cov>=7.1.0",
@@ -46,16 +46,16 @@
         "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.10",
         "shellcheck-py>=0.11.0.1",
-        "ty>=0.0.29",
-        "typos>=1.45.0",
+        "ty>=0.0.31",
+        "typos>=1.45.1",
         "vulture>=2.16",
         "yamllint>=1.38.0",
     ]
-    docs = ["zensical>=0.0.31"]
+    docs = ["zensical>=0.0.33"]
 
 [tool.commitizen]
     bump_message               = "bump(release): v$current_version → v$new_version"

{valentina_python_client-1.22.1 → valentina_python_client-2.0.0}/src/vclient/__init__.py

@@ -50,6 +50,7 @@ from vclient._sync import (  # noqa: E402
     sync_options_service,
     sync_system_service,
     sync_user_lookup_service,
+    sync_user_self_registration_service,
     sync_users_service,
 )
 from vclient.client import VClient  # noqa: E402
@@ -69,6 +70,7 @@ from vclient.registry import (  # noqa: E402
     options_service,
     system_service,
     user_lookup_service,
+    user_self_registration_service,
     users_service,
 )
 
@@ -103,10 +105,12 @@ __all__ = (
     "sync_options_service",
     "sync_system_service",
     "sync_user_lookup_service",
+    "sync_user_self_registration_service",
     "sync_users_service",
     "system_service",
     "user_lookup_service",
+    "user_self_registration_service",
     "users_service",
 )
 
-__version__ = "1.22.1"
+__version__ = "2.0.0"

{valentina_python_client-1.22.1 → valentina_python_client-2.0.0}/src/vclient/_codegen.py

@@ -29,6 +29,7 @@ RENAME_CLASSES: dict[str, str] = {
     "OptionsService": "SyncOptionsService",
     "SystemService": "SyncSystemService",
     "UserLookupService": "SyncUserLookupService",
+    "UserSelfRegistrationService": "SyncUserSelfRegistrationService",
     "UsersService": "SyncUsersService",
     "VClient": "SyncVClient",
     "FakeVClient": "SyncFakeVClient",
@@ -51,6 +52,7 @@ FACTORY_RENAMES: dict[str, str] = {
     "options_service": "sync_options_service",
     "character_autogen_service": "sync_character_autogen_service",
     "user_lookup_service": "sync_user_lookup_service",
+    "user_self_registration_service": "sync_user_self_registration_service",
     "configure_default_client": "sync_configure_default_client",
     "clear_default_client": "sync_clear_default_client",
     "default_client": "sync_default_client",
@@ -76,6 +78,7 @@ IMPORT_REWRITES: dict[str, str] = {
     "vclient.services.options": "vclient._sync.services.options",
     "vclient.services.character_autogen": "vclient._sync.services.character_autogen",
     "vclient.services.user_lookup": "vclient._sync.services.user_lookup",
+    "vclient.services.user_self_registration": "vclient._sync.services.user_self_registration",
     "vclient.registry": "vclient._sync.registry",
     "vclient.testing._client": "vclient._sync.testing._client",
 }
@@ -311,6 +314,7 @@ def _write_sync_init(path: Path) -> None:
         "    sync_options_service,",
         "    sync_system_service,",
         "    sync_user_lookup_service,",
+        "    sync_user_self_registration_service,",
         "    sync_users_service,",
         ")",
         "",
@@ -334,6 +338,7 @@ def _write_sync_init(path: Path) -> None:
         '    "sync_options_service",',
         '    "sync_system_service",',
         '    "sync_user_lookup_service",',
+        '    "sync_user_self_registration_service",',
         '    "sync_users_service",',
         "]",
         "",

{valentina_python_client-1.22.1 → valentina_python_client-2.0.0}/src/vclient/_sync/__init__.py

@@ -20,6 +20,7 @@ from vclient._sync.registry import (
     sync_options_service,
     sync_system_service,
     sync_user_lookup_service,
+    sync_user_self_registration_service,
     sync_users_service,
 )
 
@@ -43,5 +44,6 @@ __all__ = [
     "sync_options_service",
     "sync_system_service",
     "sync_user_lookup_service",
+    "sync_user_self_registration_service",
     "sync_users_service",
 ]

{valentina_python_client-1.22.1 → valentina_python_client-2.0.0}/src/vclient/_sync/client.py

@@ -38,6 +38,7 @@ if TYPE_CHECKING:
         SyncOptionsService,
         SyncSystemService,
         SyncUserLookupService,
+        SyncUserSelfRegistrationService,
         SyncUsersService,
     )
 
@@ -293,13 +294,14 @@ class SyncVClient:
             self._user_lookup = SyncUserLookupService(self)
         return self._user_lookup
 
-    def users(self, company_id: str | None = None) -> "SyncUsersService":
+    def users(self, on_behalf_of: str, *, company_id: str | None = None) -> "SyncUsersService":
         """Get a SyncUsersService scoped to a specific company.
 
         Provides methods to create, retrieve, update, and delete users,
         as well as access user statistics and assets.
 
         Args:
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -310,27 +312,57 @@ class SyncVClient:
             ValueError: If no company_id provided and no default configured.
 
         Example:
-            >>> users = client.users("company_id")
+            >>> users = client.users("user_id", "company_id")
             >>> all_users = await users.list_all()
             >>> user = await users.get("user_id")
         """
         from vclient._sync.services.users import SyncUsersService
 
-        return SyncUsersService(self, self._resolve_company_id(company_id))
+        return SyncUsersService(
+            self, company_id=self._resolve_company_id(company_id), on_behalf_of=on_behalf_of
+        )
+
+    def user_self_registration(
+        self, *, company_id: str | None = None
+    ) -> "SyncUserSelfRegistrationService":
+        """Get a SyncUserSelfRegistrationService scoped to a specific company.
+
+        Handles user self-registration via SSO onboarding. Does not require
+        an acting user — only developer API key authentication.
+
+        Args:
+            company_id: The ID of the company to register users in. If not
+                provided, uses the default_company_id from config.
+
+        Returns:
+            A SyncUserSelfRegistrationService instance.
+
+        Raises:
+            ValueError: If no company_id provided and no default configured.
 
-    def campaigns(self, user_id: str, company_id: str | None = None) -> "SyncCampaignsService":
-        """Get a SyncCampaignsService scoped to a specific company and user.
+        Example:
+            >>> registration = client.user_self_registration()
+            >>> user = await registration.register(username="alice", email="a@b.com")
+        """
+        from vclient._sync.services.user_self_registration import SyncUserSelfRegistrationService
+
+        return SyncUserSelfRegistrationService(self, self._resolve_company_id(company_id))
+
+    def campaigns(
+        self, on_behalf_of: str, *, company_id: str | None = None
+    ) -> "SyncCampaignsService":
+        """Get a SyncCampaignsService scoped to a specific company.
 
         Provides methods to create, retrieve, update, and delete campaigns,
         as well as access campaign statistics, assets, and notes.
 
         Args:
-            user_id: The ID of the user to operate as.
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
         Returns:
-            A SyncCampaignsService instance scoped to the specified company and user.
+            A SyncCampaignsService instance scoped to the specified company.
 
         Raises:
             ValueError: If no company_id provided and no default configured.
@@ -342,19 +374,21 @@ class SyncVClient:
         """
         from vclient._sync.services.campaigns import SyncCampaignsService
 
-        return SyncCampaignsService(self, self._resolve_company_id(company_id), user_id)
+        return SyncCampaignsService(
+            self, company_id=self._resolve_company_id(company_id), on_behalf_of=on_behalf_of
+        )
 
     def books(
-        self, user_id: str, campaign_id: str, *, company_id: str | None = None
+        self, campaign_id: str, on_behalf_of: str, *, company_id: str | None = None
     ) -> "SyncBooksService":
-        """Get a SyncBooksService scoped to a specific company, user, and campaign.
+        """Get a SyncBooksService scoped to a specific company and campaign.
 
         Provides methods to create, retrieve, update, and delete campaign books,
         as well as access book notes and assets.
 
         Args:
-            user_id: The ID of the user to operate as.
             campaign_id: The ID of the campaign to operate within.
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -365,26 +399,31 @@ class SyncVClient:
             ValueError: If no company_id provided and no default configured.
 
         Example:
-            >>> books = client.books("user_id", "campaign_id")
+            >>> books = client.books("campaign_id", "user_id")
             >>> all_books = await books.list_all()
             >>> book = await books.get("book_id")
         """
         from vclient._sync.services.campaign_books import SyncBooksService
 
-        return SyncBooksService(self, self._resolve_company_id(company_id), user_id, campaign_id)
+        return SyncBooksService(
+            self,
+            company_id=self._resolve_company_id(company_id),
+            campaign_id=campaign_id,
+            on_behalf_of=on_behalf_of,
+        )
 
     def chapters(
-        self, user_id: str, campaign_id: str, book_id: str, *, company_id: str | None = None
+        self, campaign_id: str, book_id: str, on_behalf_of: str, *, company_id: str | None = None
     ) -> "SyncChaptersService":
-        """Get a SyncChaptersService scoped to a specific company, user, campaign, and book.
+        """Get a SyncChaptersService scoped to a specific company, campaign, and book.
 
         Provides methods to create, retrieve, update, and delete campaign book chapters,
         as well as access chapter notes and assets.
 
         Args:
-            user_id: The ID of the user to operate as.
             campaign_id: The ID of the campaign to operate within.
             book_id: The ID of the book to operate within.
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -395,27 +434,30 @@ class SyncVClient:
             ValueError: If no company_id provided and no default configured.
 
         Example:
-            >>> chapters = client.chapters("user_id", "campaign_id", "book_id")
+            >>> chapters = client.chapters("campaign_id", "book_id", "user_id")
             >>> all_chapters = await chapters.list_all()
             >>> chapter = await chapters.get("chapter_id")
         """
         from vclient._sync.services.campaign_book_chapters import SyncChaptersService
 
         return SyncChaptersService(
-            self, self._resolve_company_id(company_id), user_id, campaign_id, book_id
+            self,
+            company_id=self._resolve_company_id(company_id),
+            campaign_id=campaign_id,
+            book_id=book_id,
+            on_behalf_of=on_behalf_of,
         )
 
     def characters(
-        self, user_id: str, campaign_id: str, *, company_id: str | None = None
+        self, on_behalf_of: str, *, company_id: str | None = None
     ) -> "SyncCharactersService":
-        """Get a SyncCharactersService scoped to a specific company, user, and campaign.
+        """Get a SyncCharactersService scoped to a specific company.
 
-        Provides methods to create, retrieve, update, and delete characters within
-        a campaign.
+        Provides methods to create, retrieve, update, and delete characters.
+        Use the optional ``campaign_id`` filter on list methods to scope to a campaign.
 
         Args:
-            user_id: The ID of the user to operate as.
-            campaign_id: The ID of the campaign to operate within.
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -426,28 +468,27 @@ class SyncVClient:
             ValueError: If no company_id provided and no default configured.
 
         Example:
-            >>> characters = client.characters("user_id", "campaign_id")
+            >>> characters = client.characters("user_id")
             >>> all_characters = await characters.list_all()
             >>> character = await characters.get("character_id")
         """
         from vclient._sync.services.characters import SyncCharactersService
 
         return SyncCharactersService(
-            self, self._resolve_company_id(company_id), user_id, campaign_id
+            self, company_id=self._resolve_company_id(company_id), on_behalf_of=on_behalf_of
         )
 
     def character_traits(
-        self, user_id: str, campaign_id: str, character_id: str, *, company_id: str | None = None
+        self, character_id: str, on_behalf_of: str, *, company_id: str | None = None
     ) -> "SyncCharacterTraitsService":
-        """Get a SyncCharacterTraitsService scoped to a specific company, user, campaign, and character.
+        """Get a SyncCharacterTraitsService scoped to a specific company and character.
 
         Provides methods to create, retrieve, update, and delete character traits within
         a character.
 
         Args:
-            user_id: The ID of the user to operate as.
-            campaign_id: The ID of the campaign to operate within.
             character_id: The ID of the character to operate within.
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -458,23 +499,29 @@ class SyncVClient:
             ValueError: If no company_id provided and no default configured.
 
         Example:
-            >>> character_traits = client.character_traits("user_id", "campaign_id", "character_id")
+            >>> character_traits = client.character_traits("character_id", "user_id")
             >>> all_character_traits = await character_traits.list_all()
             >>> character_trait = await character_traits.get("character_trait_id")
         """
         from vclient._sync.services.character_traits import SyncCharacterTraitsService
 
         return SyncCharacterTraitsService(
-            self, self._resolve_company_id(company_id), user_id, campaign_id, character_id
+            self,
+            company_id=self._resolve_company_id(company_id),
+            character_id=character_id,
+            on_behalf_of=on_behalf_of,
         )
 
-    def character_blueprint(self, company_id: str | None = None) -> "SyncCharacterBlueprintService":
+    def character_blueprint(
+        self, on_behalf_of: str | None = None, *, company_id: str | None = None
+    ) -> "SyncCharacterBlueprintService":
         """Get a SyncCharacterBlueprintService scoped to a specific company.
 
         Provides methods to create, retrieve, update, and delete character blueprint sections,
         categories, and traits.
 
         Args:
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -483,14 +530,19 @@ class SyncVClient:
         """
         from vclient._sync.services.character_blueprint import SyncCharacterBlueprintService
 
-        return SyncCharacterBlueprintService(self, self._resolve_company_id(company_id))
+        return SyncCharacterBlueprintService(
+            self, company_id=self._resolve_company_id(company_id), on_behalf_of=on_behalf_of
+        )
 
-    def dictionary(self, company_id: str | None = None) -> "SyncDictionaryService":
+    def dictionary(
+        self, on_behalf_of: str | None = None, *, company_id: str | None = None
+    ) -> "SyncDictionaryService":
         """Get a SyncDictionaryService scoped to a specific company.
 
         Provides methods to create, retrieve, update, and delete dictionary terms.
 
         Args:
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -499,15 +551,19 @@ class SyncVClient:
         """
         from vclient._sync.services.dictionary import SyncDictionaryService
 
-        return SyncDictionaryService(self, self._resolve_company_id(company_id))
+        return SyncDictionaryService(
+            self, company_id=self._resolve_company_id(company_id), on_behalf_of=on_behalf_of
+        )
 
-    def dicerolls(self, user_id: str, company_id: str | None = None) -> "SyncDicerollService":
-        """Get a SyncDicerollService scoped to a specific company and user.
+    def dicerolls(
+        self, on_behalf_of: str, *, company_id: str | None = None
+    ) -> "SyncDicerollService":
+        """Get a SyncDicerollService scoped to a specific company.
 
         Provides methods to create, retrieve, and list dice rolls.
 
         Args:
-            user_id: The ID of the user to operate as.
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -516,14 +572,19 @@ class SyncVClient:
         """
         from vclient._sync.services.dicerolls import SyncDicerollService
 
-        return SyncDicerollService(self, self._resolve_company_id(company_id), user_id)
+        return SyncDicerollService(
+            self, company_id=self._resolve_company_id(company_id), on_behalf_of=on_behalf_of
+        )
 
-    def options(self, company_id: str | None = None) -> "SyncOptionsService":
+    def options(
+        self, on_behalf_of: str | None = None, *, company_id: str | None = None
+    ) -> "SyncOptionsService":
         """Get a SyncOptionsService scoped to a specific company.
 
         Provides methods to retrieve all options and enumerations for the api.
 
         Args:
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -532,18 +593,21 @@ class SyncVClient:
         """
         from vclient._sync.services.options import SyncOptionsService
 
-        return SyncOptionsService(self, self._resolve_company_id(company_id))
+        return SyncOptionsService(
+            self, company_id=self._resolve_company_id(company_id), on_behalf_of=on_behalf_of
+        )
 
     def character_autogen(
-        self, user_id: str, campaign_id: str, *, company_id: str | None = None
+        self, on_behalf_of: str, *, company_id: str | None = None
     ) -> "SyncCharacterAutogenService":
-        """Get a SyncCharacterAutogenService scoped to a specific company, user, and campaign.
+        """Get a SyncCharacterAutogenService scoped to a specific company.
 
-        Provides methods to create, retrieve, update, and delete character autogen.
+        Provides methods to autogenerate characters and manage chargen sessions.
+        Pass ``campaign_id`` directly to ``generate_character()`` and
+        ``start_chargen_session()`` to scope each call to a specific campaign.
 
         Args:
-            user_id: The ID of the user to operate as.
-            campaign_id: The ID of the campaign to operate within.
+            on_behalf_of: User ID to impersonate via On-Behalf-Of header.
             company_id: The ID of the company to operate within. If not provided,
                 uses the default_company_id from config.
 
@@ -553,5 +617,5 @@ class SyncVClient:
         from vclient._sync.services.character_autogen import SyncCharacterAutogenService
 
         return SyncCharacterAutogenService(
-            self, self._resolve_company_id(company_id), user_id, campaign_id
+            self, company_id=self._resolve_company_id(company_id), on_behalf_of=on_behalf_of
         )