glpi-python-client 0.3.2__tar.gz → 0.3.3__tar.gz

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/.gitignore

@@ -26,5 +26,6 @@ dist/
 secrets/
 secrets/*
 
-integration_tests/
-integration_tests/*
+.claude/
+
+CLAUDE.md

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: glpi-python-client
-Version: 0.3.2
+Version: 0.3.3
 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.3.3/docs/development_rtd.rst

@@ -0,0 +1,162 @@
+Development
+===========
+
+Local Setup
+-----------
+
+Create a virtual environment and install the development dependencies:
+
+.. code-block:: console
+
+   python -m venv .venv
+   .venv\Scripts\activate
+   python -m pip install --upgrade pip
+   python -m pip install -e .[dev]
+   python -m pre_commit install
+
+The repository ships a root ``.pre-commit-config.yaml`` that runs Ruff on each
+commit. The lint hook applies safe fixes first, then Ruff formats the touched
+files.
+
+Quality Checks
+--------------
+
+Run the focused checks before opening a pull request:
+
+.. code-block:: console
+
+   python -m pre_commit run --all-files
+   python -m pytest
+   python -m ruff check .
+   python -m mypy glpi_python_client
+   python -m sphinx -b html docs docs/_build/html
+
+Integration Tests
+-----------------
+
+The ``integration_tests/`` directory holds end-to-end tests that drive a live
+GLPI instance through the synchronous and asynchronous clients. They are
+collected only when secrets resolve to a reachable instance; otherwise each
+test self-skips via ``pytest.skip``. Every test cleans up the records it
+creates in a ``finally`` block, but it is still recommended to point them at
+a non-production GLPI.
+
+Markers and CI behaviour
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+All integration tests are tagged with the ``integration`` pytest marker
+declared in ``pyproject.toml``. The ``ci.yml`` workflow runs
+``pytest -m "not integration"`` for both the test matrix and the coverage
+job, so the public CI never reaches a live GLPI. The default local
+``python -m pytest`` invocation *does* attempt to collect them, but they
+skip automatically when no secrets are configured.
+
+To explicitly opt in or out locally:
+
+.. code-block:: console
+
+   python -m pytest -m integration       # run only the live suite
+   python -m pytest -m "not integration" # mirror the CI behaviour
+
+Configuration
+~~~~~~~~~~~~~
+
+The suite reads each value from a file named after the secret under
+``secrets/`` at the repository root, falling back to the matching
+environment variable when the file is absent. The ``secrets/`` directory is
+gitignored. Each file contains a single trimmed value.
+
+Required:
+
+==============================  =========================  ===========================================
+Secret file                     Environment variable       Purpose
+==============================  =========================  ===========================================
+``glpi_api_url``                ``GLPI_API_URL``           Base URL of the GLPI v2 API.
+``glpi_client_id_test``         ``GLPI_CLIENT_ID``         OAuth2 client identifier.
+``glpi_client_secret_test``     ``GLPI_CLIENT_SECRET``     OAuth2 client secret.
+``glpi_username``               ``GLPI_USERNAME``          GLPI user for the password grant.
+``glpi_password``               ``GLPI_PASSWORD``          Password for the GLPI user above.
+==============================  =========================  ===========================================
+
+Optional:
+
+==============================  =============================  ============================================
+Secret file                     Environment variable           Purpose
+==============================  =============================  ============================================
+``glpi_verify_ssl``             ``GLPI_VERIFY_SSL``            Toggle TLS verification (default ``false``).
+``glpi_entity``                 ``GLPI_ENTITY``                Active entity id sent on every request.
+``glpi_profile``                ``GLPI_PROFILE``               Active profile id sent on every request.
+``glpi_entity_recursive``       ``GLPI_ENTITY_RECURSIVE``      Include sub-entities (default ``false``).
+``glpi_api_v1_url``             ``GLPI_API_V1_URL``            Base URL of the legacy v1 API.
+``glpi_api_v1_token_user``      ``GLPI_V1_USER_TOKEN``         v1 user token (enables document uploads).
+``glpi_api_v1_app_token``       ``GLPI_V1_APP_TOKEN``          v1 application token paired with the above.
+``glpi_team_member_role``       ``GLPI_TEAM_MEMBER_ROLE``      Role used to add the test user to a ticket.
+==============================  =============================  ============================================
+
+The v1 secrets are only required for the document-upload test; when they
+are missing that single test skips while the rest of the suite runs.
+
+Running the suite
+~~~~~~~~~~~~~~~~~
+
+Once secrets are in place:
+
+.. code-block:: console
+
+   python -m pytest integration_tests -m integration
+
+Use a disposable GLPI instance or one whose entity is dedicated to
+automated tests. The suite creates and deletes users, locations, tickets,
+followups, tasks, and solutions on every run.
+
+Package Layout
+--------------
+
+``glpi_python_client.__init__``
+   Public import surface (``GlpiClient``, ``GlpiTicketContext``, public Pydantic
+   models, enums, and ``__version__``).
+
+``glpi_python_client.clients.glpi_client``
+   Composition root. ``GlpiClient`` mixes the per-resource async API mixins,
+   the OAuth2 token manager, the asynchronous v2 transport, and the optional
+   internal v1 session used for document uploads.
+
+``glpi_python_client.clients.api``
+   Async API mixins generated from the GLPI v2 OpenAPI contract: tickets,
+   ticket timeline (followups, tasks, solutions, documents), team members,
+   documents, users, locations, entities, ...
+
+``glpi_python_client.clients.custom``
+   Higher-level helpers built on top of the contract mixins:
+   ``get_ticket_context``, ``get_ticket_statistics``, ``get_task_statistics``.
+
+``glpi_python_client.clients.commons``
+   Shared HTTP transport pieces, including the timeline envelope unwrap that
+   reconciles live server behaviour with the OpenAPI contract.
+
+``glpi_python_client.models.api_schema``
+   Contract-aligned Pydantic v2 models (``Get``/``Post``/``Patch``/``Delete``)
+   for each GLPI v2 resource.
+
+``glpi_python_client.models.custom_schema``
+   Composite models such as ``GlpiTicketContext`` returned by the custom
+   helpers.
+
+Adding Endpoints
+----------------
+
+#. Add or extend the contract-aligned models in
+   ``glpi_python_client.models.api_schema``.
+#. Add the async mixin and method under ``glpi_python_client.clients.api``,
+   mirroring the OpenAPI path and HTTP verb.
+#. When the live server diverges from the contract, document the choice in the
+   module docstring and (when needed) wire an unwrap helper from
+   ``glpi_python_client.clients.commons``.
+#. Re-export new public symbols from ``glpi_python_client.__init__``.
+#. Add tests for payload serialization, response parsing, and client behaviour.
+#. Document the workflow in :doc:`user_guide` and the matching skill in
+   ``skills/``.
+
+Keep organization-specific entity, profile, and category defaults outside the
+library core. Applications can apply their own mapping before calling the
+client.

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/docs/user_guide.rst

@@ -776,6 +776,14 @@ batches until the API returns fewer rows than the requested
            print(ticket.id, ticket.name)
    print(f"processed {total} tickets")
 
+.. note::
+
+   Always pass an RSQL filter to ``iter_search_tickets``. Querying
+   without any filter can return very large result sets and may cause
+   the GLPI server to return a 500 error on busy instances. The other
+   two generators (``iter_search_users``, ``iter_search_entities``) are
+   not affected because those collections are typically much smaller.
+
 On the asynchronous client the same helpers are exposed as **async
 generators** through the bridge, so each ``next()`` call runs off the
 event loop and the consumer uses ``async for``:
@@ -790,8 +798,10 @@ event loop and the consumer uses ``async for``:
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Counts tickets created within an ISO date window and groups them by
-entity, status, priority, and type. Optional filters restrict the
-result set on the server side:
+entity, status, priority, and type. The ``start_date`` is inclusive
+from 00:00:00 and the ``end_date`` is inclusive through 23:59:59, so
+tickets created at any time on those days are counted. Optional
+filters restrict the result set on the server side:
 
 * ``entity_id`` — restrict to a single entity by numeric identifier.
 * ``entity_name`` — substring match against the entity ``name`` column;
@@ -893,7 +903,9 @@ then computes per-user and per-entity totals.
 Available filters:
 
 * ``start_date`` / ``end_date`` / ``default_days`` — ISO ``YYYY-MM-DD``
-  date window; ``default_days`` is used when ``start_date`` is omitted.
+  date window; ``start_date`` is inclusive from 00:00:00,
+  ``end_date`` is inclusive through 23:59:59, and ``default_days``
+  is used when ``start_date`` is omitted.
 * ``entity_id`` — restrict to a single entity by identifier.
 * ``entity_name`` — substring match resolved through ``search_entities``;
   ignored when ``entity_id`` is given.

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/glpi_python_client/__init__.py

@@ -72,7 +72,7 @@ from glpi_python_client.models import (
     TicketMarkdownOptions,
 )
 
-__version__ = "0.3.2"
+__version__ = "0.3.3"
 
 __all__ = [
     "AsyncGlpiClient",

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/glpi_python_client/clients/api/assistance/timeline/_document.py

@@ -7,11 +7,12 @@ Notes
 -----
 The live GLPI v2 server returns each entry of the list endpoint wrapped
 in a ``{"type": "Document_Item", "item": {...}}`` envelope, even though
-the OpenAPI contract documents a flat array of ``Document_Item``. Real
-behaviour wins over the contract, so :func:`list_ticket_timeline_documents`
-unwraps the envelope through the shared
-:meth:`~glpi_python_client.clients.commons._transport.TransportMixin._resource_list`
-helper and tolerates both shapes.
+the OpenAPI contract documents a flat array of ``Document_Item``.  The
+``item`` value is a full ``Document`` record (matching :class:`GetDocument`),
+not a ``Document_Item`` link record — real behaviour wins over the contract.
+:func:`list_ticket_timeline_documents` unwraps the envelope through the shared
+``TransportMixin._resource_list`` helper and deserialises each inner object
+as :class:`GetDocument`.
 """
 
 from __future__ import annotations
@@ -24,19 +25,17 @@ from glpi_python_client.clients.commons._constants import (
 from glpi_python_client.clients.commons._transport import TransportMixin
 from glpi_python_client.models.api_schema.assistance.timeline._document import (
     DeleteTimelineDocument,
-    GetTimelineDocument,
     PatchTimelineDocument,
     PostTimelineDocument,
 )
+from glpi_python_client.models.api_schema.management._document import GetDocument
 
 
 class TimelineDocumentMixin(TransportMixin):
     """Synchronous CRUD helpers for the ticket document timeline endpoint."""
 
-    def list_ticket_timeline_documents(
-        self, ticket_id: GlpiId
-    ) -> list[GetTimelineDocument]:
-        """List all timeline documents linked to one ticket.
+    def list_ticket_timeline_documents(self, ticket_id: GlpiId) -> list[GetDocument]:
+        """List all documents linked to one ticket timeline.
 
         Parameters
         ----------
@@ -45,14 +44,16 @@ class TimelineDocumentMixin(TransportMixin):
 
         Returns
         -------
-        list[GetTimelineDocument]
-            Document links returned by the GLPI server, with the timeline
-            envelope unwrapped where present.
+        list[GetDocument]
+            Document records returned by the GLPI server.  The live API
+            wraps each entry in a ``{"type": "Document_Item", "item": {...}}``
+            envelope whose ``item`` value is a full ``Document`` record; the
+            envelope is unwrapped automatically.
         """
 
         return self._resource_list(
             f"{TICKET_ENDPOINT}/{ticket_id}/{TIMELINE_DOCUMENT_SUFFIX}",
-            GetTimelineDocument,
+            GetDocument,
             failure_message=(
                 f"Failed to list timeline documents for ticket {ticket_id}"
             ),
@@ -61,20 +62,20 @@ class TimelineDocumentMixin(TransportMixin):
 
     def get_ticket_timeline_document(
         self, ticket_id: GlpiId, document_link_id: GlpiId
-    ) -> GetTimelineDocument:
-        """Fetch one timeline document link by identifier.
+    ) -> GetDocument:
+        """Fetch one document linked to the ticket timeline by its document ID.
 
         Parameters
         ----------
         ticket_id : GlpiId
             Numeric identifier of the parent ticket.
         document_link_id : GlpiId
-            Numeric identifier of the timeline document link to retrieve.
+            Numeric identifier of the linked document to retrieve.
 
         Returns
         -------
-        GetTimelineDocument
-            Validated document-link payload.
+        GetDocument
+            Validated document payload.
 
         Raises
         ------
@@ -85,7 +86,7 @@ class TimelineDocumentMixin(TransportMixin):
         return self._resource_get(
             f"{TICKET_ENDPOINT}/{ticket_id}/"
             f"{TIMELINE_DOCUMENT_SUFFIX}/{document_link_id}",
-            GetTimelineDocument,
+            GetDocument,
             failure_message=(
                 f"Failed to get timeline document {document_link_id} on "
                 f"ticket {ticket_id}"

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/glpi_python_client/clients/custom/_statistics.py

@@ -95,10 +95,12 @@ class StatisticsMixin(TransportMixin):
         Parameters
         ----------
         start_date : str | None, optional
-            ISO ``YYYY-MM-DD`` start of the window. Defaults to
-            ``end_date - default_days + 1`` when omitted.
+            ISO ``YYYY-MM-DD`` start of the window (inclusive from
+            00:00:00). Defaults to ``end_date - default_days + 1``
+            when omitted.
         end_date : str | None, optional
-            ISO ``YYYY-MM-DD`` end of the window. Defaults to today.
+            ISO ``YYYY-MM-DD`` end of the window (inclusive through
+            23:59:59). Defaults to today.
         default_days : int, optional
             Span in days used when ``start_date`` is omitted (defaults
             to 30 and must be a positive integer).
@@ -147,9 +149,10 @@ class StatisticsMixin(TransportMixin):
             entity_filter = rsql_any_filter(
                 *(f"entities_id=={e.id}" for e in entities if e.id is not None)
             )
-
+        date_filter = f"date_creation=ge={start.isoformat()};"
+        date_filter += f"date_creation=le={end.isoformat()} 23:59:59"
         query = rsql_all_filter(
-            f"date_creation=ge={start.isoformat()};date_creation=le={end.isoformat()}",
+            date_filter,
             entity_filter,
             extra_filter,
         )
@@ -226,10 +229,12 @@ class StatisticsMixin(TransportMixin):
         Parameters
         ----------
         start_date : str | None, optional
-            ISO ``YYYY-MM-DD`` start of the window. Defaults to
-            ``end_date - default_days + 1`` when omitted.
+            ISO ``YYYY-MM-DD`` start of the window (inclusive from
+            00:00:00). Defaults to ``end_date - default_days + 1``
+            when omitted.
         end_date : str | None, optional
-            ISO ``YYYY-MM-DD`` end of the window. Defaults to today.
+            ISO ``YYYY-MM-DD`` end of the window (inclusive through
+            23:59:59). Defaults to today.
         default_days : int, optional
             Span in days used when ``start_date`` is omitted (defaults
             to 30 and must be a positive integer).
@@ -269,9 +274,8 @@ class StatisticsMixin(TransportMixin):
             end_date=end_date,
             default_days=default_days,
         )
-        date_filter = (
-            f"date_creation=ge={start.isoformat()};date_creation=le={end.isoformat()}"
-        )
+        date_filter = f"date_creation=ge={start.isoformat()};"
+        date_filter += f"date_creation=le={end.isoformat()} 23:59:59"
 
         entity_filter: str | None = None
         if entity_id is not None:
@@ -399,9 +403,11 @@ class StatisticsMixin(TransportMixin):
         firstname : str | None, optional
             Filter by given name (substring match).
         start_date : str | None, optional
-            ISO ``YYYY-MM-DD`` start of the activity window.
+            ISO ``YYYY-MM-DD`` start of the activity window (inclusive
+            from 00:00:00).
         end_date : str | None, optional
-            ISO ``YYYY-MM-DD`` end of the activity window. Defaults to today.
+            ISO ``YYYY-MM-DD`` end of the activity window (inclusive
+            through 23:59:59). Defaults to today.
         default_days : int, optional
             Span in days used when ``start_date`` is omitted (default 30).
 
@@ -460,9 +466,8 @@ class StatisticsMixin(TransportMixin):
                 if u.id is not None
             }
 
-        date_range = (
-            f"date_creation=ge={start.isoformat()};date_creation=le={end.isoformat()}"
-        )
+        date_range = f"date_creation=ge={start.isoformat()};"
+        date_range += f"date_creation=le={end.isoformat()} 23:59:59"
 
         users_output: dict[str, UserActivityEntry] = {}
         for uid in resolved_user_ids:

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/glpi_python_client/clients/custom/_statistics_async.py

@@ -102,9 +102,11 @@ class AsyncStatisticsMixin(StatisticsMixin):
         Parameters
         ----------
         start_date : str | None, optional
-            ISO ``YYYY-MM-DD`` start of the window.
+            ISO ``YYYY-MM-DD`` start of the window (inclusive from
+            00:00:00).
         end_date : str | None, optional
-            ISO ``YYYY-MM-DD`` end of the window.
+            ISO ``YYYY-MM-DD`` end of the window (inclusive through
+            23:59:59). Defaults to today.
         default_days : int, optional
             Span in days used when ``start_date`` is omitted (default 30).
         entity_id : int | None, optional
@@ -143,10 +145,8 @@ class AsyncStatisticsMixin(StatisticsMixin):
             end_date=end_date,
             default_days=default_days,
         )
-        date_filter = (
-            f"date_creation=ge={start.isoformat()};date_creation=le={end.isoformat()}"
-        )
-
+        date_filter = f"date_creation=ge={start.isoformat()};"
+        date_filter += f"date_creation=le={end.isoformat()} 23:59:59"
         entity_filter: str | None = None
         if entity_id is not None:
             entity_filter = f"entities_id=={entity_id}"
@@ -274,9 +274,11 @@ class AsyncStatisticsMixin(StatisticsMixin):
         Parameters
         ----------
         start_date : str | None, optional
-            ISO ``YYYY-MM-DD`` start of the window.
+            ISO ``YYYY-MM-DD`` start of the window (inclusive from
+            00:00:00).
         end_date : str | None, optional
-            ISO ``YYYY-MM-DD`` end of the window. Defaults to today.
+            ISO ``YYYY-MM-DD`` end of the window (inclusive through
+            23:59:59). Defaults to today.
         default_days : int, optional
             Span in days used when ``start_date`` is omitted (default 30).
         entity_id : int | None, optional
@@ -328,8 +330,10 @@ class AsyncStatisticsMixin(StatisticsMixin):
                 *(f"entities_id=={e.id}" for e in entities if e.id is not None)
             )
 
+        date_filter = f"date_creation=ge={start.isoformat()};"
+        date_filter += f"date_creation=le={end.isoformat()} 23:59:59"
         query = rsql_all_filter(
-            f"date_creation=ge={start.isoformat()};date_creation=le={end.isoformat()}",
+            date_filter,
             entity_filter,
             extra_filter,
         )
@@ -369,9 +373,11 @@ class AsyncStatisticsMixin(StatisticsMixin):
         firstname : str | None, optional
             Filter by given name (substring match).
         start_date : str | None, optional
-            ISO ``YYYY-MM-DD`` start of the activity window.
+            ISO ``YYYY-MM-DD`` start of the activity window (inclusive
+            from 00:00:00).
         end_date : str | None, optional
-            ISO ``YYYY-MM-DD`` end of the activity window. Defaults to today.
+            ISO ``YYYY-MM-DD`` end of the activity window (inclusive
+            through 23:59:59). Defaults to today.
         default_days : int, optional
             Span in days used when ``start_date`` is omitted (default 30).
 
@@ -438,9 +444,8 @@ class AsyncStatisticsMixin(StatisticsMixin):
                 if u.id is not None
             }
 
-        date_range = (
-            f"date_creation=ge={start.isoformat()};date_creation=le={end.isoformat()}"
-        )
+        date_range = f"date_creation=ge={start.isoformat()};"
+        date_range += f"date_creation=le={end.isoformat()} 23:59:59"
 
         users_output: dict[str, UserActivityEntry] = {}
         for uid in resolved_user_ids:

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/glpi_python_client/clients/custom/tests/test_statistics.py

@@ -130,7 +130,7 @@ def test_get_ticket_statistics_default_window_uses_today(
     end = date.today()
     start = end - timedelta(days=6)
     assert f"date_creation=ge={start.isoformat()}" in captured["filter"]
-    assert f"date_creation=le={end.isoformat()}" in captured["filter"]
+    assert f"date_creation=le={end.isoformat()} 23:59:59" in captured["filter"]
 
 
 def test_get_ticket_statistics_rejects_invalid_window(client: GlpiClient) -> None:
@@ -306,7 +306,7 @@ def test_get_ticket_statistics_default_days_window(client: GlpiClient) -> None:
     end = date.today()
     start = end - timedelta(days=13)
     assert f"date_creation=ge={start.isoformat()}" in captured["filter"]
-    assert f"date_creation=le={end.isoformat()}" in captured["filter"]
+    assert f"date_creation=le={end.isoformat()} 23:59:59" in captured["filter"]
 
 
 # ---------------------------------------------------------------------------

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/glpi_python_client/clients/tests/test_api_coverage.py

@@ -570,7 +570,7 @@ def test_list_get_update_unlink_timeline_documents(client: GlpiClient) -> None:
 
     rec = _Recorder(
         get_payload=[
-            {"type": "Document_Item", "item": {"id": 1, "documents_id": 99}},
+            {"type": "Document_Item", "item": {"id": 1, "filename": "report.txt"}},
         ]
     )
     rec.install(client)
@@ -578,7 +578,7 @@ def test_list_get_update_unlink_timeline_documents(client: GlpiClient) -> None:
     assert items[0].id == 1
     assert rec.calls[0]["endpoint"] == "Assistance/Ticket/7/Timeline/Document"
 
-    rec._get_payload = {"id": 1, "documents_id": 99}  # type: ignore[attr-defined]
+    rec._get_payload = {"id": 1, "filename": "report.txt"}  # type: ignore[attr-defined]
     doc = client.get_ticket_timeline_document(7, 1)
     assert doc.id == 1
 

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/glpi_python_client/models/custom_schema/_ticket_context.py

@@ -18,9 +18,6 @@ from pydantic import Field
 from glpi_python_client.models._base import GlpiModel
 from glpi_python_client.models.api_schema._common import IdNameRef
 from glpi_python_client.models.api_schema.assistance._ticket import GetTicket
-from glpi_python_client.models.api_schema.assistance.timeline._document import (
-    GetTimelineDocument,
-)
 from glpi_python_client.models.api_schema.assistance.timeline._followup import (
     GetFollowup,
 )
@@ -30,6 +27,7 @@ from glpi_python_client.models.api_schema.assistance.timeline._solution import (
 from glpi_python_client.models.api_schema.assistance.timeline._task import (
     GetTicketTask,
 )
+from glpi_python_client.models.api_schema.management._document import GetDocument
 
 _MAX_DATETIME = datetime.max
 
@@ -184,15 +182,15 @@ class GlpiTicketContext(GlpiModel):
         Linked followup records.
     solutions : list[GetSolution], optional
         Linked solution records.
-    documents : list[GetTimelineDocument], optional
-        Linked timeline document records.
+    documents : list[GetDocument], optional
+        Linked document records.
     """
 
     ticket: GetTicket
     tasks: list[GetTicketTask] = Field(default_factory=list)
     followups: list[GetFollowup] = Field(default_factory=list)
     solutions: list[GetSolution] = Field(default_factory=list)
-    documents: list[GetTimelineDocument] = Field(default_factory=list)
+    documents: list[GetDocument] = Field(default_factory=list)
 
     def to_markdown(
         self,
@@ -331,9 +329,14 @@ class GlpiTicketContext(GlpiModel):
             lines.append("")
             lines.append("## Documents")
             for document in self.documents:
-                identifier = document.documents_id or document.id
-                label = document.filepath or (
-                    f"document #{identifier}" if identifier is not None else "document"
+                label = (
+                    document.filename
+                    or document.name
+                    or (
+                        f"document #{document.id}"
+                        if document.id is not None
+                        else "document"
+                    )
                 )
                 lines.append(f"- {label}")
 

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/glpi_python_client/models/custom_schema/tests/test_ticket_context.py

@@ -38,11 +38,11 @@ def test_ticket_context_accepts_timeline_records() -> None:
         "tasks": [{"id": 11, "content": "<p>do</p>"}],
         "followups": [{"id": 12, "content": "<p>note</p>"}],
         "solutions": [{"id": 13, "content": "<p>fix</p>"}],
-        "documents": [{"id": 14, "documents_id": 99}],
+        "documents": [{"id": 14, "filename": "report.pdf"}],
     }
     context = GlpiTicketContext.model_validate(payload)
     assert context.tasks[0].id == 11
-    assert context.documents[0].documents_id == 99
+    assert context.documents[0].filename == "report.pdf"
 
 
 def test_to_markdown_renders_header_and_status() -> None:
@@ -151,8 +151,8 @@ def test_to_markdown_renders_solution_and_documents() -> None:
             "ticket": {"id": 7, "name": "Reset"},
             "solutions": [{"id": 4, "content": "All fixed"}],
             "documents": [
-                {"id": 11, "documents_id": 99, "filepath": "logs/run.txt"},
-                {"id": 12, "documents_id": 100},
+                {"id": 11, "filename": "run.txt"},
+                {"id": 12},
             ],
         }
     )
@@ -160,8 +160,8 @@ def test_to_markdown_renders_solution_and_documents() -> None:
     assert "### Solution #4" in rendered
     assert "All fixed" in rendered
     assert "## Documents" in rendered
-    assert "- logs/run.txt" in rendered
-    assert "- document #100" in rendered
+    assert "- run.txt" in rendered
+    assert "- document #12" in rendered
 
 
 def test_to_markdown_handles_empty_timeline() -> None:
@@ -232,7 +232,7 @@ _FULL_PAYLOAD = {
     "followups": [{"id": 10, "content": "followup body"}],
     "tasks": [{"id": 20, "content": "task body", "duration": 600}],
     "solutions": [{"id": 30, "content": "solution body"}],
-    "documents": [{"id": 40, "documents_id": 99, "filepath": "file.txt"}],
+    "documents": [{"id": 40, "filename": "file.txt"}],
 }
 
 

{glpi_python_client-0.3.2 → glpi_python_client-0.3.3}/pyproject.toml

@@ -25,7 +25,7 @@ exclude = [
 
 [project]
 name = "glpi-python-client"
-version = "0.3.2"
+version = "0.3.3"
 description = "A typed Python client for GLPI ITSM APIs."
 readme = "README.md"
 requires-python = ">=3.10"

glpi_python_client-0.3.2/docs/development_rtd.rst

@@ -1,84 +0,0 @@
-Development
-===========
-
-Local Setup
------------
-
-Create a virtual environment and install the development dependencies:
-
-.. code-block:: console
-
-   python -m venv .venv
-   .venv\Scripts\activate
-   python -m pip install --upgrade pip
-   python -m pip install -e .[dev]
-   python -m pre_commit install
-
-The repository ships a root ``.pre-commit-config.yaml`` that runs Ruff on each
-commit. The lint hook applies safe fixes first, then Ruff formats the touched
-files.
-
-Quality Checks
---------------
-
-Run the focused checks before opening a pull request:
-
-.. code-block:: console
-
-   python -m pre_commit run --all-files
-   python -m pytest
-   python -m ruff check .
-   python -m mypy glpi_python_client
-   python -m sphinx -b html docs docs/_build/html
-
-Package Layout
---------------
-
-``glpi_python_client.__init__``
-   Public import surface (``GlpiClient``, ``GlpiTicketContext``, public Pydantic
-   models, enums, and ``__version__``).
-
-``glpi_python_client.clients.glpi_client``
-   Composition root. ``GlpiClient`` mixes the per-resource async API mixins,
-   the OAuth2 token manager, the asynchronous v2 transport, and the optional
-   internal v1 session used for document uploads.
-
-``glpi_python_client.clients.api``
-   Async API mixins generated from the GLPI v2 OpenAPI contract: tickets,
-   ticket timeline (followups, tasks, solutions, documents), team members,
-   documents, users, locations, entities, ...
-
-``glpi_python_client.clients.custom``
-   Higher-level helpers built on top of the contract mixins:
-   ``get_ticket_context``, ``get_ticket_statistics``, ``get_task_statistics``.
-
-``glpi_python_client.clients.commons``
-   Shared HTTP transport pieces, including the timeline envelope unwrap that
-   reconciles live server behaviour with the OpenAPI contract.
-
-``glpi_python_client.models.api_schema``
-   Contract-aligned Pydantic v2 models (``Get``/``Post``/``Patch``/``Delete``)
-   for each GLPI v2 resource.
-
-``glpi_python_client.models.custom_schema``
-   Composite models such as ``GlpiTicketContext`` returned by the custom
-   helpers.
-
-Adding Endpoints
-----------------
-
-#. Add or extend the contract-aligned models in
-   ``glpi_python_client.models.api_schema``.
-#. Add the async mixin and method under ``glpi_python_client.clients.api``,
-   mirroring the OpenAPI path and HTTP verb.
-#. When the live server diverges from the contract, document the choice in the
-   module docstring and (when needed) wire an unwrap helper from
-   ``glpi_python_client.clients.commons``.
-#. Re-export new public symbols from ``glpi_python_client.__init__``.
-#. Add tests for payload serialization, response parsing, and client behaviour.
-#. Document the workflow in :doc:`user_guide` and the matching skill in
-   ``skills/``.
-
-Keep organization-specific entity, profile, and category defaults outside the
-library core. Applications can apply their own mapping before calling the
-client.