leaf_engine.io.api.planning_caller
==================================

.. py:module:: leaf_engine.io.api.planning_caller


Attributes
----------

.. autoapisummary::

   leaf_engine.io.api.planning_caller.API_ENDPOINT
   leaf_engine.io.api.planning_caller.API_KEY
   leaf_engine.io.api.planning_caller.BACKOFF
   leaf_engine.io.api.planning_caller.DEFAULT_PAGE_SIZE
   leaf_engine.io.api.planning_caller.RETRIES
   leaf_engine.io.api.planning_caller.TIMEOUT


Exceptions
----------

.. autoapisummary::

   leaf_engine.io.api.planning_caller.PlanningAPIException


Classes
-------

.. autoapisummary::

   leaf_engine.io.api.planning_caller.PlanningAPICaller
   leaf_engine.io.api.planning_caller.PlanningAPIResponse


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

.. py:exception:: PlanningAPIException

   Bases: :py:obj:`Exception`


   Common base class for all non-exit exceptions.


.. py:class:: PlanningAPICaller(endpoint: Optional[str] = API_ENDPOINT, key: Optional[str] = API_KEY)

   Makes calls to the planning service.


   .. py:method:: delete(path: str, **kwargs) -> PlanningAPIResponse


   .. py:method:: get(path: str, **kwargs) -> PlanningAPIResponse


   .. py:method:: get_existing_shipper_lane_plans(company_id: int) -> pandas.DataFrame


   .. py:method:: post(path: str, data: Union[dict, List], ignore_duplicates=False) -> PlanningAPIResponse


   .. py:method:: put(path: str, data: Union[dict, List]) -> PlanningAPIResponse


   .. py:attribute:: endpoint


   .. py:attribute:: key


   .. py:attribute:: retries


   .. py:attribute:: session


.. py:class:: PlanningAPIResponse

   Bases: :py:obj:`requests.Response`


   The :class:`Response <Response>` object, which contains a
   server's response to an HTTP request.


.. py:data:: API_ENDPOINT

.. py:data:: API_KEY

.. py:data:: BACKOFF
   :value: 1


.. py:data:: DEFAULT_PAGE_SIZE
   :value: 100


.. py:data:: RETRIES
   :value: 3


.. py:data:: TIMEOUT
   :value: 500