Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions docs/api_support/arrivals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Arrivals

A client class to interact with the Navitia API for fetching arrival information.

Official documentation: <https://doc.navitia.io/#arrivals>

Property: `NavitiaClient.arrivals`

Methods

```python

list_arrivals_by_region_id_and_path(
region_id: str,
resource_path: str,
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
disable_geojson: bool = False,
direction_type: str = "all"
) -> Tuple[Sequence[Arrival], Pagination]
Retrieves a list of arrivals for a specific region and resource path.

list_arrivals_by_coordinates(
region_lon: float,
region_lat: float,
lon: float,
lat: float,
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
disable_geojson: bool = False,
direction_type: str = "all"
) -> Tuple[Sequence[Arrival], Pagination]
Retrieves a list of arrivals for specific coordinates.
```

````
4 changes: 4 additions & 0 deletions docs/api_support/departures.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Methods
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
disable_geojson: bool = False,
Expand All @@ -31,6 +33,8 @@ Methods
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
disable_geojson: bool = False,
Expand Down
4 changes: 4 additions & 0 deletions docs/api_support/route_schedules.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Methods
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "base_schedule",
Expand All @@ -32,6 +34,8 @@ Methods
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "base_schedule",
Expand Down
4 changes: 4 additions & 0 deletions docs/api_support/stop_schedules.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Methods
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
Expand All @@ -32,6 +34,8 @@ Methods
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
Expand Down
4 changes: 4 additions & 0 deletions docs/api_support/terminus_schedules.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Methods
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
Expand All @@ -32,6 +34,8 @@ Methods
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
Expand Down
16 changes: 16 additions & 0 deletions navitia_client/client/apis/arrival_apis.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ def list_arrivals_by_region_id_and_path(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
disable_geojson: bool = False,
Expand All @@ -100,6 +102,10 @@ def list_arrivals_by_region_id_and_path(
The duration in seconds for which to fetch arrivals (default is 86400 seconds).
depth : int, optional
The depth of the search (default is 1).
count : int, optional
Maximum number of results (default is 10).
start_page : int, optional
The page number to start from (default is 0).
forbidden_uris : Optional[Sequence[str]], optional
A list of URIs to exclude from the search (default is None).
data_freshness : str, optional
Expand All @@ -120,6 +126,8 @@ def list_arrivals_by_region_id_and_path(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
"data_freshness": data_freshness,
Expand All @@ -137,6 +145,8 @@ def list_arrivals_by_coordinates(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
disable_geojson: bool = False,
Expand All @@ -161,6 +171,10 @@ def list_arrivals_by_coordinates(
The duration in seconds for which to fetch arrivals (default is 86400 seconds).
depth : int, optional
The depth of the search (default is 1).
count : int, optional
Maximum number of results (default is 10).
start_page : int, optional
The page number to start from (default is 0).
forbidden_uris : Optional[Sequence[str]], optional
A list of URIs to exclude from the search (default is None).
data_freshness : str, optional
Expand All @@ -182,6 +196,8 @@ def list_arrivals_by_coordinates(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
"data_freshness": data_freshness,
Expand Down
16 changes: 16 additions & 0 deletions navitia_client/client/apis/departure_apis.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ def list_departures_by_region_id_and_path(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
disable_geojson: bool = False,
Expand All @@ -121,6 +123,10 @@ def list_departures_by_region_id_and_path(
The duration for which to fetch departures, in seconds (default is 86400 seconds, i.e., 1 day).
depth : int, optional
The depth of the search (default is 1).
count : int, optional
Maximum number of results (default is 10).
start_page : int, optional
The page number to start from (default is 0).
forbidden_uris : Optional[Sequence[str]], optional
A list of URIs to exclude from the search (default is None).
data_freshness : str, optional
Expand All @@ -141,6 +147,8 @@ def list_departures_by_region_id_and_path(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
"data_freshness": data_freshness,
Expand All @@ -158,6 +166,8 @@ def list_departures_by_coordinates(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
disable_geojson: bool = False,
Expand All @@ -182,6 +192,10 @@ def list_departures_by_coordinates(
The duration for which to fetch departures, in seconds (default is 86400 seconds, i.e., 1 day).
depth : int, optional
The depth of the search (default is 1).
count : int, optional
Maximum number of results (default is 10).
start_page : int, optional
The page number to start from (default is 0).
forbidden_uris : Optional[Sequence[str]], optional
A list of URIs to exclude from the search (default is None).
data_freshness : str, optional
Expand All @@ -202,6 +216,8 @@ def list_departures_by_coordinates(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
"data_freshness": data_freshness,
Expand Down
12 changes: 12 additions & 0 deletions navitia_client/client/apis/route_schedules_apis.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ def list_route_schedules_by_region_id_and_path(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "base_schedule",
Expand All @@ -102,6 +104,8 @@ def list_route_schedules_by_region_id_and_path(
from_datetime (datetime, optional): The start datetime for the schedule. Defaults to datetime.now().
duration (int, optional): The duration of the schedule in seconds. Defaults to 86400.
depth (int, optional): The depth of data to retrieve. Defaults to 1.
count (int, optional): Maximum number of results. Defaults to 10.
start_page (int, optional): The page number to start from. Defaults to 0.
items_per_schedule (int, optional): The number of items per schedule. Defaults to 1.
forbidden_uris (Optional[Sequence[str]], optional): Forbidden URIs. Defaults to None.
data_freshness (str, optional): The freshness of data to retrieve. Defaults to "base_schedule".
Expand All @@ -117,6 +121,8 @@ def list_route_schedules_by_region_id_and_path(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"items_per_schedule": items_per_schedule,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
Expand All @@ -135,6 +141,8 @@ def list_route_schedules_by_coordinates(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "base_schedule",
Expand All @@ -152,6 +160,8 @@ def list_route_schedules_by_coordinates(
from_datetime (datetime, optional): The start datetime for the schedule. Defaults to datetime.now().
duration (int, optional): The duration of the schedule in seconds. Defaults to 86400.
depth (int, optional): The depth of data to retrieve. Defaults to 1.
count (int, optional): Maximum number of results. Defaults to 10.
start_page (int, optional): The page number to start from. Defaults to 0.
items_per_schedule (int, optional): The number of items per schedule. Defaults to 1.
forbidden_uris (Optional[Sequence[str]], optional): Forbidden URIs. Defaults to None.
data_freshness (str, optional): The freshness of data to retrieve. Defaults to "base_schedule".
Expand All @@ -167,6 +177,8 @@ def list_route_schedules_by_coordinates(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"items_per_schedule": items_per_schedule,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
Expand Down
12 changes: 12 additions & 0 deletions navitia_client/client/apis/stop_schedules_apis.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ def list_stop_schedules_by_coordinates(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
Expand All @@ -110,6 +112,8 @@ def list_stop_schedules_by_coordinates(
from_datetime (datetime, optional): The start datetime for the schedule. Defaults to datetime.now().
duration (int, optional): The duration of the schedule in seconds. Defaults to 86400.
depth (int, optional): The depth of data to retrieve. Defaults to 1.
count (int, optional): Maximum number of results. Defaults to 10.
start_page (int, optional): The page number to start from. Defaults to 0.
items_per_schedule (int, optional): The number of items per schedule. Defaults to 1.
forbidden_uris (Optional[Sequence[str]], optional): Forbidden URIs. Defaults to None.
data_freshness (str, optional): The freshness of data to retrieve. Defaults to "realtime".
Expand All @@ -125,6 +129,8 @@ def list_stop_schedules_by_coordinates(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"items_per_schedule": items_per_schedule,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
Expand All @@ -141,6 +147,8 @@ def list_stop_schedules_by_region_id_and_path(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
Expand All @@ -156,6 +164,8 @@ def list_stop_schedules_by_region_id_and_path(
from_datetime (datetime, optional): The start datetime for the schedule. Defaults to datetime.now().
duration (int, optional): The duration of the schedule in seconds. Defaults to 86400.
depth (int, optional): The depth of data to retrieve. Defaults to 1.
count (int, optional): Maximum number of results. Defaults to 10.
start_page (int, optional): The page number to start from. Defaults to 0.
items_per_schedule (int, optional): The number of items per schedule. Defaults to 1.
forbidden_uris (Optional[Sequence[str]], optional): Forbidden URIs. Defaults to None.
data_freshness (str, optional): The freshness of data to retrieve. Defaults to "realtime".
Expand All @@ -171,6 +181,8 @@ def list_stop_schedules_by_region_id_and_path(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"items_per_schedule": items_per_schedule,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
Expand Down
12 changes: 12 additions & 0 deletions navitia_client/client/apis/terminus_schedules_apis.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ def list_terminus_schedules_by_region_id_and_path(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
Expand All @@ -110,6 +112,8 @@ def list_terminus_schedules_by_region_id_and_path(
from_datetime (datetime, optional): The start datetime for the schedule. Defaults to datetime.now().
duration (int, optional): The duration of the schedule in seconds. Defaults to 86400.
depth (int, optional): The depth of data to retrieve. Defaults to 1.
count (int, optional): Maximum number of results. Defaults to 10.
start_page (int, optional): The page number to start from. Defaults to 0.
items_per_schedule (int, optional): The number of items per schedule. Defaults to 1.
forbidden_uris (Optional[Sequence[str]], optional): Forbidden URIs. Defaults to None.
data_freshness (str, optional): The freshness of data to retrieve. Defaults to "realtime".
Expand All @@ -125,6 +129,8 @@ def list_terminus_schedules_by_region_id_and_path(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"items_per_schedule": items_per_schedule,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
Expand All @@ -143,6 +149,8 @@ def list_terminus_schedules_by_coordinates(
from_datetime: datetime = datetime.now(),
duration: int = 86400,
depth: int = 1,
count: int = 10,
start_page: int = 0,
items_per_schedule: int = 1,
forbidden_uris: Optional[Sequence[str]] = None,
data_freshness: str = "realtime",
Expand All @@ -160,6 +168,8 @@ def list_terminus_schedules_by_coordinates(
from_datetime (datetime, optional): The start datetime for the schedule. Defaults to datetime.now().
duration (int, optional): The duration of the schedule in seconds. Defaults to 86400.
depth (int, optional): The depth of data to retrieve. Defaults to 1.
count (int, optional): Maximum number of results. Defaults to 10.
start_page (int, optional): The page number to start from. Defaults to 0.
items_per_schedule (int, optional): The number of items per schedule. Defaults to 1.
forbidden_uris (Optional[Sequence[str]], optional): Forbidden URIs. Defaults to None.
data_freshness (str, optional): The freshness of data to retrieve. Defaults to "realtime".
Expand All @@ -176,6 +186,8 @@ def list_terminus_schedules_by_coordinates(
"from_datetime": from_datetime,
"duration": duration,
"depth": depth,
"count": count,
"start_page": start_page,
"items_per_schedule": items_per_schedule,
"disable_geojson": disable_geojson,
"forbidden_uris[]": forbidden_uris,
Expand Down