tfl-api-wrapper 0.1.4

TFL API Wrapper
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use crate::{
    line::{
        ArrivalPredictionsByLines, ArrivalPredictionsByLinesStopPointID, DisruptionByLines,
        DisruptionByMode, LineStatusBetweenDates, LineStatusByIDs, LineStatusByModes,
        LineStatusBySeverity, ListDisruptionCategories, ListLinesByID, ListLinesByModes,
        ListLinesRoutesByModes, ListModes, ListRoutesForLineIDWithSequence, ListServiceTypes,
        ListSeverityTypes, ListStationsByLines, RouteRequest, RouteRequestById,
        SearchLineRoutesByQuery, StationTimetableByLine, StationTimetableWithDestinationByLine,
    },
    request::*,
};

// Client for accessing TFL API
pub struct Client {
    pub app_key: String,
    pub req_client: reqwest::Client,
}

impl Client {
    // Create a new client for the TFL API
    pub fn new(app_key: String) -> Self {
        let req_client = reqwest::Client::new();
        Self {
            app_key,
            req_client,
        }
    }

    /// Return API version
    pub fn api_version(&self) -> VersionRequest<'_> {
        VersionRequest::new(self)
    }

    /// Return all the TFL routes
    pub fn routes(&self) -> RouteRequest<'_> {
        RouteRequest::new(self)
    }

    /// Return routes by Line(s)
    pub fn routes_by_line(&self) -> RouteRequestById<'_> {
        RouteRequestById::new(self)
    }

    /// Return disruptions by service mode. For example: Regular, Night
    pub fn disruptions_by_mode(&self) -> DisruptionByMode<'_> {
        DisruptionByMode::new(self)
    }

    /// Return disruptions by specified Line(s)
    pub fn disruptions_by_line(&self) -> DisruptionByLines<'_> {
        DisruptionByLines::new(self)
    }

    /// Return arrival predictions by specified Line(s)
    pub fn arrival_predictions_by_lines(&self) -> ArrivalPredictionsByLines<'_> {
        ArrivalPredictionsByLines::new(self)
    }

    /// Return arrival predictions by lines with stop point ID and optionally specifying direction, destination station id
    pub fn arrival_predictions_by_lines_with_stoppoint(
        &self,
    ) -> ArrivalPredictionsByLinesStopPointID<'_> {
        ArrivalPredictionsByLinesStopPointID::new(self)
    }

    /// Get a list of station that serve give lines
    pub fn list_stations_by_lines(&self) -> ListStationsByLines<'_> {
        ListStationsByLines::new(self)
    }

    /// Gets a list of valid disruption categories
    pub fn list_disruption_categories(&self) -> ListDisruptionCategories<'_> {
        ListDisruptionCategories::new(self)
    }

    /// Gets a list of valid modes
    pub fn list_modes(&self) -> ListModes<'_> {
        ListModes::new(self)
    }

    /// Gets a list of valid ServiceTypes to filter on
    pub fn list_service_types(&self) -> ListServiceTypes<'_> {
        ListServiceTypes::new(self)
    }

    /// Gets a list of valid severity codes
    pub fn list_severity_types(&self) -> ListSeverityTypes<'_> {
        ListSeverityTypes::new(self)
    }

    /// Gets all lines and their valid routes for given modes, including the name and id of the originating and terminating stops for each route
    pub fn list_lines_routes_by_modes(&self) -> ListLinesRoutesByModes<'_> {
        ListLinesRoutesByModes::new(self)
    }

    /// Gets all valid routes for given line id, including the sequence of stops on each route.
    pub fn list_routes_by_line_with_sequence(&self) -> ListRoutesForLineIDWithSequence<'_> {
        ListRoutesForLineIDWithSequence::new(self)
    }

    /// Gets lines that match the specified line ids.
    pub fn list_lines_by_id(&self) -> ListLinesByID<'_> {
        ListLinesByID::new(self)
    }

    /// Gets lines that serve the given modes.
    pub fn list_lines_by_modes(&self) -> ListLinesByModes<'_> {
        ListLinesByModes::new(self)
    }

    /// Gets the line status for all lines with a given severity
    pub fn line_status_by_severity(&self) -> LineStatusBySeverity<'_> {
        LineStatusBySeverity::new(self)
    }

    /// Gets the line status for given line ids during the provided dates e.g Minor Delays
    pub fn line_status_between_dates(&self) -> LineStatusBetweenDates<'_> {
        LineStatusBetweenDates::new(self)
    }

    /// Gets the line status of for all lines for the given modes
    pub fn line_status_by_modes(&self) -> LineStatusByModes<'_> {
        LineStatusByModes::new(self)
    }

    /// Gets the line status of for given line ids e.g Minor Delays
    pub fn line_status_by_ids(&self) -> LineStatusByIDs<'_> {
        LineStatusByIDs::new(self)
    }

    /// Gets the timetable for a specified station on the give line
    pub fn station_timetable_by_line(&self) -> StationTimetableByLine<'_> {
        StationTimetableByLine::new(self)
    }

    /// Gets the timetable for a specified station on the give line with specified destination
    pub fn station_timetable_with_destination_by_line(
        &self,
    ) -> StationTimetableWithDestinationByLine<'_> {
        StationTimetableWithDestinationByLine::new(self)
    }

    /// Search for lines or routes matching the query string
    pub fn search_line_routes_by_query(&self) -> SearchLineRoutesByQuery<'_> {
        SearchLineRoutesByQuery::new(self)
    }
}