API Reference
=============

This reference documents the public package surface exported by
``glpi_python_client``. Internal implementation modules and
underscore-prefixed helpers are intentionally omitted.

.. currentmodule:: glpi_python_client

Clients
-------

The package exposes two clients with identical endpoint surfaces. The
synchronous one is the single source of truth for endpoint behaviour;
the asynchronous one wraps each synchronous method into a coroutine.

.. autoclass:: GlpiClient
   :members:
   :inherited-members:
   :show-inheritance:

.. autoclass:: AsyncGlpiClient
   :members:
   :inherited-members:
   :show-inheritance:

.. autoclass:: glpi_python_client.clients.commons._async_bridge.AsyncBridge
   :members:
   :show-inheritance:

Aggregated Models
-----------------

.. autoclass:: GlpiTicketContext
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: TicketMarkdownOptions
   :members:
   :undoc-members:
   :show-inheritance:

Common Reference Models
-----------------------

.. autoclass:: IdRef
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: IdNameRef
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: IdNameCompletenameRef
   :members:
   :undoc-members:
   :show-inheritance:

Tickets
-------

.. autoclass:: GetTicket
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostTicket
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchTicket
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteTicket
   :members:
   :undoc-members:
   :show-inheritance:

Ticket Timeline — Followups
---------------------------

.. autoclass:: GetFollowup
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostFollowup
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchFollowup
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteFollowup
   :members:
   :undoc-members:
   :show-inheritance:

Ticket Timeline — Tasks
-----------------------

.. autoclass:: GetTicketTask
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostTicketTask
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchTicketTask
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteTicketTask
   :members:
   :undoc-members:
   :show-inheritance:

Ticket Timeline — Solutions
---------------------------

.. autoclass:: GetSolution
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostSolution
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchSolution
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteSolution
   :members:
   :undoc-members:
   :show-inheritance:

Ticket Timeline — Documents
---------------------------

.. autoclass:: GetTimelineDocument
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostTimelineDocument
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchTimelineDocument
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteTimelineDocument
   :members:
   :undoc-members:
   :show-inheritance:

Ticket Team Members
-------------------

.. autoclass:: GetTeamMember
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostTeamMember
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchTeamMember
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteTeamMember
   :members:
   :undoc-members:
   :show-inheritance:

Documents
---------

.. autoclass:: GetDocument
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostDocument
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchDocument
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteDocument
   :members:
   :undoc-members:
   :show-inheritance:

Users
-----

.. autoclass:: GetUser
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostUser
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchUser
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteUser
   :members:
   :undoc-members:
   :show-inheritance:

Locations
---------

.. autoclass:: GetLocation
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostLocation
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchLocation
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteLocation
   :members:
   :undoc-members:
   :show-inheritance:

Entities
--------

.. autoclass:: GetEntity
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostEntity
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PatchEntity
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: DeleteEntity
   :members:
   :undoc-members:
   :show-inheritance:

Plugin: Fields (custom fields)
------------------------------

Schemas returned by the GLPI ``Fields`` plugin (legacy v1 REST endpoints).
The companion mixin methods are exposed on :class:`GlpiClient` /
:class:`AsyncGlpiClient` as ``list_plugin_fields_containers``,
``list_plugin_fields_fields``, ``list_item_plugin_field_rows``,
``create_item_plugin_field_row``, ``update_item_plugin_field_row``,
``get_ticket_custom_fields`` and ``set_ticket_custom_fields``.

.. autoclass:: GetPluginFieldsContainer
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GetPluginFieldsField
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GetPluginFieldsValueRow
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: PostPluginFieldsValueRow
   :members:
   :undoc-members:
   :show-inheritance:

Enums
-----

.. autoclass:: GlpiEnum
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GlpiTicketStatus
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GlpiTicketType
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GlpiPriority
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GlpiTaskState
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GlpiSolutionStatus
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GlpiTimelinePosition
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GlpiUserAuthType
   :members:
   :undoc-members:
   :show-inheritance:

.. autoclass:: GlpiGlobalValidation
   :members:
   :undoc-members:
   :show-inheritance:

Package Metadata
----------------

.. autodata:: __version__