kickerde_api_client.provider
============================

.. py:module:: kickerde_api_client.provider

.. autoapi-nested-parse::

   Abstract HTTP response provider for testability.



Classes
-------

.. autoapisummary::

   kickerde_api_client.provider.ResponseProvider
   kickerde_api_client.provider.DefaultResponseProvider


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

.. py:class:: ResponseProvider

   Bases: :py:obj:`abc.ABC`


   Abstract HTTP response provider for testability.


   .. py:method:: get(path)
      :abstractmethod:

      :async:


      Returns an HTTP response as a string.

      :param path:
          Relative path to the endpoint

      :return:
          HTTP response payload



.. py:class:: DefaultResponseProvider(http_client = None, base_url = DEFAULT_ENDPOINT_URL)

   Bases: :py:obj:`ResponseProvider`


   The default provider, which issues actual HTTP requests.

   :param http_client:
       An optional HTTP client to re-use.
       The default value is `None`, which means that an internal
       HTTP client will be used.

   :param base_url:
       The Kicker API endpoint to connect to.
       The default value is the public production endpoint.


   .. py:method:: get(path)
      :async:


      Returns an HTTP response as a string.

      :param path:
          Relative path to the endpoint

      :return:
          HTTP response payload