:py:mod:`kavita_client.client`
==============================

.. py:module:: kavita_client.client

.. autodoc2-docstring:: kavita_client.client
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`AuthenticatedClient <kavita_client.client.AuthenticatedClient>`
     - .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient
          :summary:
   * - :py:obj:`Client <kavita_client.client.Client>`
     - .. autodoc2-docstring:: kavita_client.client.Client
          :summary:

API
~~~

.. py:class:: AuthenticatedClient
   :canonical: kavita_client.client.AuthenticatedClient

   .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient

   .. py:method:: __aenter__() -> typing.Self
      :canonical: kavita_client.client.AuthenticatedClient.__aenter__
      :async:

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.__aenter__

   .. py:method:: __aexit__(*args: typing.Any, **kwargs: typing.Any) -> None
      :canonical: kavita_client.client.AuthenticatedClient.__aexit__
      :async:

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.__aexit__

   .. py:method:: __enter__() -> typing.Self
      :canonical: kavita_client.client.AuthenticatedClient.__enter__

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.__enter__

   .. py:method:: __exit__(*args: typing.Any, **kwargs: typing.Any) -> None
      :canonical: kavita_client.client.AuthenticatedClient.__exit__

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.__exit__

   .. py:attribute:: auth_header_name
      :canonical: kavita_client.client.AuthenticatedClient.auth_header_name
      :type: str
      :value: 'Authorization'

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.auth_header_name

   .. py:method:: get_async_httpx_client() -> httpx.AsyncClient
      :canonical: kavita_client.client.AuthenticatedClient.get_async_httpx_client

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.get_async_httpx_client

   .. py:method:: get_httpx_client() -> httpx.Client
      :canonical: kavita_client.client.AuthenticatedClient.get_httpx_client

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.get_httpx_client

   .. py:attribute:: prefix
      :canonical: kavita_client.client.AuthenticatedClient.prefix
      :type: str
      :value: 'Bearer'

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.prefix

   .. py:attribute:: raise_on_unexpected_status
      :canonical: kavita_client.client.AuthenticatedClient.raise_on_unexpected_status
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.raise_on_unexpected_status

   .. py:method:: set_async_httpx_client(async_client: httpx.AsyncClient) -> typing.Self
      :canonical: kavita_client.client.AuthenticatedClient.set_async_httpx_client

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.set_async_httpx_client

   .. py:method:: set_httpx_client(client: httpx.Client) -> typing.Self
      :canonical: kavita_client.client.AuthenticatedClient.set_httpx_client

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.set_httpx_client

   .. py:attribute:: token
      :canonical: kavita_client.client.AuthenticatedClient.token
      :type: str
      :value: None

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.token

   .. py:method:: with_cookies(cookies: dict[str, str]) -> kavita_client.client.AuthenticatedClient
      :canonical: kavita_client.client.AuthenticatedClient.with_cookies

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.with_cookies

   .. py:method:: with_headers(headers: dict[str, str]) -> kavita_client.client.AuthenticatedClient
      :canonical: kavita_client.client.AuthenticatedClient.with_headers

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.with_headers

   .. py:method:: with_timeout(timeout: httpx.Timeout) -> kavita_client.client.AuthenticatedClient
      :canonical: kavita_client.client.AuthenticatedClient.with_timeout

      .. autodoc2-docstring:: kavita_client.client.AuthenticatedClient.with_timeout

.. py:class:: Client
   :canonical: kavita_client.client.Client

   .. autodoc2-docstring:: kavita_client.client.Client

   .. py:method:: __aenter__() -> typing.Self
      :canonical: kavita_client.client.Client.__aenter__
      :async:

      .. autodoc2-docstring:: kavita_client.client.Client.__aenter__

   .. py:method:: __aexit__(*args: typing.Any, **kwargs: typing.Any) -> None
      :canonical: kavita_client.client.Client.__aexit__
      :async:

      .. autodoc2-docstring:: kavita_client.client.Client.__aexit__

   .. py:method:: __enter__() -> typing.Self
      :canonical: kavita_client.client.Client.__enter__

      .. autodoc2-docstring:: kavita_client.client.Client.__enter__

   .. py:method:: __exit__(*args: typing.Any, **kwargs: typing.Any) -> None
      :canonical: kavita_client.client.Client.__exit__

      .. autodoc2-docstring:: kavita_client.client.Client.__exit__

   .. py:method:: get_async_httpx_client() -> httpx.AsyncClient
      :canonical: kavita_client.client.Client.get_async_httpx_client

      .. autodoc2-docstring:: kavita_client.client.Client.get_async_httpx_client

   .. py:method:: get_httpx_client() -> httpx.Client
      :canonical: kavita_client.client.Client.get_httpx_client

      .. autodoc2-docstring:: kavita_client.client.Client.get_httpx_client

   .. py:attribute:: raise_on_unexpected_status
      :canonical: kavita_client.client.Client.raise_on_unexpected_status
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: kavita_client.client.Client.raise_on_unexpected_status

   .. py:method:: set_async_httpx_client(async_client: httpx.AsyncClient) -> typing.Self
      :canonical: kavita_client.client.Client.set_async_httpx_client

      .. autodoc2-docstring:: kavita_client.client.Client.set_async_httpx_client

   .. py:method:: set_httpx_client(client: httpx.Client) -> typing.Self
      :canonical: kavita_client.client.Client.set_httpx_client

      .. autodoc2-docstring:: kavita_client.client.Client.set_httpx_client

   .. py:method:: with_cookies(cookies: dict[str, str]) -> kavita_client.client.Client
      :canonical: kavita_client.client.Client.with_cookies

      .. autodoc2-docstring:: kavita_client.client.Client.with_cookies

   .. py:method:: with_headers(headers: dict[str, str]) -> kavita_client.client.Client
      :canonical: kavita_client.client.Client.with_headers

      .. autodoc2-docstring:: kavita_client.client.Client.with_headers

   .. py:method:: with_timeout(timeout: httpx.Timeout) -> kavita_client.client.Client
      :canonical: kavita_client.client.Client.with_timeout

      .. autodoc2-docstring:: kavita_client.client.Client.with_timeout