diff --git a/docs/api_support/arrivals.md b/docs/api_support/arrivals.md new file mode 100644 index 0000000..f1b0f35 --- /dev/null +++ b/docs/api_support/arrivals.md @@ -0,0 +1,46 @@ +# Arrivals + +A client class to interact with the Navitia API for fetching arrival information. + +Official documentation: + +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. +``` + +```` diff --git a/docs/api_support/departures.md b/docs/api_support/departures.md index 2738104..981994f 100644 --- a/docs/api_support/departures.md +++ b/docs/api_support/departures.md @@ -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, @@ -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, diff --git a/docs/api_support/route_schedules.md b/docs/api_support/route_schedules.md index 980c249..cc82fb2 100644 --- a/docs/api_support/route_schedules.md +++ b/docs/api_support/route_schedules.md @@ -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", @@ -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", diff --git a/docs/api_support/stop_schedules.md b/docs/api_support/stop_schedules.md index 4ac4510..334a8bb 100644 --- a/docs/api_support/stop_schedules.md +++ b/docs/api_support/stop_schedules.md @@ -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", @@ -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", diff --git a/docs/api_support/terminus_schedules.md b/docs/api_support/terminus_schedules.md index d196930..d852d4d 100644 --- a/docs/api_support/terminus_schedules.md +++ b/docs/api_support/terminus_schedules.md @@ -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", @@ -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", diff --git a/navitia_client/client/apis/arrival_apis.py b/navitia_client/client/apis/arrival_apis.py index 60ef714..414dd8e 100644 --- a/navitia_client/client/apis/arrival_apis.py +++ b/navitia_client/client/apis/arrival_apis.py @@ -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, @@ -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 @@ -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, @@ -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, @@ -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 @@ -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, diff --git a/navitia_client/client/apis/departure_apis.py b/navitia_client/client/apis/departure_apis.py index 0b3d7f8..307ea4f 100644 --- a/navitia_client/client/apis/departure_apis.py +++ b/navitia_client/client/apis/departure_apis.py @@ -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, @@ -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 @@ -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, @@ -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, @@ -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 @@ -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, diff --git a/navitia_client/client/apis/route_schedules_apis.py b/navitia_client/client/apis/route_schedules_apis.py index a3e106e..1283ec0 100644 --- a/navitia_client/client/apis/route_schedules_apis.py +++ b/navitia_client/client/apis/route_schedules_apis.py @@ -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", @@ -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". @@ -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, @@ -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", @@ -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". @@ -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, diff --git a/navitia_client/client/apis/stop_schedules_apis.py b/navitia_client/client/apis/stop_schedules_apis.py index 41421b0..b83c0ec 100644 --- a/navitia_client/client/apis/stop_schedules_apis.py +++ b/navitia_client/client/apis/stop_schedules_apis.py @@ -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", @@ -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". @@ -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, @@ -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", @@ -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". @@ -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, diff --git a/navitia_client/client/apis/terminus_schedules_apis.py b/navitia_client/client/apis/terminus_schedules_apis.py index 2a6ec93..852f9a2 100644 --- a/navitia_client/client/apis/terminus_schedules_apis.py +++ b/navitia_client/client/apis/terminus_schedules_apis.py @@ -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", @@ -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". @@ -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, @@ -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", @@ -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". @@ -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,