valentina-python-client 1.19.0__tar.gz → 1.20.1__tar.gz

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/PKG-INFO

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

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/pyproject.toml

@@ -16,7 +16,7 @@
     name = "valentina-python-client"
     readme = "README.md"
     requires-python = ">=3.13"
-    version = "1.19.0"
+    version = "1.20.1"
 
     [project.optional-dependencies]
         testing = ["polyfactory>=3.3.0"]

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/__init__.py

@@ -105,4 +105,4 @@ __all__ = (
     "users_service",
 )
 
-__version__ = "1.19.0"
+__version__ = "1.20.1"

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/_sync/services/campaign_book_chapters.py

@@ -2,15 +2,16 @@
 """Service for interacting with the Campaign Books Chapters API."""
 
 import mimetypes
-from collections.abc import Iterator
+from collections.abc import Iterator, Sequence
 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, ChapterInclude
 from vclient.endpoints import Endpoints
 from vclient.models import (
     Asset,
     CampaignChapter,
+    CampaignChapterDetail,
     ChapterCreate,
     ChapterUpdate,
     Note,
@@ -69,10 +70,31 @@ class SyncChaptersService(SyncBaseService):
         ):
             yield CampaignChapter.model_validate(item)
 
-    def get(self, chapter_id: str) -> CampaignChapter:
-        """Retrieve a specific campaign book chapter."""
-        response = self._get(self._format_endpoint(Endpoints.BOOK_CHAPTER, chapter_id=chapter_id))
-        return CampaignChapter.model_validate(response.json())
+    def get(
+        self, chapter_id: str, *, include: Sequence[ChapterInclude] | None = None
+    ) -> CampaignChapterDetail:
+        """Retrieve detailed information about a specific campaign book chapter.
+
+        Fetches the chapter and optionally embeds child resources directly in the
+        response, avoiding follow-up requests.
+
+        Args:
+            chapter_id: The ID of the chapter to retrieve.
+            include: Child resources to embed in the response. Valid values are
+                ``"notes"`` and ``"assets"``.
+
+        Returns:
+            The CampaignChapterDetail object with full details and any requested embeds.
+
+        Raises:
+            NotFoundError: If the chapter does not exist.
+            AuthorizationError: If you don't have access.
+        """
+        response = self._get(
+            self._format_endpoint(Endpoints.BOOK_CHAPTER, chapter_id=chapter_id),
+            params=self._build_params(include=list(include) if include else None),
+        )
+        return CampaignChapterDetail.model_validate(response.json())
 
     def create(self, request: ChapterCreate | None = None, **kwargs) -> CampaignChapter:
         """Create a new campaign book chapter.

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/_sync/services/campaign_books.py

@@ -2,17 +2,18 @@
 """Service for interacting with the Campaign Books API."""
 
 import mimetypes
-from collections.abc import Iterator
+from collections.abc import Iterator, Sequence
 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, BookInclude
 from vclient.endpoints import Endpoints
 from vclient.models import (
     Asset,
     BookCreate,
     BookUpdate,
     CampaignBook,
+    CampaignBookDetail,
     Note,
     NoteCreate,
     NoteUpdate,
@@ -116,23 +117,31 @@ class SyncBooksService(SyncBaseService):
         ):
             yield CampaignBook.model_validate(item)
 
-    def get(self, book_id: str) -> CampaignBook:
+    def get(
+        self, book_id: str, *, include: Sequence[BookInclude] | None = None
+    ) -> CampaignBookDetail:
         """Retrieve detailed information about a specific campaign book.
 
-        Fetches the book including its notes and assets.
+        Fetches the book and optionally embeds child resources directly in the
+        response, avoiding follow-up requests.
 
         Args:
             book_id: The ID of the book to retrieve.
+            include: Child resources to embed in the response. Valid values are
+                ``"chapters"``, ``"notes"``, and ``"assets"``.
 
         Returns:
-            The CampaignBook object with full details.
+            The CampaignBookDetail object with full details and any requested embeds.
 
         Raises:
             NotFoundError: If the book does not exist.
             AuthorizationError: If you don't have access.
         """
-        response = self._get(self._format_endpoint(Endpoints.CAMPAIGN_BOOK, book_id=book_id))
-        return CampaignBook.model_validate(response.json())
+        response = self._get(
+            self._format_endpoint(Endpoints.CAMPAIGN_BOOK, book_id=book_id),
+            params=self._build_params(include=list(include) if include else None),
+        )
+        return CampaignBookDetail.model_validate(response.json())
 
     def create(self, request: BookCreate | None = None, **kwargs) -> CampaignBook:
         """Create a new campaign book.

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/_sync/services/users.py

@@ -2,11 +2,11 @@
 """Service for interacting with the Users API."""
 
 import mimetypes
-from collections.abc import Iterator
+from collections.abc import Iterator, Sequence
 from typing import TYPE_CHECKING
 
 from vclient._sync.services.base import SyncBaseService
-from vclient.constants import DEFAULT_PAGE_LIMIT, UserRole
+from vclient.constants import DEFAULT_PAGE_LIMIT, UserInclude, UserRole
 from vclient.endpoints import Endpoints
 from vclient.models import (
     Asset,
@@ -23,6 +23,7 @@ from vclient.models import (
     UserApproveDTO,
     UserCreate,
     UserDenyDTO,
+    UserDetail,
     UserMergeDTO,
     UserRegisterDTO,
     UserUpdate,
@@ -64,13 +65,14 @@ class SyncUsersService(SyncBaseService):
         return endpoint.format(company_id=self._company_id, **kwargs)
 
     def get_unapproved_page(
-        self, *, limit: int = DEFAULT_PAGE_LIMIT, offset: int = 0
+        self, requesting_user_id: str, *, limit: int = DEFAULT_PAGE_LIMIT, offset: int = 0
     ) -> PaginatedResponse[User]:
         """Retrieve a paginated page of unapproved users within a company.
 
         Unapproved users have registered but have not yet been approved by an admin.
 
         Args:
+            requesting_user_id: ID of the user making the request (for permissions).
             limit: Maximum number of items to return (0-100, default 10).
             offset: Number of items to skip from the beginning (default 0).
 
@@ -78,40 +80,54 @@ class SyncUsersService(SyncBaseService):
             A PaginatedResponse containing User objects and pagination metadata.
         """
         return self._get_paginated_as(
-            self._format_endpoint(Endpoints.USERS_UNAPPROVED_LIST), User, limit=limit, offset=offset
+            self._format_endpoint(Endpoints.USERS_UNAPPROVED_LIST),
+            User,
+            limit=limit,
+            offset=offset,
+            params=self._build_params(requesting_user_id=requesting_user_id),
         )
 
-    def list_all_unapproved(self) -> list[User]:
+    def list_all_unapproved(self, requesting_user_id: str) -> list[User]:
         """Retrieve all unapproved users within a company.
 
         Automatically paginates through all results. Use `get_unapproved_page()` for
         paginated access or `iter_all_unapproved()` for memory-efficient streaming.
 
+        Args:
+            requesting_user_id: ID of the user making the request (for permissions).
+
         Returns:
             A list of all unapproved User objects.
         """
-        return [user for user in self.iter_all_unapproved()]
+        return [user for user in self.iter_all_unapproved(requesting_user_id)]
 
-    def iter_all_unapproved(self, *, limit: int = 100) -> Iterator[User]:
+    def iter_all_unapproved(self, requesting_user_id: str, *, limit: int = 100) -> Iterator[User]:
         """Iterate through all unapproved users within a company.
 
         Yields individual unapproved users, automatically fetching subsequent pages
         until all items have been retrieved.
 
         Args:
+            requesting_user_id: ID of the user making the request (for permissions).
             limit: Items per page (default 100 for efficiency).
 
         Yields:
             Individual User objects.
         """
         for item in self._iter_all_pages(
-            self._format_endpoint(Endpoints.USERS_UNAPPROVED_LIST), limit=limit
+            self._format_endpoint(Endpoints.USERS_UNAPPROVED_LIST),
+            limit=limit,
+            params=self._build_params(requesting_user_id=requesting_user_id),
         ):
             yield User.model_validate(item)
 
     def approve_user(self, user_id: str, role: UserRole, requesting_user_id: str) -> User:
         """Approve an unapproved user and assign them a role.
 
+        The assigned ``role`` is validated through the server-side role-assignment
+        hierarchy — for example, a STORYTELLER cannot approve a user directly to
+        ADMIN, and only ADMIN may approve a user to ADMIN or DEACTIVATED.
+
         Args:
             user_id: The ID of the unapproved user to approve.
             role: The role to assign to the approved user.
@@ -122,7 +138,8 @@ class SyncUsersService(SyncBaseService):
 
         Raises:
             NotFoundError: If the user does not exist.
-            AuthorizationError: If you don't have appropriate access.
+            AuthorizationError: If the requesting user lacks permission to assign
+                the requested role under the hierarchy.
         """
         body = UserApproveDTO(role=role, requesting_user_id=requesting_user_id)
         response = self._post(
@@ -251,23 +268,31 @@ class SyncUsersService(SyncBaseService):
         ):
             yield User.model_validate(item)
 
-    def get(self, user_id: str) -> User:
+    def get(self, user_id: str, *, include: Sequence[UserInclude] | None = None) -> UserDetail:
         """Retrieve detailed information about a specific user.
 
-        Fetches the user including their role, experience, and Discord profile.
+        Fetches the user and optionally embeds child resources directly in the
+        response, avoiding follow-up requests.
 
         Args:
             user_id: The ID of the user to retrieve.
+            include: Child resources to embed in the response. Valid values are
+                ``"quickrolls"``, ``"notes"``, ``"assets"``, and ``"characters"``.
+                ``"assets"`` returns assets attached to the user (not assets the user
+                uploaded). ``"characters"`` returns only characters the user plays.
 
         Returns:
-            The User object with full details.
+            The UserDetail object with full details and any requested embeds.
 
         Raises:
             NotFoundError: If the user does not exist.
             AuthorizationError: If you don't have access to the company.
         """
-        response = self._get(self._format_endpoint(Endpoints.USER, user_id=user_id))
-        return User.model_validate(response.json())
+        response = self._get(
+            self._format_endpoint(Endpoints.USER, user_id=user_id),
+            params=self._build_params(include=list(include) if include else None),
+        )
+        return UserDetail.model_validate(response.json())
 
     def create(self, request: UserCreate | None = None, **kwargs) -> User:
         """Create a new user within a company.
@@ -276,6 +301,10 @@ class SyncUsersService(SyncBaseService):
         is optional and is not used for authentication but is included for Discord bot
         integration.
 
+        The initial ``role`` cannot be ``UNAPPROVED`` (use :meth:`register` for SSO
+        onboarding) or ``DEACTIVATED`` (not a creation path); either will surface as
+        ``ValidationError``.
+
         Args:
             request: A UserCreate model, OR pass fields as keyword arguments.
             **kwargs: Fields for UserCreate if request is not provided.
@@ -332,6 +361,14 @@ class SyncUsersService(SyncBaseService):
 
         Only include fields that need to be changed; omitted fields remain unchanged.
 
+        Setting ``role="DEACTIVATED"`` is the canonical way to deactivate a user:
+        the account can no longer log in or act, but their characters, assets, XP,
+        and notes remain intact and manageable by other users. Reactivate by calling
+        this same endpoint with any other valid role. Role changes are subject to a
+        server-side role-assignment hierarchy (e.g. only ADMIN may assign or remove
+        ADMIN/DEACTIVATED) and the server refuses to demote or deactivate the last
+        remaining active admin.
+
         Args:
             user_id: The ID of the user to update.
             request: A UserUpdate model, OR pass fields as keyword arguments.
@@ -345,7 +382,9 @@ class SyncUsersService(SyncBaseService):
 
         Raises:
             NotFoundError: If the user does not exist.
-            AuthorizationError: If you don't have appropriate access.
+            AuthorizationError: If the requesting user lacks permission to make
+                the change or to assign the requested role under the hierarchy.
+            ConflictError: If the change would remove the last active admin.
             RequestValidationError: If the input parameters fail client-side validation.
             ValidationError: If the request data is invalid.
         """

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/constants.py

@@ -38,6 +38,9 @@ AbilityFocus = Literal["JACK_OF_ALL_TRADES", "BALANCED", "SPECIALIST"]
 AutoGenExperienceLevel = Literal["NEW", "INTERMEDIATE", "ADVANCED", "ELITE"]
 CharacterClass = Literal["VAMPIRE", "WEREWOLF", "MAGE", "HUNTER", "GHOUL", "MORTAL"]
 CharacterInclude = Literal["traits", "inventory", "notes", "assets"]
+BookInclude = Literal["chapters", "notes", "assets"]
+ChapterInclude = Literal["notes", "assets"]
+UserInclude = Literal["quickrolls", "notes", "assets", "characters"]
 CharacterInventoryType = Literal[
     "BOOK",
     "CONSUMABLE",
@@ -56,10 +59,11 @@ HunterCreed = Literal["ENTREPRENEURIAL", "FAITHFUL", "INQUISITIVE", "MARTIAL", "
 HunterEdgeType = Literal["ASSETS", "APTITUDES", "ENDOWMENTS"]
 ManageCampaignPermission = Literal["UNRESTRICTED", "STORYTELLER"]
 PermissionLevel = Literal["USER", "ADMIN", "OWNER", "REVOKE"]
+RecoupXPPermission = Literal["UNRESTRICTED", "DENIED", "WITHIN_SESSION"]
 RollResultType = Literal["SUCCESS", "FAILURE", "BOTCH", "CRITICAL", "OTHER"]
 AssetType = Literal["image", "text", "audio", "video", "document", "archive", "other"]
 SpecialtyType = Literal["ACTION", "OTHER", "PASSIVE", "RITUAL", "SPELL"]
-UserRole = Literal["ADMIN", "STORYTELLER", "PLAYER", "UNAPPROVED"]
+UserRole = Literal["ADMIN", "STORYTELLER", "PLAYER", "UNAPPROVED", "DEACTIVATED"]
 WerewolfRenown = Literal["HONOR", "GLORY", "WISDOM"]
 BlueprintTraitOrderBy = Literal["NAME", "SHEET"]
 TraitModifyCurrency = Literal["XP", "STARTING_POINTS", "NO_COST"]

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/models/__init__.py

@@ -5,6 +5,7 @@ from .books import (
     BookCreate,
     BookUpdate,
     CampaignBook,
+    CampaignBookDetail,
     _BookRenumber as _BookRenumber,
 )
 from .campaigns import (
@@ -14,6 +15,7 @@ from .campaigns import (
 )
 from .chapters import (
     CampaignChapter,
+    CampaignChapterDetail,
     ChapterCreate,
     ChapterUpdate,
     _ChapterRenumber as _ChapterRenumber,
@@ -126,6 +128,7 @@ from .users import (
     UserApproveDTO,
     UserCreate,
     UserDenyDTO,
+    UserDetail,
     UserMergeDTO,
     UserRegisterDTO,
     UserUpdate,
@@ -141,7 +144,9 @@ __all__ = [
     "BulkAssignTraitSuccess",
     "Campaign",
     "CampaignBook",
+    "CampaignBookDetail",
     "CampaignChapter",
+    "CampaignChapterDetail",
     "CampaignCreate",
     "CampaignExperience",
     "CampaignUpdate",
@@ -215,6 +220,7 @@ __all__ = [
     "UserApproveDTO",
     "UserCreate",
     "UserDenyDTO",
+    "UserDetail",
     "UserMergeDTO",
     "UserRegisterDTO",
     "UserUpdate",

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/models/books.py

@@ -4,6 +4,9 @@ from datetime import datetime
 
 from pydantic import BaseModel, Field
 
+from vclient.models.chapters import CampaignChapter
+from vclient.models.shared import Asset, Note
+
 
 class CampaignBook(BaseModel):
     """Response model for a campaign book.
@@ -21,6 +24,25 @@ class CampaignBook(BaseModel):
     campaign_id: str = Field(..., description="ID of the parent campaign.")
 
 
+class CampaignBookDetail(CampaignBook):
+    """Campaign book response with optional embedded child resources.
+
+    Returned by the single-book endpoint when the ``include`` query parameter
+    is used. Absent resources default to ``None``; present resources are full arrays
+    of the same DTOs returned by the dedicated child endpoints.
+    """
+
+    chapters: list[CampaignChapter] | None = Field(
+        default=None, description="Embedded chapters, when requested via include."
+    )
+    notes: list[Note] | None = Field(
+        default=None, description="Embedded notes, when requested via include."
+    )
+    assets: list[Asset] | None = Field(
+        default=None, description="Embedded assets, when requested via include."
+    )
+
+
 class BookCreate(BaseModel):
     """Request body for creating a new campaign book.
 
@@ -60,5 +82,6 @@ __all__ = [
     "BookCreate",
     "BookUpdate",
     "CampaignBook",
+    "CampaignBookDetail",
     "_BookRenumber",
 ]

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/models/chapters.py

@@ -4,6 +4,8 @@ from datetime import datetime
 
 from pydantic import BaseModel, Field
 
+from vclient.models.shared import Asset, Note
+
 
 class CampaignChapter(BaseModel):
     """Response model for a campaign chapter.
@@ -23,6 +25,22 @@ class CampaignChapter(BaseModel):
     book_id: str = Field(..., description="ID of the parent book.")
 
 
+class CampaignChapterDetail(CampaignChapter):
+    """Campaign chapter response with optional embedded child resources.
+
+    Returned by the single-chapter endpoint when the ``include`` query parameter
+    is used. Absent resources default to ``None``; present resources are full arrays
+    of the same DTOs returned by the dedicated child endpoints.
+    """
+
+    notes: list[Note] | None = Field(
+        default=None, description="Embedded notes, when requested via include."
+    )
+    assets: list[Asset] | None = Field(
+        default=None, description="Embedded assets, when requested via include."
+    )
+
+
 class ChapterCreate(BaseModel):
     """Request body for creating a new campaign chapter."""
 
@@ -45,6 +63,7 @@ class _ChapterRenumber(BaseModel):
 
 __all__ = [
     "CampaignChapter",
+    "CampaignChapterDetail",
     "ChapterCreate",
     "ChapterUpdate",
     "_ChapterRenumber",

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/models/characters.py

@@ -152,12 +152,8 @@ class Character(BaseModel):
     """
 
     id: str = Field(..., description="MongoDB document ObjectID.")
-    date_created: datetime | None = Field(
-        default=None, description="Timestamp when the character was created."
-    )
-    date_modified: datetime | None = Field(
-        default=None, description="Timestamp when the character was last modified."
-    )
+    date_created: datetime
+    date_modified: datetime
     date_killed: datetime | None = Field(
         default=None, description="Timestamp when the character was killed."
     )

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/models/companies.py

@@ -10,6 +10,7 @@ from vclient.constants import (
     GrantXPPermission,
     ManageCampaignPermission,
     PermissionLevel,
+    RecoupXPPermission,
 )
 from vclient.models.users import User
 
@@ -26,6 +27,7 @@ class CompanySettings(BaseModel):
     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 Company(BaseModel):
@@ -41,7 +43,7 @@ class Company(BaseModel):
     description: str | None
     email: str
     resources_modified_at: datetime
-    settings: CompanySettings | None
+    settings: CompanySettings
 
 
 class CompanyPermissions(BaseModel):

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/models/users.py

@@ -6,6 +6,8 @@ from typing import Annotated
 from pydantic import BaseModel, Field
 
 from vclient.constants import UserRole
+from vclient.models.characters import Character
+from vclient.models.shared import Asset, Note
 
 # -----------------------------------------------------------------------------
 # Nested/Shared Models
@@ -96,6 +98,30 @@ class User(BaseModel):
     lifetime_cool_points: int = 0
 
 
+class UserDetail(User):
+    """User response with optional embedded child resources.
+
+    Returned by the single-user endpoint when the ``include`` query parameter
+    is used. Absent resources default to ``None``; present resources are full arrays.
+
+    Note: ``assets`` returns assets attached to the user (not assets the user
+    uploaded), and ``characters`` returns only characters the user plays.
+    """
+
+    quickrolls: list["Quickroll"] | None = Field(
+        default=None, description="Embedded quickrolls, when requested via include."
+    )
+    notes: list[Note] | None = Field(
+        default=None, description="Embedded notes attached to the user."
+    )
+    assets: list[Asset] | None = Field(
+        default=None, description="Embedded assets attached to the user."
+    )
+    characters: list[Character] | None = Field(
+        default=None, description="Embedded characters the user plays."
+    )
+
+
 # -----------------------------------------------------------------------------
 # User Request Models
 # -----------------------------------------------------------------------------
@@ -205,6 +231,9 @@ class Quickroll(BaseModel):
     trait_ids: list[str] = Field(default_factory=list)
 
 
+UserDetail.model_rebuild()
+
+
 class QuickrollCreate(BaseModel):
     """Request body for creating a new quickroll.
 
@@ -253,6 +282,7 @@ __all__ = [
     "QuickrollUpdate",
     "User",
     "UserCreate",
+    "UserDetail",
     "UserMergeDTO",
     "UserRegisterDTO",
     "UserUpdate",

{valentina_python_client-1.19.0 → valentina_python_client-1.20.1}/src/vclient/services/campaign_book_chapters.py

@@ -1,14 +1,15 @@
 """Service for interacting with the Campaign Books Chapters API."""
 
 import mimetypes
-from collections.abc import AsyncIterator
+from collections.abc import AsyncIterator, Sequence
 from typing import TYPE_CHECKING
 
-from vclient.constants import DEFAULT_PAGE_LIMIT
+from vclient.constants import DEFAULT_PAGE_LIMIT, ChapterInclude
 from vclient.endpoints import Endpoints
 from vclient.models import (
     Asset,
     CampaignChapter,
+    CampaignChapterDetail,
     ChapterCreate,
     ChapterUpdate,
     Note,
@@ -80,12 +81,34 @@ class ChaptersService(BaseService):
         ):
             yield CampaignChapter.model_validate(item)
 
-    async def get(self, chapter_id: str) -> CampaignChapter:
-        """Retrieve a specific campaign book chapter."""
+    async def get(
+        self,
+        chapter_id: str,
+        *,
+        include: Sequence[ChapterInclude] | None = None,
+    ) -> CampaignChapterDetail:
+        """Retrieve detailed information about a specific campaign book chapter.
+
+        Fetches the chapter and optionally embeds child resources directly in the
+        response, avoiding follow-up requests.
+
+        Args:
+            chapter_id: The ID of the chapter to retrieve.
+            include: Child resources to embed in the response. Valid values are
+                ``"notes"`` and ``"assets"``.
+
+        Returns:
+            The CampaignChapterDetail object with full details and any requested embeds.
+
+        Raises:
+            NotFoundError: If the chapter does not exist.
+            AuthorizationError: If you don't have access.
+        """
         response = await self._get(
-            self._format_endpoint(Endpoints.BOOK_CHAPTER, chapter_id=chapter_id)
+            self._format_endpoint(Endpoints.BOOK_CHAPTER, chapter_id=chapter_id),
+            params=self._build_params(include=list(include) if include else None),
         )
-        return CampaignChapter.model_validate(response.json())
+        return CampaignChapterDetail.model_validate(response.json())
 
     async def create(
         self,