zendesk_sdk.client
==================

.. py:module:: zendesk_sdk.client

.. autoapi-nested-parse::

   Zendesk API client.



Classes
-------

.. autoapisummary::

   zendesk_sdk.client.ZendeskServices


Module Contents
---------------

.. py:class:: ZendeskServices(base_url: str, username: str, password: str, timeout: float)

   A class wrapping Zendesk interaction.


   .. py:attribute:: client


   .. py:method:: _make_request(method: str, path: str, params: dict[str, Any] | None = None, json: dict[str, Any] | None = None) -> httpx.Response

      Make a request to Zendesk.



   .. py:method:: search(type_: Literal['ticket', 'user', 'organization'] = 'ticket', statuses: list[Literal['new', 'open', 'pending', 'hold', 'solved', 'closed']] | None = None, tags: list[str] | None = None) -> list[zendesk_sdk.models.Ticket]

      Search.



   .. py:method:: get_ticket(ticket_id: int) -> zendesk_sdk.models.Ticket

      Find and load to base64.



   .. py:method:: create_ticket(subject: str, body: str, group_id: int, priority: Literal['urgent', 'high', 'normal', 'low'] = 'normal') -> zendesk_sdk.models.Ticket

      Find and load to base64.



   .. py:method:: update_ticket(ticket_id: int, status: Literal['new', 'open', 'pending', 'hold', 'solved', 'closed'] | None = None, comment: str | None = None, comment_is_public: bool = True) -> zendesk_sdk.models.Ticket

      Update a ticket.



   .. py:method:: add_tags_to_ticket(ticket_id: int, tags: list[str]) -> list[str]

      Add tags to a ticket.



   .. py:method:: get_ticket_comments(ticket_id: int) -> list[zendesk_sdk.models.TicketComment]

      Find and load to base64.