glpi-python-client 0.6.4__py3-none-any.whl → 0.6.6__py3-none-any.whl

glpi_python_client/__init__.py

@@ -40,6 +40,7 @@ from glpi_python_client.models import (
     DeleteDocument,
     DeleteEntity,
     DeleteFollowup,
+    DeleteGroup,
     DeleteKBArticle,
     DeleteKBArticleComment,
     DeleteKBCategory,
@@ -60,6 +61,7 @@ from glpi_python_client.models import (
     GetDocumentItem,
     GetEntity,
     GetFollowup,
+    GetGroup,
     GetKBArticle,
     GetKBArticleComment,
     GetKBArticleRevision,
@@ -96,6 +98,7 @@ from glpi_python_client.models import (
     PatchDocument,
     PatchEntity,
     PatchFollowup,
+    PatchGroup,
     PatchKBArticle,
     PatchKBArticleComment,
     PatchKBCategory,
@@ -114,6 +117,7 @@ from glpi_python_client.models import (
     PostDocument,
     PostEntity,
     PostFollowup,
+    PostGroup,
     PostKBArticle,
     PostKBArticleComment,
     PostKBCategory,
@@ -133,7 +137,7 @@ from glpi_python_client.rsql import (
     date_window,
 )
 
-__version__ = "0.6.4"
+__version__ = "0.6.6"
 
 __all__ = [
     "AsyncGlpiClient",
@@ -145,6 +149,7 @@ __all__ = [
     "DeleteDocument",
     "DeleteEntity",
     "DeleteFollowup",
+    "DeleteGroup",
     "DeleteKBArticle",
     "DeleteKBArticleComment",
     "DeleteKBCategory",
@@ -165,6 +170,7 @@ __all__ = [
     "GetDocumentItem",
     "GetEntity",
     "GetFollowup",
+    "GetGroup",
     "GetKBArticle",
     "GetKBArticleComment",
     "GetKBArticleRevision",
@@ -212,6 +218,7 @@ __all__ = [
     "PatchDocument",
     "PatchEntity",
     "PatchFollowup",
+    "PatchGroup",
     "PatchKBArticle",
     "PatchKBArticleComment",
     "PatchKBCategory",
@@ -230,6 +237,7 @@ __all__ = [
     "PostDocument",
     "PostEntity",
     "PostFollowup",
+    "PostGroup",
     "PostKBArticle",
     "PostKBArticleComment",
     "PostKBCategory",

glpi_python_client/_async/clients/api/__init__.py

@@ -11,6 +11,7 @@ from __future__ import annotations
 
 from glpi_python_client._async.clients.api.administration import (
     EntityMixin,
+    GroupMixin,
     UserMixin,
 )
 from glpi_python_client._async.clients.api.assets import ComputerMixin
@@ -49,6 +50,7 @@ __all__ = [
     "DocumentMixin",
     "EntityMixin",
     "FollowupMixin",
+    "GroupMixin",
     "KBArticleCommentMixin",
     "KBArticleMixin",
     "KBArticleRevisionMixin",

glpi_python_client/_async/clients/api/administration/__init__.py

@@ -1,6 +1,6 @@
 """GLPI ``/Administration`` mixins for the GLPI client.
 
-The submodules expose the user and entity mixins used by this tree's
+The submodules expose the user, entity and group mixins used by this tree's
 client -- :class:`glpi_python_client.AsyncGlpiClient` on the async
 surface, :class:`glpi_python_client.GlpiClient` on the generated one.
 """
@@ -8,6 +8,7 @@ surface, :class:`glpi_python_client.GlpiClient` on the generated one.
 from __future__ import annotations
 
 from glpi_python_client._async.clients.api.administration._entity import EntityMixin
+from glpi_python_client._async.clients.api.administration._group import GroupMixin
 from glpi_python_client._async.clients.api.administration._user import UserMixin
 
-__all__ = ["EntityMixin", "UserMixin"]
+__all__ = ["EntityMixin", "GroupMixin", "UserMixin"]

glpi_python_client/_async/clients/api/administration/_group.py

@@ -0,0 +1,218 @@
+"""GLPI ``/Administration/Group`` mixin.
+
+The mixin exposes search, fetch, create, update, and delete helpers for the
+GLPI group resource. Every call sends the client's ``GLPI-Entity`` header
+(and the profile and recursion headers that travel with it) except where a
+search is told to skip it with ``skip_entity=True``.
+"""
+
+from __future__ import annotations
+
+from collections.abc import AsyncIterator
+
+from glpi_python_client._async.clients.commons._constants import GROUP_ENDPOINT, GlpiId
+from glpi_python_client._async.clients.commons._transport import TransportMixin
+from glpi_python_client.models.api_schema.administration._group import (
+    DeleteGroup,
+    GetGroup,
+    PatchGroup,
+    PostGroup,
+)
+
+
+class GroupMixin(TransportMixin):
+    """CRUD helpers for ``/Administration/Group``."""
+
+    async def search_groups(
+        self,
+        rsql_filter: str = "",
+        *,
+        limit: int = 50,
+        start: int = 0,
+        skip_entity: bool = False,
+    ) -> list[GetGroup]:
+        """Search GLPI groups with an optional RSQL filter.
+
+        Parameters
+        ----------
+        rsql_filter : str, optional
+            Raw RSQL filter forwarded as the ``filter`` query parameter,
+            for example ``"name==Support"``. Empty by default.
+        limit : int, optional
+            Maximum number of records returned by the GLPI server.
+        start : int, optional
+            Zero-based offset of the first record returned.
+        skip_entity : bool, optional
+            When ``True`` the ``GLPI-Entity`` header is omitted so the
+            search spans every entity the caller has access to.
+
+        Returns
+        -------
+        list[GetGroup]
+            Groups matching the filter.
+        """
+
+        params: dict[str, object] = {"limit": limit, "start": start}
+        if rsql_filter:
+            params["filter"] = rsql_filter
+        return await self._resource_list(
+            GROUP_ENDPOINT, GetGroup, params=params, skip_entity=skip_entity
+        )
+
+    async def iter_search_groups(
+        self,
+        rsql_filter: str = "",
+        *,
+        batch_size: int = 50,
+        skip_entity: bool = False,
+    ) -> AsyncIterator[list[GetGroup]]:
+        """Yield successive pages of GLPI groups until exhausted.
+
+        Pagination advances the ``start`` offset after each batch and stops
+        when the server returns fewer items than ``batch_size``.
+
+        Parameters
+        ----------
+        rsql_filter : str, optional
+            Raw RSQL filter forwarded as the ``filter`` query parameter.
+        batch_size : int, optional
+            Number of records requested per page (default 50).
+        skip_entity : bool, optional
+            When ``True`` the ``GLPI-Entity`` header is omitted so the
+            search spans every entity the caller has access to.
+
+        Yields
+        ------
+        list[GetGroup]
+            One page of groups per iteration. The last yielded batch may
+            be shorter than ``batch_size``.
+        """
+
+        start = 0
+        while True:
+            batch = await self.search_groups(
+                rsql_filter,
+                limit=batch_size,
+                start=start,
+                skip_entity=skip_entity,
+            )
+            if batch:
+                yield batch
+            if len(batch) < batch_size:
+                break
+            start += batch_size
+
+    async def get_group(self, group_id: GlpiId) -> GetGroup:
+        """Fetch one GLPI group by identifier.
+
+        Parameters
+        ----------
+        group_id : GlpiId
+            Numeric identifier of the group to retrieve.
+
+        Returns
+        -------
+        GetGroup
+            Validated group payload.
+
+        Raises
+        ------
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        return await self._resource_get(
+            f"{GROUP_ENDPOINT}/{group_id}",
+            GetGroup,
+            failure_message=f"Failed to get group {group_id}",
+        )
+
+    async def create_group(self, group: PostGroup) -> int:
+        """Create one GLPI group.
+
+        Parameters
+        ----------
+        group : PostGroup
+            Request body describing the group to create.
+
+        Returns
+        -------
+        int
+            Identifier assigned by the GLPI server.
+
+        Raises
+        ------
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        GlpiProtocolError
+            If the create response is missing the ``id`` field.
+        """
+
+        return await self._resource_create(
+            GROUP_ENDPOINT,
+            group,
+            failure_message="Failed to create group",
+            missing_message="GLPI group create response did not include an ID",
+            log_message_factory=lambda new_id: f"GLPI API created group {new_id}",
+        )
+
+    async def update_group(self, group_id: GlpiId, group: PatchGroup) -> None:
+        """Update one GLPI group with a partial body.
+
+        Parameters
+        ----------
+        group_id : GlpiId
+            Numeric identifier of the group to update.
+        group : PatchGroup
+            Partial request body.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        await self._resource_update(
+            f"{GROUP_ENDPOINT}/{group_id}",
+            group,
+            failure_message=f"Failed to update group {group_id}",
+            log_message=f"GLPI API updated group {group_id}",
+        )
+
+    async def delete_group(
+        self, group_id: GlpiId, *, force: bool | None = None
+    ) -> None:
+        """Delete one GLPI group by identifier.
+
+        Parameters
+        ----------
+        group_id : GlpiId
+            Numeric identifier of the group to delete.
+        force : bool | None, optional
+            When ``True`` the group is permanently deleted instead of
+            being moved to the trash.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        await self._resource_delete(
+            f"{GROUP_ENDPOINT}/{group_id}",
+            failure_message=f"Failed to delete group {group_id}",
+            log_message=f"GLPI API deleted group {group_id}",
+            force=force,
+            delete_model_cls=DeleteGroup,
+        )
+
+
+__all__ = ["GroupMixin"]

glpi_python_client/_async/clients/client.py

@@ -25,6 +25,7 @@ from glpi_python_client._async.clients.api import (
     DocumentMixin,
     EntityMixin,
     FollowupMixin,
+    GroupMixin,
     KBArticleCommentMixin,
     KBArticleMixin,
     KBArticleRevisionMixin,
@@ -59,6 +60,7 @@ class AsyncGlpiClient(
     ComputerMixin,
     UserMixin,
     EntityMixin,
+    GroupMixin,
     LocationMixin,
     ContractTypeMixin,
     KBCategoryMixin,

glpi_python_client/_async/clients/commons/_constants.py

@@ -19,6 +19,7 @@ COMPUTER_ENDPOINT = "Assets/Computer"
 # administration/
 USER_ENDPOINT = "Administration/User"
 ENTITY_ENDPOINT = "Administration/Entity"
+GROUP_ENDPOINT = "Administration/Group"
 
 # dropdowns/
 CONTRACT_TYPE_ENDPOINT = "Dropdowns/ContractType"
@@ -52,6 +53,7 @@ __all__ = [
     "DOCUMENT_ENDPOINT",
     "ENTITY_ENDPOINT",
     "FOLLOWUP_SUFFIX",
+    "GROUP_ENDPOINT",
     "KB_ARTICLE_ENDPOINT",
     "KB_CATEGORY_ENDPOINT",
     "KB_COMMENT_SUFFIX",

glpi_python_client/_sync/clients/api/__init__.py

@@ -11,6 +11,7 @@ from __future__ import annotations
 
 from glpi_python_client._sync.clients.api.administration import (
     EntityMixin,
+    GroupMixin,
     UserMixin,
 )
 from glpi_python_client._sync.clients.api.assets import ComputerMixin
@@ -49,6 +50,7 @@ __all__ = [
     "DocumentMixin",
     "EntityMixin",
     "FollowupMixin",
+    "GroupMixin",
     "KBArticleCommentMixin",
     "KBArticleMixin",
     "KBArticleRevisionMixin",

glpi_python_client/_sync/clients/api/administration/__init__.py

@@ -1,6 +1,6 @@
 """GLPI ``/Administration`` mixins for the GLPI client.
 
-The submodules expose the user and entity mixins used by this tree's
+The submodules expose the user, entity and group mixins used by this tree's
 client -- :class:`glpi_python_client.AsyncGlpiClient` on the async
 surface, :class:`glpi_python_client.GlpiClient` on the generated one.
 """
@@ -8,6 +8,7 @@ surface, :class:`glpi_python_client.GlpiClient` on the generated one.
 from __future__ import annotations
 
 from glpi_python_client._sync.clients.api.administration._entity import EntityMixin
+from glpi_python_client._sync.clients.api.administration._group import GroupMixin
 from glpi_python_client._sync.clients.api.administration._user import UserMixin
 
-__all__ = ["EntityMixin", "UserMixin"]
+__all__ = ["EntityMixin", "GroupMixin", "UserMixin"]

glpi_python_client/_sync/clients/api/administration/_group.py

@@ -0,0 +1,218 @@
+"""GLPI ``/Administration/Group`` mixin.
+
+The mixin exposes search, fetch, create, update, and delete helpers for the
+GLPI group resource. Every call sends the client's ``GLPI-Entity`` header
+(and the profile and recursion headers that travel with it) except where a
+search is told to skip it with ``skip_entity=True``.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterator
+
+from glpi_python_client._sync.clients.commons._constants import GROUP_ENDPOINT, GlpiId
+from glpi_python_client._sync.clients.commons._transport import TransportMixin
+from glpi_python_client.models.api_schema.administration._group import (
+    DeleteGroup,
+    GetGroup,
+    PatchGroup,
+    PostGroup,
+)
+
+
+class GroupMixin(TransportMixin):
+    """CRUD helpers for ``/Administration/Group``."""
+
+    def search_groups(
+        self,
+        rsql_filter: str = "",
+        *,
+        limit: int = 50,
+        start: int = 0,
+        skip_entity: bool = False,
+    ) -> list[GetGroup]:
+        """Search GLPI groups with an optional RSQL filter.
+
+        Parameters
+        ----------
+        rsql_filter : str, optional
+            Raw RSQL filter forwarded as the ``filter`` query parameter,
+            for example ``"name==Support"``. Empty by default.
+        limit : int, optional
+            Maximum number of records returned by the GLPI server.
+        start : int, optional
+            Zero-based offset of the first record returned.
+        skip_entity : bool, optional
+            When ``True`` the ``GLPI-Entity`` header is omitted so the
+            search spans every entity the caller has access to.
+
+        Returns
+        -------
+        list[GetGroup]
+            Groups matching the filter.
+        """
+
+        params: dict[str, object] = {"limit": limit, "start": start}
+        if rsql_filter:
+            params["filter"] = rsql_filter
+        return self._resource_list(
+            GROUP_ENDPOINT, GetGroup, params=params, skip_entity=skip_entity
+        )
+
+    def iter_search_groups(
+        self,
+        rsql_filter: str = "",
+        *,
+        batch_size: int = 50,
+        skip_entity: bool = False,
+    ) -> Iterator[list[GetGroup]]:
+        """Yield successive pages of GLPI groups until exhausted.
+
+        Pagination advances the ``start`` offset after each batch and stops
+        when the server returns fewer items than ``batch_size``.
+
+        Parameters
+        ----------
+        rsql_filter : str, optional
+            Raw RSQL filter forwarded as the ``filter`` query parameter.
+        batch_size : int, optional
+            Number of records requested per page (default 50).
+        skip_entity : bool, optional
+            When ``True`` the ``GLPI-Entity`` header is omitted so the
+            search spans every entity the caller has access to.
+
+        Yields
+        ------
+        list[GetGroup]
+            One page of groups per iteration. The last yielded batch may
+            be shorter than ``batch_size``.
+        """
+
+        start = 0
+        while True:
+            batch = self.search_groups(
+                rsql_filter,
+                limit=batch_size,
+                start=start,
+                skip_entity=skip_entity,
+            )
+            if batch:
+                yield batch
+            if len(batch) < batch_size:
+                break
+            start += batch_size
+
+    def get_group(self, group_id: GlpiId) -> GetGroup:
+        """Fetch one GLPI group by identifier.
+
+        Parameters
+        ----------
+        group_id : GlpiId
+            Numeric identifier of the group to retrieve.
+
+        Returns
+        -------
+        GetGroup
+            Validated group payload.
+
+        Raises
+        ------
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        return self._resource_get(
+            f"{GROUP_ENDPOINT}/{group_id}",
+            GetGroup,
+            failure_message=f"Failed to get group {group_id}",
+        )
+
+    def create_group(self, group: PostGroup) -> int:
+        """Create one GLPI group.
+
+        Parameters
+        ----------
+        group : PostGroup
+            Request body describing the group to create.
+
+        Returns
+        -------
+        int
+            Identifier assigned by the GLPI server.
+
+        Raises
+        ------
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        GlpiProtocolError
+            If the create response is missing the ``id`` field.
+        """
+
+        return self._resource_create(
+            GROUP_ENDPOINT,
+            group,
+            failure_message="Failed to create group",
+            missing_message="GLPI group create response did not include an ID",
+            log_message_factory=lambda new_id: f"GLPI API created group {new_id}",
+        )
+
+    def update_group(self, group_id: GlpiId, group: PatchGroup) -> None:
+        """Update one GLPI group with a partial body.
+
+        Parameters
+        ----------
+        group_id : GlpiId
+            Numeric identifier of the group to update.
+        group : PatchGroup
+            Partial request body.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        self._resource_update(
+            f"{GROUP_ENDPOINT}/{group_id}",
+            group,
+            failure_message=f"Failed to update group {group_id}",
+            log_message=f"GLPI API updated group {group_id}",
+        )
+
+    def delete_group(
+        self, group_id: GlpiId, *, force: bool | None = None
+    ) -> None:
+        """Delete one GLPI group by identifier.
+
+        Parameters
+        ----------
+        group_id : GlpiId
+            Numeric identifier of the group to delete.
+        force : bool | None, optional
+            When ``True`` the group is permanently deleted instead of
+            being moved to the trash.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        self._resource_delete(
+            f"{GROUP_ENDPOINT}/{group_id}",
+            failure_message=f"Failed to delete group {group_id}",
+            log_message=f"GLPI API deleted group {group_id}",
+            force=force,
+            delete_model_cls=DeleteGroup,
+        )
+
+
+__all__ = ["GroupMixin"]

glpi_python_client/_sync/clients/client.py

@@ -25,6 +25,7 @@ from glpi_python_client._sync.clients.api import (
     DocumentMixin,
     EntityMixin,
     FollowupMixin,
+    GroupMixin,
     KBArticleCommentMixin,
     KBArticleMixin,
     KBArticleRevisionMixin,
@@ -59,6 +60,7 @@ class GlpiClient(
     ComputerMixin,
     UserMixin,
     EntityMixin,
+    GroupMixin,
     LocationMixin,
     ContractTypeMixin,
     KBCategoryMixin,

glpi_python_client/_sync/clients/commons/_constants.py

@@ -19,6 +19,7 @@ COMPUTER_ENDPOINT = "Assets/Computer"
 # administration/
 USER_ENDPOINT = "Administration/User"
 ENTITY_ENDPOINT = "Administration/Entity"
+GROUP_ENDPOINT = "Administration/Group"
 
 # dropdowns/
 CONTRACT_TYPE_ENDPOINT = "Dropdowns/ContractType"
@@ -52,6 +53,7 @@ __all__ = [
     "DOCUMENT_ENDPOINT",
     "ENTITY_ENDPOINT",
     "FOLLOWUP_SUFFIX",
+    "GROUP_ENDPOINT",
     "KB_ARTICLE_ENDPOINT",
     "KB_CATEGORY_ENDPOINT",
     "KB_COMMENT_SUFFIX",

glpi_python_client/content/conversion.py

@@ -179,6 +179,30 @@ def _plain_text_html(text: str) -> str:
     return "<p>" + "<br>".join(lines) + "</p>"
 
 
+#: What a browser strips from the front of a URL, and drops from inside one.
+_URL_LEADING = "".join(chr(c) for c in range(0x21))
+_URL_INNER = str.maketrans("", "", "\t\r\n")
+
+#: The elements inside which the reader writes no image, so offers none.
+_UNFORMATTED = ("pre", "code", "kbd", "samp")
+
+
+def _is_data_uri(src: str) -> bool:
+    """Whether a browser reads ``src`` as a ``data:`` URI.
+
+    The scheme is case-insensitive, leading C0 controls and spaces are
+    stripped, and tabs and line breaks are dropped wherever they are.
+    """
+
+    return src.lstrip(_URL_LEADING).translate(_URL_INNER).casefold().startswith("data:")
+
+
+def _image_id(el: Tag) -> str | None:
+    """The trimmed ``id`` of an element, or ``None`` when it has none."""
+
+    return str(el.get("id") or "").strip() or None
+
+
 def _soup(html: str) -> BeautifulSoup:
     """Parse ``html`` and drop what a browser does not display."""
 
@@ -402,6 +426,12 @@ class Link:
     enclosing_href : str or None
         For an ``<img>`` inside a link, that link's ``href``; ``None``
         otherwise. The image is read before the link around it.
+    image_id : str or None
+        For an ``<img>``, the value of its ``id`` attribute, trimmed, or
+        ``None`` when it has none or the element is a link. GLPI sets it to
+        the tag of the Document it created for an image it has not rewritten
+        into a document link, and that Document carries the same value as its
+        tag, so a caller can find it.
     """
 
     href: str
@@ -410,6 +440,7 @@ class Link:
     image: bool = False
     document_id: int | None = None
     enclosing_href: str | None = None
+    image_id: str | None = None
 
 
 #: A ``rewrite_link`` callback: called with each link and image a read meets,
@@ -664,6 +695,7 @@ class _Converter(MarkdownConverter):
                     enclosing_href=(
                         None if around is None else str(around.get("href") or "")
                     ),
+                    image_id=_image_id(el),
                 )
             )
             if isinstance(answer, str):
@@ -1021,6 +1053,33 @@ class GlpiContentConverter:
         document_id = int(values[0])
         return document_id if document_id > 0 else None
 
+    @staticmethod
+    def data_image_ids(html: str) -> tuple[str, ...]:
+        """Return the ``id`` of every image a body keeps as a ``data:`` URI.
+
+        Each ``<img>`` whose ``src`` a browser reads as a ``data:`` URI and
+        that has a non-empty ``id`` contributes it, in document order and
+        without repeats. The base64 is not decoded. An image inside ``<pre>``,
+        ``<code>``, ``<kbd>`` or ``<samp>`` is left out: the reader shows it
+        as no image, so it never offers it to ``rewrite_link`` either.
+
+        GLPI sets a tag on the Documents it creates from an upload or an
+        editor paste, images or not. For an image it has not rewritten into a
+        document link, that tag is the ``id`` of the ``<img>``
+        (:attr:`Link.image_id`, :attr:`GetDocument.tag`). A caller calls this
+        first, to decide whether it needs to read any Document at all.
+        """
+
+        if "<" not in html:
+            return ()
+        ids = (
+            _image_id(img)
+            for img in _soup(html).find_all("img")
+            if _is_data_uri(str(img.get("src") or ""))
+            and img.find_parent(_UNFORMATTED) is None
+        )
+        return tuple(dict.fromkeys(i for i in ids if i is not None))
+
     @staticmethod
     def document_image(
         document_id: int,

glpi_python_client/models/__init__.py

@@ -22,12 +22,16 @@ from glpi_python_client.models.api_schema._common import (
 )
 from glpi_python_client.models.api_schema.administration import (
     DeleteEntity,
+    DeleteGroup,
     DeleteUser,
     GetEntity,
+    GetGroup,
     GetUser,
     PatchEntity,
+    PatchGroup,
     PatchUser,
     PostEntity,
+    PostGroup,
     PostUser,
 )
 from glpi_python_client.models.api_schema.assets import (
@@ -141,6 +145,7 @@ __all__ = [
     "DeleteDocument",
     "DeleteEntity",
     "DeleteFollowup",
+    "DeleteGroup",
     "DeleteKBArticle",
     "DeleteKBArticleComment",
     "DeleteKBCategory",
@@ -161,6 +166,7 @@ __all__ = [
     "GetDocumentItem",
     "GetEntity",
     "GetFollowup",
+    "GetGroup",
     "GetKBArticle",
     "GetKBArticleComment",
     "GetKBArticleRevision",
@@ -197,6 +203,7 @@ __all__ = [
     "PatchDocument",
     "PatchEntity",
     "PatchFollowup",
+    "PatchGroup",
     "PatchKBArticle",
     "PatchKBArticleComment",
     "PatchKBCategory",
@@ -215,6 +222,7 @@ __all__ = [
     "PostDocument",
     "PostEntity",
     "PostFollowup",
+    "PostGroup",
     "PostKBArticle",
     "PostKBArticleComment",
     "PostKBCategory",

glpi_python_client/models/api_schema/administration/__init__.py

@@ -1,7 +1,8 @@
 """Administration entity schemas mirroring the ``/Administration`` endpoints.
 
-This subpackage exposes the per-verb Pydantic models for ``User`` and
-``Entity``. Each module follows the same ``Get<Name>``/``Post<Name>``/
+This subpackage exposes the per-verb Pydantic models for ``User``,
+``Entity`` and ``Group``. Each module follows the same
+``Get<Name>``/``Post<Name>``/
 ``Patch<Name>``/``Delete<Name>`` naming convention.
 """
 
@@ -11,6 +12,12 @@ from glpi_python_client.models.api_schema.administration._entity import (
     PatchEntity,
     PostEntity,
 )
+from glpi_python_client.models.api_schema.administration._group import (
+    DeleteGroup,
+    GetGroup,
+    PatchGroup,
+    PostGroup,
+)
 from glpi_python_client.models.api_schema.administration._user import (
     DeleteUser,
     GetUser,
@@ -20,11 +27,15 @@ from glpi_python_client.models.api_schema.administration._user import (
 
 __all__ = [
     "DeleteEntity",
+    "DeleteGroup",
     "DeleteUser",
     "GetEntity",
+    "GetGroup",
     "GetUser",
     "PatchEntity",
+    "PatchGroup",
     "PatchUser",
     "PostEntity",
+    "PostGroup",
     "PostUser",
 ]

glpi_python_client/models/api_schema/administration/_group.py

@@ -0,0 +1,150 @@
+"""GLPI ``Group`` schemas for the ``/Administration/Group`` endpoints.
+
+The field layout mirrors ``components.schemas.Group`` from the GLPI OpenAPI
+contract. Read-only contract fields are not declared on the request models;
+a caller that supplies one anyway sends it through ``extra_payload`` and the
+server decides.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+from glpi_python_client.models._base import GlpiModel
+from glpi_python_client.models.api_schema._common import IdNameRef
+
+
+class GetGroup(GlpiModel):
+    """Response shape returned by ``GET /Administration/Group`` endpoints.
+
+    Mirrors ``components.schemas.Group``. All fields are optional because
+    the contract does not advertise a ``required`` array.
+
+    Parameters
+    ----------
+    id : int | None, optional
+        Native GLPI identifier (``readOnly``).
+    name : str | None, optional
+        Name of the group.
+    comment : str | None, optional
+        Free-form comment.
+    completename : str | None, optional
+        Full hierarchical path of the group (``readOnly``).
+    parent : IdNameRef | None, optional
+        Parent group in the hierarchy.
+    level : int | None, optional
+        Depth of the group in the hierarchy tree (``readOnly``).
+    entity : IdNameRef | None, optional
+        Entity the group belongs to.
+    code : str | None, optional
+        Group code (at most 255 characters).
+    ldap_field : str | None, optional
+        LDAP user attribute that may contain this group (memberof).
+    ldap_value : str | None, optional
+        LDAP attribute value to match for membership, usually the DN.
+    ldap_group_dn : str | None, optional
+        DN of the group in LDAP; only populated in certain cases.
+    maybe_requester : bool | None, optional
+        Can be a requester.
+    maybe_observer : bool | None, optional
+        Can be an observer.
+    maybe_assigned : bool | None, optional
+        Can be assigned (to tickets).
+    maybe_assigned_task : bool | None, optional
+        Can be assigned to tasks.
+    maybe_notified : bool | None, optional
+        Can be notified.
+    may_contain_items : bool | None, optional
+        Can contain items.
+    may_contain_users : bool | None, optional
+        Can contain users.
+    maybe_manager : bool | None, optional
+        Can be manager.
+    recursive_membership : bool | None, optional
+        Whether users of this group are implied members of all child
+        groups. Unrelated to entity recursion.
+    mfa_enforced : bool | None, optional
+        Whether two-factor authentication is enforced for members.
+    date_creation : datetime | None, optional
+        Creation timestamp.
+    date_mod : datetime | None, optional
+        Last modification timestamp.
+    """
+
+    id: int | None = None
+    name: str | None = None
+    comment: str | None = None
+    completename: str | None = None
+    parent: IdNameRef | None = None
+    level: int | None = None
+    entity: IdNameRef | None = None
+    code: str | None = None
+    ldap_field: str | None = None
+    ldap_value: str | None = None
+    ldap_group_dn: str | None = None
+    maybe_requester: bool | None = None
+    maybe_observer: bool | None = None
+    maybe_assigned: bool | None = None
+    maybe_assigned_task: bool | None = None
+    maybe_notified: bool | None = None
+    may_contain_items: bool | None = None
+    may_contain_users: bool | None = None
+    maybe_manager: bool | None = None
+    recursive_membership: bool | None = None
+    mfa_enforced: bool | None = None
+    date_creation: datetime | None = None
+    date_mod: datetime | None = None
+
+
+class PostGroup(GlpiModel):
+    """Request body for ``POST /Administration/Group``.
+
+    Read-only contract fields (``id``, ``completename``, ``level``) and the
+    server-set timestamps are not declared; see :class:`GetGroup` for the
+    meaning of each field.
+    """
+
+    name: str | None = None
+    comment: str | None = None
+    parent: IdNameRef | None = None
+    entity: IdNameRef | None = None
+    code: str | None = None
+    ldap_field: str | None = None
+    ldap_value: str | None = None
+    ldap_group_dn: str | None = None
+    maybe_requester: bool | None = None
+    maybe_observer: bool | None = None
+    maybe_assigned: bool | None = None
+    maybe_assigned_task: bool | None = None
+    maybe_notified: bool | None = None
+    may_contain_items: bool | None = None
+    may_contain_users: bool | None = None
+    maybe_manager: bool | None = None
+    recursive_membership: bool | None = None
+    mfa_enforced: bool | None = None
+
+
+class PatchGroup(PostGroup):
+    """Request body for ``PATCH /Administration/Group/{id}``.
+
+    The contract uses the same ``Group`` schema for create and
+    partial-update bodies; ``PatchGroup`` is kept distinct so client
+    mixins can express the intent of the operation explicitly.
+    """
+
+
+class DeleteGroup(GlpiModel):
+    """Query parameters for ``DELETE /Administration/Group/{id}``.
+
+    Parameters
+    ----------
+    force : bool | None, optional
+        When ``True``, permanently delete the group instead of moving the
+        record to the GLPI trash. When ``False`` or :data:`None`, the
+        server applies its default soft-delete behaviour.
+    """
+
+    force: bool | None = None
+
+
+__all__ = ["DeleteGroup", "GetGroup", "PatchGroup", "PostGroup"]

glpi_python_client/models/api_schema/management/_document.py

@@ -61,6 +61,20 @@ class GetDocument(GlpiModel):
     mime: str | None = None
     sha1sum: str | None = None
 
+    @property
+    def tag(self) -> str | None:
+        """The tag GLPI gave the Document, or ``None``.
+
+        GLPI sets a tag on the Documents it creates from an upload or an
+        editor paste, images or not. For an image it has not rewritten into
+        a document link, it is the ``id`` of the ``<img>`` left in the body
+        (see ``GlpiContentConverter.data_image_ids``). Read from
+        ``extra_payload``; ``None`` when absent, empty or not a string.
+        """
+
+        value = self.extra_payload.get("tag")
+        return value if isinstance(value, str) and value else None
+
 
 class PostDocument(GlpiModel):
     """Request body for ``POST /Management/Document``.

{glpi_python_client-0.6.4.dist-info → glpi_python_client-0.6.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: glpi-python-client
-Version: 0.6.4
+Version: 0.6.6
 Summary: A typed Python client for GLPI ITSM APIs.
 Project-URL: Homepage, https://github.com/baraline/glpi_python_client
 Project-URL: Documentation, https://glpi-python-client.readthedocs.io/en/latest/

{glpi_python_client-0.6.4.dist-info → glpi_python_client-0.6.6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-glpi_python_client/__init__.py,sha256=IjuloET5lqy2KL5c3sgXRYxppjxcVAv7mZUK-DERRNA,5630
+glpi_python_client/__init__.py,sha256=PxyLPvdfRqFJPkX1RhaRjOJruLSmLJgW7M6_d2M634A,5762
 glpi_python_client/_errors.py,sha256=Bc9UvlxulbdcGvzZIKXnJCTL78sW78R6EFg50P-1dpY,7151
 glpi_python_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 glpi_python_client/rsql.py,sha256=3u3lH3_-F1bvHbVzxALXTDPoHyoMATP1f4QPTar_sEU,8974
@@ -10,10 +10,11 @@ glpi_python_client/_async/auth/_v1_session.py,sha256=3t1OammbfUm9E-ANynrBFryxjx5
 glpi_python_client/_async/auth/auth.py,sha256=1vGG5uBNG8lMjcm20-mgcsH2e0GWKGujQo4k6vck1lE,14694
 glpi_python_client/_async/clients/__init__.py,sha256=LCjaQ_tjb4icz04PvPQdmtfP6PgtymBKhnhA7PuW52I,637
 glpi_python_client/_async/clients/_base_client.py,sha256=Yq_Stx2BqZjNbvysrEMLYyOrfSYjzihN6alfQpy7pWA,7553
-glpi_python_client/_async/clients/client.py,sha256=K8f831VoXYvJrGYrvY1G-xElxlN27ogebkwkvbJkHeU,3847
-glpi_python_client/_async/clients/api/__init__.py,sha256=KGuk9Z0j3ed9c35NsaahPMRivSgSRwPxWZLyPoV-e9Q,1742
-glpi_python_client/_async/clients/api/administration/__init__.py,sha256=Ep01JuzEeCqyeWpIfj7SnAc5xm7yZrbECDl7DpzYSq4,510
+glpi_python_client/_async/clients/client.py,sha256=4lZbd4wHNRqI2xbzjsff3iy8e4FnMgF-1Ezi0KyBtHM,3879
+glpi_python_client/_async/clients/api/__init__.py,sha256=keInRT6ogmkeWETnNQC6VliBjZZk4ur2hRcIyWSv1_k,1776
+glpi_python_client/_async/clients/api/administration/__init__.py,sha256=raqpFI2U8WDfeSRzN8-PcqhzD3sKP0oTamgj77-Nhxk,614
 glpi_python_client/_async/clients/api/administration/_entity.py,sha256=qG1SBMwOCZWHjHV4KfswY6bTaTQP9I83mQvOd-Xo70w,6453
+glpi_python_client/_async/clients/api/administration/_group.py,sha256=uqx4Qqt7bWCYZlQayDIL5l_wW8kUg50ngxz3ktD771w,6511
 glpi_python_client/_async/clients/api/administration/_user.py,sha256=SQ_CM353cFD0BW0GQSQp__HZQlmJsAUuAiOgs-1NoNg,10085
 glpi_python_client/_async/clients/api/assets/__init__.py,sha256=WFWG5zcRf0kFtz35it3W83xOlqXJ77IcYI51KRSiL08,198
 glpi_python_client/_async/clients/api/assets/_computer.py,sha256=U-dDeYmY3MaS0BTqJAQThKtKTbvDS7BvshbXheD64rM,13634
@@ -40,7 +41,7 @@ glpi_python_client/_async/clients/api/plugins/__init__.py,sha256=mmY6HngIzna2AG3
 glpi_python_client/_async/clients/api/plugins/_fields.py,sha256=mGpPutvN8JUDUszdvLEE2kkQnz28rktshHdFhs9A1X4,15485
 glpi_python_client/_async/clients/commons/__init__.py,sha256=1-V_LgNwIYDyXdpLP2nijCTeGgajTcY-wt0C4aeRE3k,406
 glpi_python_client/_async/clients/commons/_config.py,sha256=JlUZy_oPQj0ldSbBVWcytMlvROyeCW0JldOpPrBmFMs,13080
-glpi_python_client/_async/clients/commons/_constants.py,sha256=VTLjX6Ei6QKcQB7l3Hzfo9lT34v09pdiNhJPDy8vvEk,1772
+glpi_python_client/_async/clients/commons/_constants.py,sha256=Y2uQ0zE_7m0DLSKLg41JEbW4ww23Mk9g-hDbjNZjaZQ,1834
 glpi_python_client/_async/clients/commons/_filters.py,sha256=eQdrc06RhEuGHtvAqBJy1VrOVHVjeiFh82pvX-HxGw8,4695
 glpi_python_client/_async/clients/commons/_http.py,sha256=8x9H9eHw-neOYoQ2MAP2JmbVqcpno42pZlzfuhizpmk,15240
 glpi_python_client/_async/clients/commons/_payloads.py,sha256=7LEzk72WwLcLqxWXQ_rHcjAnpo3WIuq97X768-Zkvt8,3707
@@ -56,10 +57,11 @@ glpi_python_client/_sync/auth/_v1_session.py,sha256=dlnYA2yi_aWI6wTpfnRD3nzRvnw1
 glpi_python_client/_sync/auth/auth.py,sha256=azWE3bqDswxU-PtO-m_aKb-luSVPRrRXDVuq2aFRz18,14608
 glpi_python_client/_sync/clients/__init__.py,sha256=DWKGlB1KAgTQvmc_Dycz7rynNo0y_fr5Z4LcTxzn4iQ,623
 glpi_python_client/_sync/clients/_base_client.py,sha256=-59b4F383zVhcnt_KV8VY3f9nMr0SlRG9tm_d3yKRKU,7551
-glpi_python_client/_sync/clients/client.py,sha256=asaLf7l1n5srjZn6M7uDEhaWw5IqbQrkVyQ4BKeED_M,3789
-glpi_python_client/_sync/clients/api/__init__.py,sha256=uKQhoYxK16kj7hiktTCiIgikjw5w4QsXVige2Ytv7cU,1733
-glpi_python_client/_sync/clients/api/administration/__init__.py,sha256=lv5dUygrbxiBB_8392mjS_gYDcZmac_EbJgBD9DoZk8,508
+glpi_python_client/_sync/clients/client.py,sha256=WTqrTs_0xSUSR8ez__JjHPgDBhsBUtyUFBhgZANNZqo,3821
+glpi_python_client/_sync/clients/api/__init__.py,sha256=_nlTpSQyldJrTVvlifp__DQGF6_vqCl_YPWp6FCa-mM,1767
+glpi_python_client/_sync/clients/api/administration/__init__.py,sha256=3s3Nfawu1FI97Q-WIlz5OgLZL7TszItF6l_JzQHVzaM,611
 glpi_python_client/_sync/clients/api/administration/_entity.py,sha256=jYvIl1hXcPQuAABa0I0TCKBG6FMHtO8xl55xhG5CRS8,6369
+glpi_python_client/_sync/clients/api/administration/_group.py,sha256=84J78kE35pBhokqrRTMDj2H7yyU8UWvPfdbCcDLR8hY,6427
 glpi_python_client/_sync/clients/api/administration/_user.py,sha256=8QuL9G_6donw0UNtpQEyxh1gHpjfymnDcGy-7AW7IcA,9989
 glpi_python_client/_sync/clients/api/assets/__init__.py,sha256=_4-S2nkXQNuFXzZzXoLR3DnykaKTzata9ZPN74ASO8s,197
 glpi_python_client/_sync/clients/api/assets/_computer.py,sha256=jILfoo7L2FJwL7Q_uFXkpfDBCuPczCAJ_TbAoyiGrj0,13490
@@ -86,7 +88,7 @@ glpi_python_client/_sync/clients/api/plugins/__init__.py,sha256=x9RwOUD34H1bPsJJ
 glpi_python_client/_sync/clients/api/plugins/_fields.py,sha256=jkGTF0T7eQHzOPcKSqaEmwJx-EgETcgncXyke69HJeg,15368
 glpi_python_client/_sync/clients/commons/__init__.py,sha256=Ur1hbt0_A9TlRqYi97PmlfsXYS_EMGk0lVjkHx_cyBE,404
 glpi_python_client/_sync/clients/commons/_config.py,sha256=f2wVtUUdh6rxaf-s84X8Fhfn0zxn0OPJg445dKeCSVw,13056
-glpi_python_client/_sync/clients/commons/_constants.py,sha256=VTLjX6Ei6QKcQB7l3Hzfo9lT34v09pdiNhJPDy8vvEk,1772
+glpi_python_client/_sync/clients/commons/_constants.py,sha256=Y2uQ0zE_7m0DLSKLg41JEbW4ww23Mk9g-hDbjNZjaZQ,1834
 glpi_python_client/_sync/clients/commons/_filters.py,sha256=eQdrc06RhEuGHtvAqBJy1VrOVHVjeiFh82pvX-HxGw8,4695
 glpi_python_client/_sync/clients/commons/_http.py,sha256=5p8S1J1usIB0WQg5u3h6zovr14an-NoIGNfwAHEOSS4,15239
 glpi_python_client/_sync/clients/commons/_payloads.py,sha256=7LEzk72WwLcLqxWXQ_rHcjAnpo3WIuq97X768-Zkvt8,3707
@@ -95,15 +97,16 @@ glpi_python_client/_sync/clients/custom/__init__.py,sha256=sxfGlHVulucP7bacWhUMi
 glpi_python_client/_sync/clients/custom/_statistics.py,sha256=xrD5C99ieROJx60iUomBHacQ_49HpgQL4XjnfREUQvs,38616
 glpi_python_client/_sync/clients/custom/_ticket_context.py,sha256=LDUvKNr8VpZonF5bDo8QYYwMEsWmayVU28Ra3GonNmE,3004
 glpi_python_client/content/__init__.py,sha256=TaZPo8WSvVj4U-hSnxhUcqU8JnCKNZYpfQf4pH45aN4,424
-glpi_python_client/content/conversion.py,sha256=bglYY5IgoTv2SdS0Gton7WgsyzwwQ5GdU_2dLloL2l0,42860
-glpi_python_client/models/__init__.py,sha256=CLvk-1A-88114X7HaS9P6KyfovQjCPRX08J56rJaGls,5454
+glpi_python_client/content/conversion.py,sha256=0dxQW0ojSo1KC8zcTFa476KQa1i3sLWzQ8gTEEVslys,45341
+glpi_python_client/models/__init__.py,sha256=7OxYvXSQc4QdK1VAQb_1BGvgwGc6211gKnSdLWy-qhY,5586
 glpi_python_client/models/_base.py,sha256=pYg69KHuR5TDED5utr4Knr7HncBnLTxXHJZYf6vEUKA,12183
 glpi_python_client/models/api_schema/__init__.py,sha256=yTxUYih1Xy7NUogzD7UKp2b8HyE4wdeC_FCKS6ZRVVM,1176
 glpi_python_client/models/api_schema/_common.py,sha256=wVtaIkUM9iS3jyDb0bpFopEkP_3vP1ax7D8rwHe9QkI,2004
 glpi_python_client/models/api_schema/_content.py,sha256=DlsEmlXIK_0jyXh3j5PgU6vkwch2o0I8UpUkLq2fqYw,12826
 glpi_python_client/models/api_schema/enums.py,sha256=bHNCuumOXIZm80n5RqIhCzFqizII-3er41mn2aktF5s,5071
-glpi_python_client/models/api_schema/administration/__init__.py,sha256=uTr2rEMYq47T5foUMHm1rtsBmEQvdD1EQw5CZOUN38Y,706
+glpi_python_client/models/api_schema/administration/__init__.py,sha256=CFZ36OIk1PPBzkXkCtOo2C6s7JfaKSp63Nw4-b_coxc,924
 glpi_python_client/models/api_schema/administration/_entity.py,sha256=KdbxMyPXumGZKmmabDIciF3nFS61pLRp5SBOTFa8slk,3297
+glpi_python_client/models/api_schema/administration/_group.py,sha256=8aWnDupTT9lxGtzMC_dAG8yDLO_NKtFz-OCNHOYESi0,5298
 glpi_python_client/models/api_schema/administration/_user.py,sha256=MQ6cHKdni98sjm-Whf0GKdGpNjPgGGJpUBgVjlGa19Q,15872
 glpi_python_client/models/api_schema/assets/__init__.py,sha256=QikGfQwwhjKt3vUd5FYC1F-BeClP5ByK1hahRRumdsA,562
 glpi_python_client/models/api_schema/assets/_computer.py,sha256=me3px9rkaN_ZataDVLjOer9wsZw_fRoRikxkLzXopsE,10304
@@ -127,7 +130,7 @@ glpi_python_client/models/api_schema/knowledgebase/_revision.py,sha256=KuTb_F85m
 glpi_python_client/models/api_schema/management/__init__.py,sha256=z5ntUAXiXXhZCEIsTVaTgJdXbg0ZW24TZctarfAqjr0,987
 glpi_python_client/models/api_schema/management/_contract.py,sha256=m6g__AKWvDQ09xKyUe8RhRS8xE1d1pOBjqOOG-8u6Ck,14045
 glpi_python_client/models/api_schema/management/_contract_cost.py,sha256=Bp2B3bA5u8CE_oBYY70QIUot8jFLCrX_icXZ4kpYqSE,4966
-glpi_python_client/models/api_schema/management/_document.py,sha256=RzKF-rNlz8CsAMa2BAaiqHNEE3-m1mci7vtdARls4uw,4607
+glpi_python_client/models/api_schema/management/_document.py,sha256=kiEkTnOydGHjOyAwTbo020Kei4ffkBDj-9m775gLyfw,5200
 glpi_python_client/models/api_schema/management/_document_item.py,sha256=Bu9c9YdhSs5hGZ8dRfRxqS4g7VZ1A3EJtNbDLulKpWA,3113
 glpi_python_client/models/api_schema/plugins/__init__.py,sha256=GA0pr0PeoPOqwjUilrBujh0OqjUfZhzPWgIlgDJcZog,544
 glpi_python_client/models/api_schema/plugins/_fields.py,sha256=Se-12ZDqk_-on_37YF_hRD5S0e0H6zyha3SXI9xb_9Y,6576
@@ -136,7 +139,7 @@ glpi_python_client/models/custom_schema/_ticket_context.py,sha256=jnlfgho-aDbmA9
 glpi_python_client/testing/__init__.py,sha256=iLtUyJjyv3fEhy3PN25NxNTbtqDl3SoHLbNium0Z80U,568
 glpi_python_client/testing/fixtures.py,sha256=HKt6MXHgcmLn4L98pSwp-oGlc9C--_vrABNe5G_iBeg,1286
 glpi_python_client/testing/utils.py,sha256=JyO3w2d-0kYdtC1hEZ2Tu_YjnCz8nUQ_Ck05-1EhsX4,4404
-glpi_python_client-0.6.4.dist-info/METADATA,sha256=EFNn15U6Eqjua7bVLPM22W9N48EEMza3gq3f0--MsJs,8234
-glpi_python_client-0.6.4.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-glpi_python_client-0.6.4.dist-info/licenses/LICENSE,sha256=nL8re-TIKkxCoL7OkSBja6EB4NsQR1HoOJgxv_MEhtc,1088
-glpi_python_client-0.6.4.dist-info/RECORD,,
+glpi_python_client-0.6.6.dist-info/METADATA,sha256=RiSWOUSsejQZVqs8hWndBh8TB9DPm07vq56KpoluRZo,8234
+glpi_python_client-0.6.6.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+glpi_python_client-0.6.6.dist-info/licenses/LICENSE,sha256=nL8re-TIKkxCoL7OkSBja6EB4NsQR1HoOJgxv_MEhtc,1088
+glpi_python_client-0.6.6.dist-info/RECORD,,

{glpi_python_client-0.6.4.dist-info → glpi_python_client-0.6.6.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.32.4
+Generator: hatchling 1.33.0
 Root-Is-Purelib: true
 Tag: py3-none-any