glpi-python-client 0.6.3__py3-none-any.whl → 0.6.5__py3-none-any.whl

glpi_python_client/__init__.py

@@ -50,12 +50,14 @@ from glpi_python_client.models import (
     DeleteTicketTask,
     DeleteTimelineDocument,
     DeleteUser,
+    FollowupDocuments,
     GetComputer,
     GetContract,
     GetContractCost,
     GetContractItem,
     GetContractType,
     GetDocument,
+    GetDocumentItem,
     GetEntity,
     GetFollowup,
     GetKBArticle,
@@ -131,7 +133,7 @@ from glpi_python_client.rsql import (
     date_window,
 )
 
-__version__ = "0.6.3"
+__version__ = "0.6.5"
 
 __all__ = [
     "AsyncGlpiClient",
@@ -153,12 +155,14 @@ __all__ = [
     "DeleteTicketTask",
     "DeleteTimelineDocument",
     "DeleteUser",
+    "FollowupDocuments",
     "GetComputer",
     "GetContract",
     "GetContractCost",
     "GetContractItem",
     "GetContractType",
     "GetDocument",
+    "GetDocumentItem",
     "GetEntity",
     "GetFollowup",
     "GetKBArticle",

glpi_python_client/_async/clients/api/assistance/timeline/_document.py

@@ -17,18 +17,36 @@ as :class:`GetDocument`.
 
 from __future__ import annotations
 
+import re
+
+from glpi_python_client._async._concurrency import gather
 from glpi_python_client._async.clients.commons._constants import (
     TICKET_ENDPOINT,
     TIMELINE_DOCUMENT_SUFFIX,
     GlpiId,
 )
+from glpi_python_client._async.clients.commons._payloads import model_from_payload
 from glpi_python_client._async.clients.commons._transport import TransportMixin
+from glpi_python_client._errors import GlpiValidationError
 from glpi_python_client.models.api_schema.assistance.timeline._document import (
     DeleteTimelineDocument,
     PatchTimelineDocument,
     PostTimelineDocument,
 )
+from glpi_python_client.models.api_schema.assistance.timeline._followup import (
+    GetFollowup,
+)
 from glpi_python_client.models.api_schema.management._document import GetDocument
+from glpi_python_client.models.api_schema.management._document_item import (
+    FollowupDocuments,
+    GetDocumentItem,
+)
+
+_ITEM_DOCUMENT_RANGE = "0-999"
+_ITEM_DOCUMENT_PAGE_SIZE = 1000
+_ITEMTYPE_PATTERN = re.compile(r"^[A-Za-z][A-Za-z0-9_]*$")
+_V1_FEATURE_LABEL = "item document link listing"
+_FOLLOWUP_ITEMTYPE = "ITILFollowup"
 
 
 class TimelineDocumentMixin(TransportMixin):
@@ -62,6 +80,173 @@ class TimelineDocumentMixin(TransportMixin):
             unwrap_envelope=True,
         )
 
+    async def list_item_documents(
+        self, itemtype: str, items_id: GlpiId
+    ) -> list[GetDocumentItem]:
+        """List the document links of one item, over the legacy v1 API.
+
+        Only the followup route (``itemtype="ITILFollowup"``) has been
+        checked against a live server.  Other itemtypes are sent to the same
+        v1 sub-route unchanged.
+
+        Unlike :meth:`list_ticket_timeline_documents`, this call needs the
+        legacy v1 session (``v1_base_url`` and ``v1_user_token``).  Without
+        one it raises ``RuntimeError``.
+
+        It returns link rows, not documents.  A caller resolves each
+        ``documents_id`` with ``get_document``.
+
+        The library does not filter private followups, tasks or solutions
+        for the caller: every link the authenticated user can read is
+        returned.
+
+        GLPI's editor links an image pasted into a followup to the followup,
+        not to the ticket.  A caller that wants such images therefore walks
+        the ticket's followups and lists each one.
+
+        Parameters
+        ----------
+        itemtype : str
+            GLPI itemtype owning the links, for example ``"ITILFollowup"``.
+            It must start with a letter and contain only letters, digits and
+            underscores, because it is placed in the URL path.
+        items_id : GlpiId
+            Positive numeric identifier of the item.
+
+        Returns
+        -------
+        list[GetDocumentItem]
+            Link rows, with naive timestamps localised to the server
+            timezone.  An empty answer gives an empty list.
+
+        Raises
+        ------
+        RuntimeError
+            If the client was built without a v1 session.
+        GlpiValidationError
+            If ``itemtype`` or ``items_id`` is invalid, if GLPI answers
+            something other than a list or an empty body, or if it answers a
+            full page of 1000 rows or more, which may be truncated.  A
+            partial list is never returned.
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        v1 = self._require_v1_session(_V1_FEATURE_LABEL)
+        if not _ITEMTYPE_PATTERN.fullmatch(itemtype):
+            raise GlpiValidationError(
+                f"itemtype must match {_ITEMTYPE_PATTERN.pattern!r}, got {itemtype!r}"
+            )
+        if items_id <= 0:
+            raise GlpiValidationError(
+                f"items_id must be a positive integer, got {items_id!r}"
+            )
+        payload = await v1.request_json(
+            "GET",
+            f"{itemtype}/{items_id}/Document_Item",
+            params={"range": _ITEM_DOCUMENT_RANGE},
+            failure_message=(f"Failed to list document links of {itemtype} {items_id}"),
+        )
+        if isinstance(payload, dict) and not payload:
+            return []
+        if not isinstance(payload, list):
+            raise GlpiValidationError(
+                f"Unexpected document link answer for {itemtype} {items_id}: "
+                f"{type(payload).__name__}"
+            )
+        if len(payload) >= _ITEM_DOCUMENT_PAGE_SIZE:
+            raise GlpiValidationError(
+                f"{itemtype} {items_id} returned {len(payload)} document links, "
+                "a full page that may be truncated"
+            )
+        return [
+            model_from_payload(
+                GetDocumentItem, row, server_timezone=self.server_timezone
+            )
+            for row in payload
+        ]
+
+    async def list_ticket_followup_documents(
+        self, ticket_id: GlpiId, *, include_private: bool = False
+    ) -> list[FollowupDocuments]:
+        """List the document links of each followup of one ticket.
+
+        GLPI's editor links an image pasted into a followup to the followup,
+        not to the ticket. :meth:`list_ticket_timeline_documents` therefore
+        never returns such an image, and this method does.
+
+        Each entry holds the followup and its links, so a caller reads
+        ``followup.is_private`` to classify every link without a second
+        read. Only followups are walked: tasks and solutions are not.
+
+        This call needs the legacy v1 session (``v1_base_url`` and
+        ``v1_user_token``). Without one it raises ``RuntimeError``. It issues
+        one v1 request per kept followup, all at once on the asynchronous
+        surface and one after the other on the synchronous one.
+
+        Parameters
+        ----------
+        ticket_id : GlpiId
+            Numeric identifier of the parent ticket.
+        include_private : bool, optional
+            When false (the default), private followups and followups whose
+            ``is_private`` flag is missing are dropped and not queried, so
+            only what a requester can see is returned. A missing flag counts
+            as private. When true, every followup is kept.
+
+        Returns
+        -------
+        list[FollowupDocuments]
+            One entry per kept followup, in ascending followup id, including
+            a followup with no link (an empty ``documents`` list). A link row
+            that does not name that followup as its item is dropped.
+
+        Raises
+        ------
+        RuntimeError
+            If the client was built without a v1 session.
+        GlpiValidationError
+            If a kept followup has no identifier, or if reading the links of
+            a followup fails validation. A partial list is never returned.
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        self._require_v1_session(_V1_FEATURE_LABEL)
+        followups = await self.list_ticket_followups(ticket_id)  # type: ignore[attr-defined]
+        kept = [
+            followup
+            for followup in followups
+            if include_private or followup.is_private is False
+        ]
+        keyed: list[tuple[int, GetFollowup]] = []
+        for followup in kept:
+            if followup.id is None:
+                raise GlpiValidationError(
+                    f"A followup of ticket {ticket_id} has no id, "
+                    "so its document links cannot be read"
+                )
+            keyed.append((followup.id, followup))
+        keyed.sort(key=lambda pair: pair[0])
+        link_lists = await gather(
+            *(
+                self.list_item_documents(_FOLLOWUP_ITEMTYPE, followup_id)
+                for followup_id, _ in keyed
+            )
+        )
+        return [
+            FollowupDocuments(
+                followup=followup,
+                documents=[
+                    row
+                    for row in rows
+                    if row.itemtype == _FOLLOWUP_ITEMTYPE
+                    and row.items_id == followup_id
+                ],
+            )
+            for (followup_id, followup), rows in zip(keyed, link_lists, strict=True)
+        ]
+
     async def get_ticket_timeline_document(
         self, ticket_id: GlpiId, document_link_id: GlpiId
     ) -> GetDocument:

glpi_python_client/_sync/clients/api/assistance/timeline/_document.py

@@ -17,18 +17,36 @@ as :class:`GetDocument`.
 
 from __future__ import annotations
 
+import re
+
+from glpi_python_client._sync._concurrency import gather
 from glpi_python_client._sync.clients.commons._constants import (
     TICKET_ENDPOINT,
     TIMELINE_DOCUMENT_SUFFIX,
     GlpiId,
 )
+from glpi_python_client._sync.clients.commons._payloads import model_from_payload
 from glpi_python_client._sync.clients.commons._transport import TransportMixin
+from glpi_python_client._errors import GlpiValidationError
 from glpi_python_client.models.api_schema.assistance.timeline._document import (
     DeleteTimelineDocument,
     PatchTimelineDocument,
     PostTimelineDocument,
 )
+from glpi_python_client.models.api_schema.assistance.timeline._followup import (
+    GetFollowup,
+)
 from glpi_python_client.models.api_schema.management._document import GetDocument
+from glpi_python_client.models.api_schema.management._document_item import (
+    FollowupDocuments,
+    GetDocumentItem,
+)
+
+_ITEM_DOCUMENT_RANGE = "0-999"
+_ITEM_DOCUMENT_PAGE_SIZE = 1000
+_ITEMTYPE_PATTERN = re.compile(r"^[A-Za-z][A-Za-z0-9_]*$")
+_V1_FEATURE_LABEL = "item document link listing"
+_FOLLOWUP_ITEMTYPE = "ITILFollowup"
 
 
 class TimelineDocumentMixin(TransportMixin):
@@ -62,6 +80,173 @@ class TimelineDocumentMixin(TransportMixin):
             unwrap_envelope=True,
         )
 
+    def list_item_documents(
+        self, itemtype: str, items_id: GlpiId
+    ) -> list[GetDocumentItem]:
+        """List the document links of one item, over the legacy v1 API.
+
+        Only the followup route (``itemtype="ITILFollowup"``) has been
+        checked against a live server.  Other itemtypes are sent to the same
+        v1 sub-route unchanged.
+
+        Unlike :meth:`list_ticket_timeline_documents`, this call needs the
+        legacy v1 session (``v1_base_url`` and ``v1_user_token``).  Without
+        one it raises ``RuntimeError``.
+
+        It returns link rows, not documents.  A caller resolves each
+        ``documents_id`` with ``get_document``.
+
+        The library does not filter private followups, tasks or solutions
+        for the caller: every link the authenticated user can read is
+        returned.
+
+        GLPI's editor links an image pasted into a followup to the followup,
+        not to the ticket.  A caller that wants such images therefore walks
+        the ticket's followups and lists each one.
+
+        Parameters
+        ----------
+        itemtype : str
+            GLPI itemtype owning the links, for example ``"ITILFollowup"``.
+            It must start with a letter and contain only letters, digits and
+            underscores, because it is placed in the URL path.
+        items_id : GlpiId
+            Positive numeric identifier of the item.
+
+        Returns
+        -------
+        list[GetDocumentItem]
+            Link rows, with naive timestamps localised to the server
+            timezone.  An empty answer gives an empty list.
+
+        Raises
+        ------
+        RuntimeError
+            If the client was built without a v1 session.
+        GlpiValidationError
+            If ``itemtype`` or ``items_id`` is invalid, if GLPI answers
+            something other than a list or an empty body, or if it answers a
+            full page of 1000 rows or more, which may be truncated.  A
+            partial list is never returned.
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        v1 = self._require_v1_session(_V1_FEATURE_LABEL)
+        if not _ITEMTYPE_PATTERN.fullmatch(itemtype):
+            raise GlpiValidationError(
+                f"itemtype must match {_ITEMTYPE_PATTERN.pattern!r}, got {itemtype!r}"
+            )
+        if items_id <= 0:
+            raise GlpiValidationError(
+                f"items_id must be a positive integer, got {items_id!r}"
+            )
+        payload = v1.request_json(
+            "GET",
+            f"{itemtype}/{items_id}/Document_Item",
+            params={"range": _ITEM_DOCUMENT_RANGE},
+            failure_message=(f"Failed to list document links of {itemtype} {items_id}"),
+        )
+        if isinstance(payload, dict) and not payload:
+            return []
+        if not isinstance(payload, list):
+            raise GlpiValidationError(
+                f"Unexpected document link answer for {itemtype} {items_id}: "
+                f"{type(payload).__name__}"
+            )
+        if len(payload) >= _ITEM_DOCUMENT_PAGE_SIZE:
+            raise GlpiValidationError(
+                f"{itemtype} {items_id} returned {len(payload)} document links, "
+                "a full page that may be truncated"
+            )
+        return [
+            model_from_payload(
+                GetDocumentItem, row, server_timezone=self.server_timezone
+            )
+            for row in payload
+        ]
+
+    def list_ticket_followup_documents(
+        self, ticket_id: GlpiId, *, include_private: bool = False
+    ) -> list[FollowupDocuments]:
+        """List the document links of each followup of one ticket.
+
+        GLPI's editor links an image pasted into a followup to the followup,
+        not to the ticket. :meth:`list_ticket_timeline_documents` therefore
+        never returns such an image, and this method does.
+
+        Each entry holds the followup and its links, so a caller reads
+        ``followup.is_private`` to classify every link without a second
+        read. Only followups are walked: tasks and solutions are not.
+
+        This call needs the legacy v1 session (``v1_base_url`` and
+        ``v1_user_token``). Without one it raises ``RuntimeError``. It issues
+        one v1 request per kept followup, all at once on the asynchronous
+        surface and one after the other on the synchronous one.
+
+        Parameters
+        ----------
+        ticket_id : GlpiId
+            Numeric identifier of the parent ticket.
+        include_private : bool, optional
+            When false (the default), private followups and followups whose
+            ``is_private`` flag is missing are dropped and not queried, so
+            only what a requester can see is returned. A missing flag counts
+            as private. When true, every followup is kept.
+
+        Returns
+        -------
+        list[FollowupDocuments]
+            One entry per kept followup, in ascending followup id, including
+            a followup with no link (an empty ``documents`` list). A link row
+            that does not name that followup as its item is dropped.
+
+        Raises
+        ------
+        RuntimeError
+            If the client was built without a v1 session.
+        GlpiValidationError
+            If a kept followup has no identifier, or if reading the links of
+            a followup fails validation. A partial list is never returned.
+        GlpiStatusError
+            If the GLPI server returns a non-success HTTP status.
+        """
+
+        self._require_v1_session(_V1_FEATURE_LABEL)
+        followups = self.list_ticket_followups(ticket_id)  # type: ignore[attr-defined]
+        kept = [
+            followup
+            for followup in followups
+            if include_private or followup.is_private is False
+        ]
+        keyed: list[tuple[int, GetFollowup]] = []
+        for followup in kept:
+            if followup.id is None:
+                raise GlpiValidationError(
+                    f"A followup of ticket {ticket_id} has no id, "
+                    "so its document links cannot be read"
+                )
+            keyed.append((followup.id, followup))
+        keyed.sort(key=lambda pair: pair[0])
+        link_lists = gather(
+            *(
+                self.list_item_documents(_FOLLOWUP_ITEMTYPE, followup_id)
+                for followup_id, _ in keyed
+            )
+        )
+        return [
+            FollowupDocuments(
+                followup=followup,
+                documents=[
+                    row
+                    for row in rows
+                    if row.itemtype == _FOLLOWUP_ITEMTYPE
+                    and row.items_id == followup_id
+                ],
+            )
+            for (followup_id, followup), rows in zip(keyed, link_lists, strict=True)
+        ]
+
     def get_ticket_timeline_document(
         self, ticket_id: GlpiId, document_link_id: GlpiId
     ) -> GetDocument:

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

@@ -109,9 +109,11 @@ from glpi_python_client.models.api_schema.management import (
     DeleteContract,
     DeleteContractCost,
     DeleteDocument,
+    FollowupDocuments,
     GetContract,
     GetContractCost,
     GetDocument,
+    GetDocumentItem,
     PatchContract,
     PatchContractCost,
     PatchDocument,
@@ -149,12 +151,14 @@ __all__ = [
     "DeleteTicketTask",
     "DeleteTimelineDocument",
     "DeleteUser",
+    "FollowupDocuments",
     "GetComputer",
     "GetContract",
     "GetContractCost",
     "GetContractItem",
     "GetContractType",
     "GetDocument",
+    "GetDocumentItem",
     "GetEntity",
     "GetFollowup",
     "GetKBArticle",

glpi_python_client/models/api_schema/enums.py

@@ -135,9 +135,14 @@ class GlpiTimelinePosition(GlpiEnum):
     The contract advertises ``[-1, 0, 1, 2, 3, 4]`` on
     ``timeline_position``. ``LEFT`` and ``RIGHT`` follow the GLPI UI
     conventions.
+
+    ``NO_TIMELINE`` is GLPI's own name for ``-1`` and an alias of
+    ``INVALID``. GLPI's editor writes it on the link of an image it embeds
+    in a text, and such a link is hidden from the ticket's Documents tab.
     """
 
     INVALID = -1
+    NO_TIMELINE = -1
     NONE = 0
     LEFT = 1
     RIGHT = 2

glpi_python_client/models/api_schema/management/__init__.py

@@ -18,14 +18,20 @@ from glpi_python_client.models.api_schema.management._document import (
     PatchDocument,
     PostDocument,
 )
+from glpi_python_client.models.api_schema.management._document_item import (
+    FollowupDocuments,
+    GetDocumentItem,
+)
 
 __all__ = [
     "DeleteContract",
     "DeleteContractCost",
     "DeleteDocument",
+    "FollowupDocuments",
     "GetContract",
     "GetContractCost",
     "GetDocument",
+    "GetDocumentItem",
     "PatchContract",
     "PatchContractCost",
     "PatchDocument",

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/models/api_schema/management/_document_item.py

@@ -0,0 +1,88 @@
+"""GLPI ``Document_Item`` link rows, as the legacy v1 API returns them.
+
+A ``Document_Item`` row links one document to one item: a ticket, a followup,
+a task or a solution. The v1 sub-item route ``<Itemtype>/<id>/Document_Item``
+answers a list of these rows. They are not the ``GetTimelineDocument`` shape
+of the v2 timeline, which carries no entity and no dates.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+from pydantic import ConfigDict
+
+from glpi_python_client.models._base import GlpiModel
+from glpi_python_client.models.api_schema.assistance.timeline._followup import (
+    GetFollowup,
+)
+from glpi_python_client.models.api_schema.enums import GlpiTimelinePosition
+
+
+class GetDocumentItem(GlpiModel):
+    """One ``Document_Item`` row linking a document to an item.
+
+    Keys the model does not declare (``users_id``, ``is_recursive``,
+    ``links`` and any plugin column) are kept in ``extra_payload``.
+
+    Parameters
+    ----------
+    id : int
+        Native identifier of the link row.
+    documents_id : int
+        Identifier of the linked document.
+    itemtype : str | None, optional
+        GLPI type of the item the document is linked to, for example
+        ``"Ticket"`` or ``"ITILFollowup"``.
+    items_id : int | None, optional
+        Identifier of the item the document is linked to.
+    entities_id : int | None, optional
+        Identifier of the entity owning the link.
+    date_creation : datetime | None, optional
+        Creation timestamp of the link row.
+    date_mod : datetime | None, optional
+        Last modification timestamp of the link row.
+    date : datetime | None, optional
+        Timestamp GLPI records on the link.
+    timeline_position : GlpiTimelinePosition | None, optional
+        Position of the link in the ticket timeline. A link at
+        :attr:`GlpiTimelinePosition.NO_TIMELINE` (``-1``) is written by
+        GLPI's editor for an image it embeds in a text. Such a link is
+        hidden from the ticket's Documents tab. A document uploaded as an
+        attachment is linked at ``1``.
+    """
+
+    id: int
+    documents_id: int
+    itemtype: str | None = None
+    items_id: int | None = None
+    entities_id: int | None = None
+    date_creation: datetime | None = None
+    date_mod: datetime | None = None
+    date: datetime | None = None
+    timeline_position: GlpiTimelinePosition | None = None
+
+
+class FollowupDocuments(GlpiModel):
+    """One ticket followup together with its document links.
+
+    Returned by ``list_ticket_followup_documents``. The followup is kept
+    whole, so a caller reads ``followup.is_private`` to classify every link
+    without a second read.
+
+    Parameters
+    ----------
+    followup : GetFollowup
+        The followup, as the ticket's followup listing returned it.
+    documents : list[GetDocumentItem]
+        The ``Document_Item`` rows linked to this followup. Empty when the
+        followup has no document.
+    """
+
+    model_config = ConfigDict(extra="allow", frozen=True)
+
+    followup: GetFollowup
+    documents: list[GetDocumentItem]
+
+
+__all__ = ["FollowupDocuments", "GetDocumentItem"]

{glpi_python_client-0.6.3.dist-info → glpi_python_client-0.6.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: glpi-python-client
-Version: 0.6.3
+Version: 0.6.5
 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.3.dist-info → glpi_python_client-0.6.5.dist-info}/RECORD

@@ -1,4 +1,4 @@
-glpi_python_client/__init__.py,sha256=IMYtZ6FcQdH6IPopjnPwGlKf-nb6QjjTb1JLgq0AXYY,5538
+glpi_python_client/__init__.py,sha256=goD0YVtmpFX2_3vXrg-qOCLUgtCYwEj-wFJeP0-UfLk,5630
 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
@@ -21,7 +21,7 @@ glpi_python_client/_async/clients/api/assistance/__init__.py,sha256=nL77QpQ4Yzfd
 glpi_python_client/_async/clients/api/assistance/_team.py,sha256=QEwFTXE8W_MURi_zgfDTLoqYP__NF1SwBd_7dLJZg5U,3824
 glpi_python_client/_async/clients/api/assistance/_ticket.py,sha256=z1-kKjkSwvePZl65CXpDay50uJpirjlA1ww4_3eVyJU,7990
 glpi_python_client/_async/clients/api/assistance/timeline/__init__.py,sha256=AqB_UpcRMHjfvZyLBjkwfsnEBwz77xBbGJzXzWmS7os,619
-glpi_python_client/_async/clients/api/assistance/timeline/_document.py,sha256=3vTbAxh8ZoVmx45xId5jjcapm4124dVnhXoF84Du_8w,7334
+glpi_python_client/_async/clients/api/assistance/timeline/_document.py,sha256=BYCScaSyfrPzAh-znObYh1yEeL4dwYLYV8F0hKn6YcE,14803
 glpi_python_client/_async/clients/api/assistance/timeline/_followup.py,sha256=jgE_kpJxMa3v1Tt4Jm2PahiRNX7v3vKh6xjbX27sp7w,6221
 glpi_python_client/_async/clients/api/assistance/timeline/_solution.py,sha256=3DpbDeHDQ7FJdevhcpAcgXyB9FZu7_S2kVblFXsZUq0,6156
 glpi_python_client/_async/clients/api/assistance/timeline/_task.py,sha256=EdkrRJnkHWaZdxgyqwL1rhUygGSJScR2jIS6CFJL4S4,5869
@@ -67,7 +67,7 @@ glpi_python_client/_sync/clients/api/assistance/__init__.py,sha256=dAXVQPgCmPhCL
 glpi_python_client/_sync/clients/api/assistance/_team.py,sha256=Nk0FXUHyZZOkg62Os4FBee3Jv4YzMJoOqsvsWM0yqI0,3785
 glpi_python_client/_sync/clients/api/assistance/_ticket.py,sha256=Xuk0-8geUdII-uFdgIbkhG_QMEfOytcHp5n-Hq2D-U8,7906
 glpi_python_client/_sync/clients/api/assistance/timeline/__init__.py,sha256=d_YAwgv3r1sNrRVlPC5r1yEhbUZQKzLtuNzHD9eBF8Y,615
-glpi_python_client/_sync/clients/api/assistance/timeline/_document.py,sha256=Tqy4HCzZiZ5keXQEHt8gbA8OGAkdMqlvJ9yX0tVnknA,7272
+glpi_python_client/_sync/clients/api/assistance/timeline/_document.py,sha256=0T7wEyVNoECI8c0LUZ1WQtXgvpRBKyl-GTsB4jdJ2xA,14709
 glpi_python_client/_sync/clients/api/assistance/timeline/_followup.py,sha256=trQJJThA8jk2jVK-jTW8uPZyYEvR5Zi18mqGT6436VM,6158
 glpi_python_client/_sync/clients/api/assistance/timeline/_solution.py,sha256=KVyrjKFS35lJzvjwEromOEL2Q2OfvLP7MvhV7QirtVs,6093
 glpi_python_client/_sync/clients/api/assistance/timeline/_task.py,sha256=peSQmKYoHc9IVdQltBaDqFFHZKdBzWJwt_0GXng2odU,5806
@@ -95,13 +95,13 @@ 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=b6DPZtH0CxyBUnVB0x9vP9AMBIjgubDFm_1TOQuCiVA,5362
+glpi_python_client/content/conversion.py,sha256=0dxQW0ojSo1KC8zcTFa476KQa1i3sLWzQ8gTEEVslys,45341
+glpi_python_client/models/__init__.py,sha256=CLvk-1A-88114X7HaS9P6KyfovQjCPRX08J56rJaGls,5454
 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=WDdEhnB_-ZggvY0RTnAX6C6bN8extGzpE9An-Nk5QuQ,4834
+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/_entity.py,sha256=KdbxMyPXumGZKmmabDIciF3nFS61pLRp5SBOTFa8slk,3297
 glpi_python_client/models/api_schema/administration/_user.py,sha256=MQ6cHKdni98sjm-Whf0GKdGpNjPgGGJpUBgVjlGa19Q,15872
@@ -124,10 +124,11 @@ glpi_python_client/models/api_schema/knowledgebase/_article.py,sha256=zNLnkkdfGj
 glpi_python_client/models/api_schema/knowledgebase/_category.py,sha256=bokNV56PTULFCAzV8dxLOAl8Nk2yCI5Lmb3RLGm0zTM,2260
 glpi_python_client/models/api_schema/knowledgebase/_comment.py,sha256=mouYQE2AigGpJY0jTu9KoqOa4xT0_ckj0h6XDfY7mqc,2325
 glpi_python_client/models/api_schema/knowledgebase/_revision.py,sha256=KuTb_F85mc63RHpQ1VFsmM-eDBjUrxAEdLM48-WmWYs,1985
-glpi_python_client/models/api_schema/management/__init__.py,sha256=mI39635e4_IgpaYNOXZotZ_xIXPH8oE1FXno6cvr-pY,816
+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
 glpi_python_client/models/custom_schema/__init__.py,sha256=Usp592x9OWws30vU1rEXbkkRBhcgytM5nxRPTB1gqhY,500
@@ -135,7 +136,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.3.dist-info/METADATA,sha256=4RZb8YHJdpzGHRZpengz0BnNOWHWaTzEDFgmc1WyDss,8234
-glpi_python_client-0.6.3.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-glpi_python_client-0.6.3.dist-info/licenses/LICENSE,sha256=nL8re-TIKkxCoL7OkSBja6EB4NsQR1HoOJgxv_MEhtc,1088
-glpi_python_client-0.6.3.dist-info/RECORD,,
+glpi_python_client-0.6.5.dist-info/METADATA,sha256=xKVBulZ8pipAYJLr8FuRcAM1M21XFiM9PGGq3PNMeZE,8234
+glpi_python_client-0.6.5.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+glpi_python_client-0.6.5.dist-info/licenses/LICENSE,sha256=nL8re-TIKkxCoL7OkSBja6EB4NsQR1HoOJgxv_MEhtc,1088
+glpi_python_client-0.6.5.dist-info/RECORD,,