leaf_engine.io.api.planning_caller

Attributes

API_ENDPOINT
API_KEY
BACKOFF
DEFAULT_PAGE_SIZE
RETRIES
TIMEOUT

Exceptions

PlanningAPIException

Common base class for all non-exit exceptions.

Classes

PlanningAPICaller	Makes calls to the planning service.
PlanningAPIResponse	The Response object, which contains a

Module Contents

exception leaf_engine.io.api.planning_caller.PlanningAPIException

Bases: Exception

Common base class for all non-exit exceptions.

class leaf_engine.io.api.planning_caller.PlanningAPICaller(endpoint: str | None = API_ENDPOINT, key: str | None = API_KEY)

Makes calls to the planning service.

Parameters:

• endpoint (Optional[str]) –

• key (Optional[str]) –

delete(path: str, **kwargs) → PlanningAPIResponse

Parameters:

path (str) –

Return type:

PlanningAPIResponse

get(path: str, **kwargs) → PlanningAPIResponse

Parameters:

path (str) –

Return type:

PlanningAPIResponse

get_existing_shipper_lane_plans(company_id: int) → pandas.DataFrame

Parameters:

company_id (int) –

Return type:

pandas.DataFrame

post(path: str, data: dict | List, ignore_duplicates=False) → PlanningAPIResponse

Parameters:

• path (str) –

• data (Union[dict, List]) –

Return type:

PlanningAPIResponse

put(path: str, data: dict | List) → PlanningAPIResponse

Parameters:

• path (str) –

• data (Union[dict, List]) –

Return type:

PlanningAPIResponse

endpoint

key

retries

session

class leaf_engine.io.api.planning_caller.PlanningAPIResponse

Bases: requests.Response

The Response object, which contains a server’s response to an HTTP request.

leaf_engine.io.api.planning_caller.API_ENDPOINT

leaf_engine.io.api.planning_caller.API_KEY

leaf_engine.io.api.planning_caller.BACKOFF = 1

leaf_engine.io.api.planning_caller.DEFAULT_PAGE_SIZE = 100

leaf_engine.io.api.planning_caller.RETRIES = 3

leaf_engine.io.api.planning_caller.TIMEOUT = 500