@motis-project/motis-client 2.0.83 → 2.0.84

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,952 +1,1120 @@
1
1
  declare const AlertCauseSchema: {
2
- readonly description: "Cause of this alert.";
3
- readonly type: "string";
4
- readonly enum: readonly ["UNKNOWN_CAUSE", "OTHER_CAUSE", "TECHNICAL_PROBLEM", "STRIKE", "DEMONSTRATION", "ACCIDENT", "HOLIDAY", "WEATHER", "MAINTENANCE", "CONSTRUCTION", "POLICE_ACTIVITY", "MEDICAL_EMERGENCY"];
2
+ readonly description: 'Cause of this alert.';
3
+ readonly type: 'string';
4
+ readonly enum: readonly [
5
+ 'UNKNOWN_CAUSE',
6
+ 'OTHER_CAUSE',
7
+ 'TECHNICAL_PROBLEM',
8
+ 'STRIKE',
9
+ 'DEMONSTRATION',
10
+ 'ACCIDENT',
11
+ 'HOLIDAY',
12
+ 'WEATHER',
13
+ 'MAINTENANCE',
14
+ 'CONSTRUCTION',
15
+ 'POLICE_ACTIVITY',
16
+ 'MEDICAL_EMERGENCY'
17
+ ];
5
18
  };
6
19
  declare const AlertEffectSchema: {
7
- readonly description: "The effect of this problem on the affected entity.";
8
- readonly type: "string";
9
- readonly enum: readonly ["NO_SERVICE", "REDUCED_SERVICE", "SIGNIFICANT_DELAYS", "DETOUR", "ADDITIONAL_SERVICE", "MODIFIED_SERVICE", "OTHER_EFFECT", "UNKNOWN_EFFECT", "STOP_MOVED", "NO_EFFECT", "ACCESSIBILITY_ISSUE"];
20
+ readonly description: 'The effect of this problem on the affected entity.';
21
+ readonly type: 'string';
22
+ readonly enum: readonly [
23
+ 'NO_SERVICE',
24
+ 'REDUCED_SERVICE',
25
+ 'SIGNIFICANT_DELAYS',
26
+ 'DETOUR',
27
+ 'ADDITIONAL_SERVICE',
28
+ 'MODIFIED_SERVICE',
29
+ 'OTHER_EFFECT',
30
+ 'UNKNOWN_EFFECT',
31
+ 'STOP_MOVED',
32
+ 'NO_EFFECT',
33
+ 'ACCESSIBILITY_ISSUE'
34
+ ];
10
35
  };
11
36
  declare const AlertSeverityLevelSchema: {
12
- readonly description: "The severity of the alert.";
13
- readonly type: "string";
14
- readonly enum: readonly ["UNKNOWN_SEVERITY", "INFO", "WARNING", "SEVERE"];
37
+ readonly description: 'The severity of the alert.';
38
+ readonly type: 'string';
39
+ readonly enum: readonly ['UNKNOWN_SEVERITY', 'INFO', 'WARNING', 'SEVERE'];
15
40
  };
16
41
  declare const TimeRangeSchema: {
17
- readonly description: "A time interval.\nThe interval is considered active at time t if t is greater than or equal to the start time and less than the end time.\n";
18
- readonly type: "object";
19
- readonly properties: {
20
- readonly start: {
21
- readonly description: "If missing, the interval starts at minus infinity.\nIf a TimeRange is provided, either start or end must be provided - both fields cannot be empty.\n";
22
- readonly type: "string";
23
- readonly format: "date-time";
24
- };
25
- readonly end: {
26
- readonly description: "If missing, the interval ends at plus infinity.\nIf a TimeRange is provided, either start or end must be provided - both fields cannot be empty.\n";
27
- readonly type: "string";
28
- readonly format: "date-time";
29
- };
30
- };
42
+ readonly description: 'A time interval.\nThe interval is considered active at time t if t is greater than or equal to the start time and less than the end time.\n';
43
+ readonly type: 'object';
44
+ readonly properties: {
45
+ readonly start: {
46
+ readonly description: 'If missing, the interval starts at minus infinity.\nIf a TimeRange is provided, either start or end must be provided - both fields cannot be empty.\n';
47
+ readonly type: 'string';
48
+ readonly format: 'date-time';
49
+ };
50
+ readonly end: {
51
+ readonly description: 'If missing, the interval ends at plus infinity.\nIf a TimeRange is provided, either start or end must be provided - both fields cannot be empty.\n';
52
+ readonly type: 'string';
53
+ readonly format: 'date-time';
54
+ };
55
+ };
31
56
  };
32
57
  declare const AlertSchema: {
33
- readonly description: "An alert, indicating some sort of incident in the public transit network.";
34
- readonly type: "object";
35
- readonly required: readonly ["headerText", "descriptionText"];
36
- readonly properties: {
37
- readonly communicationPeriod: {
38
- readonly description: "Time when the alert should be shown to the user.\nIf missing, the alert will be shown as long as it appears in the feed.\nIf multiple ranges are given, the alert will be shown during all of them.\n";
39
- readonly type: "array";
40
- readonly items: {
41
- readonly $ref: "#/components/schemas/TimeRange";
42
- };
43
- };
44
- readonly impactPeriod: {
45
- readonly description: "Time when the services are affected by the disruption mentioned in the alert.";
46
- readonly type: "array";
47
- readonly items: {
48
- readonly $ref: "#/components/schemas/TimeRange";
49
- };
50
- };
51
- readonly cause: {
52
- readonly $ref: "#/components/schemas/AlertCause";
53
- };
54
- readonly causeDetail: {
55
- readonly type: "string";
56
- readonly description: "Description of the cause of the alert that allows for agency-specific language;\nmore specific than the Cause.\n";
57
- };
58
- readonly effect: {
59
- readonly $ref: "#/components/schemas/AlertEffect";
60
- };
61
- readonly effectDetail: {
62
- readonly type: "string";
63
- readonly description: "Description of the effect of the alert that allows for agency-specific language;\nmore specific than the Effect.\n";
64
- };
65
- readonly url: {
66
- readonly type: "string";
67
- readonly description: "The URL which provides additional information about the alert.";
68
- };
69
- readonly headerText: {
70
- readonly type: "string";
71
- readonly description: "Header for the alert. This plain-text string will be highlighted, for example in boldface.\n";
72
- };
73
- readonly descriptionText: {
74
- readonly type: "string";
75
- readonly description: "Description for the alert.\nThis plain-text string will be formatted as the body of the alert (or shown on an explicit \"expand\" request by the user).\nThe information in the description should add to the information of the header.\n";
76
- };
77
- readonly ttsHeaderText: {
78
- readonly type: "string";
79
- readonly description: "Text containing the alert's header to be used for text-to-speech implementations.\nThis field is the text-to-speech version of header_text.\nIt should contain the same information as headerText but formatted such that it can read as text-to-speech\n(for example, abbreviations removed, numbers spelled out, etc.)\n";
80
- };
81
- readonly ttsDescriptionText: {
82
- readonly type: "string";
83
- readonly description: "Text containing a description for the alert to be used for text-to-speech implementations.\nThis field is the text-to-speech version of description_text.\nIt should contain the same information as description_text but formatted such that it can be read as text-to-speech\n(for example, abbreviations removed, numbers spelled out, etc.)\n";
84
- };
85
- readonly severityLevel: {
86
- readonly description: "Severity of the alert.";
87
- readonly $ref: "#/components/schemas/AlertSeverityLevel";
88
- };
89
- readonly imageUrl: {
90
- readonly description: "String containing an URL linking to an image.";
91
- readonly type: "string";
92
- };
93
- readonly imageMediaType: {
94
- readonly description: "IANA media type as to specify the type of image to be displayed. The type must start with \"image/\"\n";
95
- readonly type: "string";
96
- };
97
- readonly imageAlternativeText: {
98
- readonly description: "Text describing the appearance of the linked image in the image field\n(e.g., in case the image can't be displayed or the user can't see the image for accessibility reasons).\nSee the HTML spec for alt image text.\n";
99
- readonly type: "string";
100
- };
101
- };
58
+ readonly description: 'An alert, indicating some sort of incident in the public transit network.';
59
+ readonly type: 'object';
60
+ readonly required: readonly ['headerText', 'descriptionText'];
61
+ readonly properties: {
62
+ readonly communicationPeriod: {
63
+ readonly description: 'Time when the alert should be shown to the user.\nIf missing, the alert will be shown as long as it appears in the feed.\nIf multiple ranges are given, the alert will be shown during all of them.\n';
64
+ readonly type: 'array';
65
+ readonly items: {
66
+ readonly $ref: '#/components/schemas/TimeRange';
67
+ };
68
+ };
69
+ readonly impactPeriod: {
70
+ readonly description: 'Time when the services are affected by the disruption mentioned in the alert.';
71
+ readonly type: 'array';
72
+ readonly items: {
73
+ readonly $ref: '#/components/schemas/TimeRange';
74
+ };
75
+ };
76
+ readonly cause: {
77
+ readonly $ref: '#/components/schemas/AlertCause';
78
+ };
79
+ readonly causeDetail: {
80
+ readonly type: 'string';
81
+ readonly description: 'Description of the cause of the alert that allows for agency-specific language;\nmore specific than the Cause.\n';
82
+ };
83
+ readonly effect: {
84
+ readonly $ref: '#/components/schemas/AlertEffect';
85
+ };
86
+ readonly effectDetail: {
87
+ readonly type: 'string';
88
+ readonly description: 'Description of the effect of the alert that allows for agency-specific language;\nmore specific than the Effect.\n';
89
+ };
90
+ readonly url: {
91
+ readonly type: 'string';
92
+ readonly description: 'The URL which provides additional information about the alert.';
93
+ };
94
+ readonly headerText: {
95
+ readonly type: 'string';
96
+ readonly description: 'Header for the alert. This plain-text string will be highlighted, for example in boldface.\n';
97
+ };
98
+ readonly descriptionText: {
99
+ readonly type: 'string';
100
+ readonly description: 'Description for the alert.\nThis plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user).\nThe information in the description should add to the information of the header.\n';
101
+ };
102
+ readonly ttsHeaderText: {
103
+ readonly type: 'string';
104
+ readonly description: "Text containing the alert's header to be used for text-to-speech implementations.\nThis field is the text-to-speech version of header_text.\nIt should contain the same information as headerText but formatted such that it can read as text-to-speech\n(for example, abbreviations removed, numbers spelled out, etc.)\n";
105
+ };
106
+ readonly ttsDescriptionText: {
107
+ readonly type: 'string';
108
+ readonly description: 'Text containing a description for the alert to be used for text-to-speech implementations.\nThis field is the text-to-speech version of description_text.\nIt should contain the same information as description_text but formatted such that it can be read as text-to-speech\n(for example, abbreviations removed, numbers spelled out, etc.)\n';
109
+ };
110
+ readonly severityLevel: {
111
+ readonly description: 'Severity of the alert.';
112
+ readonly $ref: '#/components/schemas/AlertSeverityLevel';
113
+ };
114
+ readonly imageUrl: {
115
+ readonly description: 'String containing an URL linking to an image.';
116
+ readonly type: 'string';
117
+ };
118
+ readonly imageMediaType: {
119
+ readonly description: 'IANA media type as to specify the type of image to be displayed. The type must start with "image/"\n';
120
+ readonly type: 'string';
121
+ };
122
+ readonly imageAlternativeText: {
123
+ readonly description: "Text describing the appearance of the linked image in the image field\n(e.g., in case the image can't be displayed or the user can't see the image for accessibility reasons).\nSee the HTML spec for alt image text.\n";
124
+ readonly type: 'string';
125
+ };
126
+ };
102
127
  };
103
128
  declare const DurationSchema: {
104
- readonly description: "Object containing duration if a path was found or none if no path was found";
105
- readonly type: "object";
106
- readonly properties: {
107
- readonly duration: {
108
- readonly type: "number";
109
- readonly description: "duration in seconds if a path was found, otherwise missing";
110
- };
111
- };
129
+ readonly description: 'Object containing duration if a path was found or none if no path was found';
130
+ readonly type: 'object';
131
+ readonly properties: {
132
+ readonly duration: {
133
+ readonly type: 'number';
134
+ readonly description: 'duration in seconds if a path was found, otherwise missing';
135
+ };
136
+ };
112
137
  };
113
138
  declare const AreaSchema: {
114
- readonly description: "Administrative area";
115
- readonly type: "object";
116
- readonly required: readonly ["name", "adminLevel", "matched"];
117
- readonly properties: {
118
- readonly name: {
119
- readonly type: "string";
120
- readonly description: "Name of the area";
121
- };
122
- readonly adminLevel: {
123
- readonly type: "number";
124
- readonly description: "[OpenStreetMap `admin_level`](https://wiki.openstreetmap.org/wiki/Key:admin_level)\nof the area\n";
125
- };
126
- readonly matched: {
127
- readonly type: "boolean";
128
- readonly description: "Whether this area was matched by the input text";
129
- };
130
- readonly unique: {
131
- readonly type: "boolean";
132
- readonly description: "Set for the first area after the `default` area that distinguishes areas\nif the match is ambiguous regarding (`default` area + place name / street [+ house number]).\n";
133
- };
134
- readonly default: {
135
- readonly type: "boolean";
136
- readonly description: "Whether this area should be displayed as default area (area with admin level closest 7)";
137
- };
138
- };
139
+ readonly description: 'Administrative area';
140
+ readonly type: 'object';
141
+ readonly required: readonly ['name', 'adminLevel', 'matched'];
142
+ readonly properties: {
143
+ readonly name: {
144
+ readonly type: 'string';
145
+ readonly description: 'Name of the area';
146
+ };
147
+ readonly adminLevel: {
148
+ readonly type: 'number';
149
+ readonly description: '[OpenStreetMap `admin_level`](https://wiki.openstreetmap.org/wiki/Key:admin_level)\nof the area\n';
150
+ };
151
+ readonly matched: {
152
+ readonly type: 'boolean';
153
+ readonly description: 'Whether this area was matched by the input text';
154
+ };
155
+ readonly unique: {
156
+ readonly type: 'boolean';
157
+ readonly description: 'Set for the first area after the `default` area that distinguishes areas\nif the match is ambiguous regarding (`default` area + place name / street [+ house number]).\n';
158
+ };
159
+ readonly default: {
160
+ readonly type: 'boolean';
161
+ readonly description: 'Whether this area should be displayed as default area (area with admin level closest 7)';
162
+ };
163
+ };
139
164
  };
140
165
  declare const TokenSchema: {
141
- readonly description: "Matched token range (from index, length)";
142
- readonly type: "array";
143
- readonly minItems: 2;
144
- readonly maxItems: 2;
145
- readonly items: {
146
- readonly type: "number";
147
- };
166
+ readonly description: 'Matched token range (from index, length)';
167
+ readonly type: 'array';
168
+ readonly minItems: 2;
169
+ readonly maxItems: 2;
170
+ readonly items: {
171
+ readonly type: 'number';
172
+ };
148
173
  };
149
174
  declare const LocationTypeSchema: {
150
- readonly description: "location type";
151
- readonly type: "string";
152
- readonly enum: readonly ["ADDRESS", "PLACE", "STOP"];
175
+ readonly description: 'location type';
176
+ readonly type: 'string';
177
+ readonly enum: readonly ['ADDRESS', 'PLACE', 'STOP'];
153
178
  };
154
179
  declare const MatchSchema: {
155
- readonly description: "GeoCoding match";
156
- readonly type: "object";
157
- readonly required: readonly ["type", "name", "id", "lat", "lon", "tokens", "areas", "score"];
158
- readonly properties: {
159
- readonly type: {
160
- readonly $ref: "#/components/schemas/LocationType";
161
- };
162
- readonly tokens: {
163
- readonly description: "list of non-overlapping tokens that were matched";
164
- readonly type: "array";
165
- readonly items: {
166
- readonly $ref: "#/components/schemas/Token";
167
- };
168
- };
169
- readonly name: {
170
- readonly description: "name of the location (transit stop / PoI / address)";
171
- readonly type: "string";
172
- };
173
- readonly id: {
174
- readonly description: "unique ID of the location";
175
- readonly type: "string";
176
- };
177
- readonly lat: {
178
- readonly description: "latitude";
179
- readonly type: "number";
180
- };
181
- readonly lon: {
182
- readonly description: "longitude";
183
- readonly type: "number";
184
- };
185
- readonly level: {
186
- readonly description: "level according to OpenStreetMap\n(at the moment only for public transport)\n";
187
- readonly type: "number";
188
- };
189
- readonly street: {
190
- readonly description: "street name";
191
- readonly type: "string";
192
- };
193
- readonly houseNumber: {
194
- readonly description: "house number";
195
- readonly type: "string";
196
- };
197
- readonly zip: {
198
- readonly description: "zip code";
199
- readonly type: "string";
200
- };
201
- readonly areas: {
202
- readonly description: "list of areas";
203
- readonly type: "array";
204
- readonly items: {
205
- readonly $ref: "#/components/schemas/Area";
206
- };
207
- };
208
- readonly score: {
209
- readonly description: "score according to the internal scoring system (the scoring algorithm might change in the future)";
210
- readonly type: "number";
211
- };
212
- };
180
+ readonly description: 'GeoCoding match';
181
+ readonly type: 'object';
182
+ readonly required: readonly ['type', 'name', 'id', 'lat', 'lon', 'tokens', 'areas', 'score'];
183
+ readonly properties: {
184
+ readonly type: {
185
+ readonly $ref: '#/components/schemas/LocationType';
186
+ };
187
+ readonly tokens: {
188
+ readonly description: 'list of non-overlapping tokens that were matched';
189
+ readonly type: 'array';
190
+ readonly items: {
191
+ readonly $ref: '#/components/schemas/Token';
192
+ };
193
+ };
194
+ readonly name: {
195
+ readonly description: 'name of the location (transit stop / PoI / address)';
196
+ readonly type: 'string';
197
+ };
198
+ readonly id: {
199
+ readonly description: 'unique ID of the location';
200
+ readonly type: 'string';
201
+ };
202
+ readonly lat: {
203
+ readonly description: 'latitude';
204
+ readonly type: 'number';
205
+ };
206
+ readonly lon: {
207
+ readonly description: 'longitude';
208
+ readonly type: 'number';
209
+ };
210
+ readonly level: {
211
+ readonly description: 'level according to OpenStreetMap\n(at the moment only for public transport)\n';
212
+ readonly type: 'number';
213
+ };
214
+ readonly street: {
215
+ readonly description: 'street name';
216
+ readonly type: 'string';
217
+ };
218
+ readonly houseNumber: {
219
+ readonly description: 'house number';
220
+ readonly type: 'string';
221
+ };
222
+ readonly zip: {
223
+ readonly description: 'zip code';
224
+ readonly type: 'string';
225
+ };
226
+ readonly areas: {
227
+ readonly description: 'list of areas';
228
+ readonly type: 'array';
229
+ readonly items: {
230
+ readonly $ref: '#/components/schemas/Area';
231
+ };
232
+ };
233
+ readonly score: {
234
+ readonly description: 'score according to the internal scoring system (the scoring algorithm might change in the future)';
235
+ readonly type: 'number';
236
+ };
237
+ };
213
238
  };
214
239
  declare const ElevationCostsSchema: {
215
- readonly description: "Different elevation cost profiles for street routing.\nUsing a elevation cost profile will prefer routes with a smaller incline and smaller difference in elevation, even if the routed way is longer.\n\n- `NONE`: Ignore elevation data for routing. This is the default behavior\n- `LOW`: Add a low penalty for inclines. This will favor longer paths, if the elevation increase and incline are smaller.\n- `HIGH`: Add a high penalty for inclines. This will favor even longer paths, if the elevation increase and incline are smaller.\n";
216
- readonly type: "string";
217
- readonly enum: readonly ["NONE", "LOW", "HIGH"];
240
+ readonly description: 'Different elevation cost profiles for street routing.\nUsing a elevation cost profile will prefer routes with a smaller incline and smaller difference in elevation, even if the routed way is longer.\n\n- `NONE`: Ignore elevation data for routing. This is the default behavior\n- `LOW`: Add a low penalty for inclines. This will favor longer paths, if the elevation increase and incline are smaller.\n- `HIGH`: Add a high penalty for inclines. This will favor even longer paths, if the elevation increase and incline are smaller.\n';
241
+ readonly type: 'string';
242
+ readonly enum: readonly ['NONE', 'LOW', 'HIGH'];
218
243
  };
219
244
  declare const PedestrianProfileSchema: {
220
- readonly description: "Different accessibility profiles for pedestrians.";
221
- readonly type: "string";
222
- readonly enum: readonly ["FOOT", "WHEELCHAIR"];
245
+ readonly description: 'Different accessibility profiles for pedestrians.';
246
+ readonly type: 'string';
247
+ readonly enum: readonly ['FOOT', 'WHEELCHAIR'];
223
248
  };
224
249
  declare const ModeSchema: {
225
- readonly description: "# Street modes\n\n - `WALK`\n - `BIKE`\n - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `CAR`\n - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `ODM` on-demand taxis from the Prima+ÖV Project\n - `FLEX` flexible transports\n\n# Transit modes\n\n - `TRANSIT`: translates to `RAIL,SUBWAY,TRAM,BUS,FERRY,AIRPLANE,COACH`\n - `TRAM`: trams\n - `SUBWAY`: subway trains\n - `FERRY`: ferries\n - `AIRPLANE`: airline flights\n - `BUS`: short distance buses (does not include `COACH`)\n - `COACH`: long distance buses (does not include `BUS`)\n - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE_RAIL,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL`\n - `METRO`: metro trains \n - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)\n - `LONG_DISTANCE`: long distance inter city trains\n - `NIGHT_RAIL`: long distance night trains\n - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster\n - `REGIONAL_RAIL`: regional train\n - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).\n - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.\n - `AREAL_LIFT`: Aerial lift, suspended cable car (e.g., gondola lift, aerial tramway). Cable transport where cabins, cars, gondolas or open chairs are suspended by means of one or more cables.\n";
226
- readonly type: "string";
227
- readonly enum: readonly ["WALK", "BIKE", "RENTAL", "CAR", "CAR_PARKING", "ODM", "FLEX", "TRANSIT", "TRAM", "SUBWAY", "FERRY", "AIRPLANE", "METRO", "BUS", "COACH", "RAIL", "HIGHSPEED_RAIL", "LONG_DISTANCE", "NIGHT_RAIL", "REGIONAL_FAST_RAIL", "REGIONAL_RAIL", "CABLE_CAR", "FUNICULAR", "AREAL_LIFT", "OTHER"];
250
+ readonly description: '# Street modes\n\n - `WALK`\n - `BIKE`\n - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `CAR`\n - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `ODM` on-demand taxis from the Prima+ÖV Project\n - `FLEX` flexible transports\n\n# Transit modes\n\n - `TRANSIT`: translates to `RAIL,SUBWAY,TRAM,BUS,FERRY,AIRPLANE,COACH`\n - `TRAM`: trams\n - `SUBWAY`: subway trains\n - `FERRY`: ferries\n - `AIRPLANE`: airline flights\n - `BUS`: short distance buses (does not include `COACH`)\n - `COACH`: long distance buses (does not include `BUS`)\n - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE_RAIL,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL`\n - `METRO`: metro trains \n - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)\n - `LONG_DISTANCE`: long distance inter city trains\n - `NIGHT_RAIL`: long distance night trains\n - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster\n - `REGIONAL_RAIL`: regional train\n - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).\n - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.\n - `AREAL_LIFT`: Aerial lift, suspended cable car (e.g., gondola lift, aerial tramway). Cable transport where cabins, cars, gondolas or open chairs are suspended by means of one or more cables.\n';
251
+ readonly type: 'string';
252
+ readonly enum: readonly [
253
+ 'WALK',
254
+ 'BIKE',
255
+ 'RENTAL',
256
+ 'CAR',
257
+ 'CAR_PARKING',
258
+ 'ODM',
259
+ 'FLEX',
260
+ 'TRANSIT',
261
+ 'TRAM',
262
+ 'SUBWAY',
263
+ 'FERRY',
264
+ 'AIRPLANE',
265
+ 'METRO',
266
+ 'BUS',
267
+ 'COACH',
268
+ 'RAIL',
269
+ 'HIGHSPEED_RAIL',
270
+ 'LONG_DISTANCE',
271
+ 'NIGHT_RAIL',
272
+ 'REGIONAL_FAST_RAIL',
273
+ 'REGIONAL_RAIL',
274
+ 'CABLE_CAR',
275
+ 'FUNICULAR',
276
+ 'AREAL_LIFT',
277
+ 'OTHER'
278
+ ];
228
279
  };
229
280
  declare const VertexTypeSchema: {
230
- readonly type: "string";
231
- readonly description: "- `NORMAL` - latitude / longitude coordinate or address\n- `BIKESHARE` - bike sharing station\n- `TRANSIT` - transit stop\n";
232
- readonly enum: readonly ["NORMAL", "BIKESHARE", "TRANSIT"];
281
+ readonly type: 'string';
282
+ readonly description: '- `NORMAL` - latitude / longitude coordinate or address\n- `BIKESHARE` - bike sharing station\n- `TRANSIT` - transit stop\n';
283
+ readonly enum: readonly ['NORMAL', 'BIKESHARE', 'TRANSIT'];
233
284
  };
234
285
  declare const PickupDropoffTypeSchema: {
235
- readonly type: "string";
236
- readonly description: "- `NORMAL` - entry/exit is possible normally\n- `NOT_ALLOWED` - entry/exit is not allowed\n";
237
- readonly enum: readonly ["NORMAL", "NOT_ALLOWED"];
286
+ readonly type: 'string';
287
+ readonly description: '- `NORMAL` - entry/exit is possible normally\n- `NOT_ALLOWED` - entry/exit is not allowed\n';
288
+ readonly enum: readonly ['NORMAL', 'NOT_ALLOWED'];
238
289
  };
239
290
  declare const PlaceSchema: {
240
- readonly type: "object";
241
- readonly required: readonly ["name", "lat", "lon", "level"];
242
- readonly properties: {
243
- readonly name: {
244
- readonly description: "name of the transit stop / PoI / address";
245
- readonly type: "string";
246
- };
247
- readonly stopId: {
248
- readonly description: "The ID of the stop. This is often something that users don't care about.";
249
- readonly type: "string";
250
- };
251
- readonly lat: {
252
- readonly description: "latitude";
253
- readonly type: "number";
254
- };
255
- readonly lon: {
256
- readonly description: "longitude";
257
- readonly type: "number";
258
- };
259
- readonly level: {
260
- readonly description: "level according to OpenStreetMap";
261
- readonly type: "number";
262
- };
263
- readonly arrival: {
264
- readonly description: "arrival time";
265
- readonly type: "string";
266
- readonly format: "date-time";
267
- };
268
- readonly departure: {
269
- readonly description: "departure time";
270
- readonly type: "string";
271
- readonly format: "date-time";
272
- };
273
- readonly scheduledArrival: {
274
- readonly description: "scheduled arrival time";
275
- readonly type: "string";
276
- readonly format: "date-time";
277
- };
278
- readonly scheduledDeparture: {
279
- readonly description: "scheduled departure time";
280
- readonly type: "string";
281
- readonly format: "date-time";
282
- };
283
- readonly scheduledTrack: {
284
- readonly description: "scheduled track from the static schedule timetable dataset";
285
- readonly type: "string";
286
- };
287
- readonly track: {
288
- readonly description: "The current track/platform information, updated with real-time updates if available. \nCan be missing if neither real-time updates nor the schedule timetable contains track information.\n";
289
- readonly type: "string";
290
- };
291
- readonly description: {
292
- readonly description: "description of the location that provides more detailed information";
293
- readonly type: "string";
294
- };
295
- readonly vertexType: {
296
- readonly $ref: "#/components/schemas/VertexType";
297
- };
298
- readonly pickupType: {
299
- readonly description: "Type of pickup. It could be disallowed due to schedule, skipped stops or cancellations.";
300
- readonly $ref: "#/components/schemas/PickupDropoffType";
301
- };
302
- readonly dropoffType: {
303
- readonly description: "Type of dropoff. It could be disallowed due to schedule, skipped stops or cancellations.";
304
- readonly $ref: "#/components/schemas/PickupDropoffType";
305
- };
306
- readonly cancelled: {
307
- readonly description: "Whether this stop is cancelled due to the realtime situation.";
308
- readonly type: "boolean";
309
- };
310
- readonly alerts: {
311
- readonly description: "Alerts for this stop.";
312
- readonly type: "array";
313
- readonly items: {
314
- readonly $ref: "#/components/schemas/Alert";
315
- };
316
- };
317
- readonly flex: {
318
- readonly description: "for `FLEX` transports, the flex location area or location group name";
319
- readonly type: "string";
320
- };
321
- readonly flexId: {
322
- readonly description: "for `FLEX` transports, the flex location area ID or location group ID";
323
- readonly type: "string";
324
- };
325
- readonly flexStartPickupDropOffWindow: {
326
- readonly description: "Time that on-demand service becomes available";
327
- readonly type: "string";
328
- readonly format: "date-time";
329
- };
330
- readonly flexEndPickupDropOffWindow: {
331
- readonly description: "Time that on-demand service ends";
332
- readonly type: "string";
333
- readonly format: "date-time";
334
- };
335
- };
291
+ readonly type: 'object';
292
+ readonly required: readonly ['name', 'lat', 'lon', 'level'];
293
+ readonly properties: {
294
+ readonly name: {
295
+ readonly description: 'name of the transit stop / PoI / address';
296
+ readonly type: 'string';
297
+ };
298
+ readonly stopId: {
299
+ readonly description: "The ID of the stop. This is often something that users don't care about.";
300
+ readonly type: 'string';
301
+ };
302
+ readonly lat: {
303
+ readonly description: 'latitude';
304
+ readonly type: 'number';
305
+ };
306
+ readonly lon: {
307
+ readonly description: 'longitude';
308
+ readonly type: 'number';
309
+ };
310
+ readonly level: {
311
+ readonly description: 'level according to OpenStreetMap';
312
+ readonly type: 'number';
313
+ };
314
+ readonly arrival: {
315
+ readonly description: 'arrival time';
316
+ readonly type: 'string';
317
+ readonly format: 'date-time';
318
+ };
319
+ readonly departure: {
320
+ readonly description: 'departure time';
321
+ readonly type: 'string';
322
+ readonly format: 'date-time';
323
+ };
324
+ readonly scheduledArrival: {
325
+ readonly description: 'scheduled arrival time';
326
+ readonly type: 'string';
327
+ readonly format: 'date-time';
328
+ };
329
+ readonly scheduledDeparture: {
330
+ readonly description: 'scheduled departure time';
331
+ readonly type: 'string';
332
+ readonly format: 'date-time';
333
+ };
334
+ readonly scheduledTrack: {
335
+ readonly description: 'scheduled track from the static schedule timetable dataset';
336
+ readonly type: 'string';
337
+ };
338
+ readonly track: {
339
+ readonly description: 'The current track/platform information, updated with real-time updates if available. \nCan be missing if neither real-time updates nor the schedule timetable contains track information.\n';
340
+ readonly type: 'string';
341
+ };
342
+ readonly description: {
343
+ readonly description: 'description of the location that provides more detailed information';
344
+ readonly type: 'string';
345
+ };
346
+ readonly vertexType: {
347
+ readonly $ref: '#/components/schemas/VertexType';
348
+ };
349
+ readonly pickupType: {
350
+ readonly description: 'Type of pickup. It could be disallowed due to schedule, skipped stops or cancellations.';
351
+ readonly $ref: '#/components/schemas/PickupDropoffType';
352
+ };
353
+ readonly dropoffType: {
354
+ readonly description: 'Type of dropoff. It could be disallowed due to schedule, skipped stops or cancellations.';
355
+ readonly $ref: '#/components/schemas/PickupDropoffType';
356
+ };
357
+ readonly cancelled: {
358
+ readonly description: 'Whether this stop is cancelled due to the realtime situation.';
359
+ readonly type: 'boolean';
360
+ };
361
+ readonly alerts: {
362
+ readonly description: 'Alerts for this stop.';
363
+ readonly type: 'array';
364
+ readonly items: {
365
+ readonly $ref: '#/components/schemas/Alert';
366
+ };
367
+ };
368
+ readonly flex: {
369
+ readonly description: 'for `FLEX` transports, the flex location area or location group name';
370
+ readonly type: 'string';
371
+ };
372
+ readonly flexId: {
373
+ readonly description: 'for `FLEX` transports, the flex location area ID or location group ID';
374
+ readonly type: 'string';
375
+ };
376
+ readonly flexStartPickupDropOffWindow: {
377
+ readonly description: 'Time that on-demand service becomes available';
378
+ readonly type: 'string';
379
+ readonly format: 'date-time';
380
+ };
381
+ readonly flexEndPickupDropOffWindow: {
382
+ readonly description: 'Time that on-demand service ends';
383
+ readonly type: 'string';
384
+ readonly format: 'date-time';
385
+ };
386
+ };
336
387
  };
337
388
  declare const ReachablePlaceSchema: {
338
- readonly description: "Place reachable by One-to-All";
339
- readonly type: "object";
340
- readonly properties: {
341
- readonly place: {
342
- readonly $ref: "#/components/schemas/Place";
343
- readonly description: "Place reached by One-to-All";
344
- };
345
- readonly duration: {
346
- readonly type: "integer";
347
- readonly description: "Total travel duration";
348
- };
349
- readonly k: {
350
- readonly type: "integer";
351
- readonly description: "k is the smallest number, for which a journey with the shortest duration and at most k-1 transfers exist.\nYou can think of k as the number of connections used.\n\nIn more detail:\n\nk=0: No connection, e.g. for the one location\nk=1: Direct connection\nk=2: Connection with 1 transfer\n";
352
- };
353
- };
389
+ readonly description: 'Place reachable by One-to-All';
390
+ readonly type: 'object';
391
+ readonly properties: {
392
+ readonly place: {
393
+ readonly $ref: '#/components/schemas/Place';
394
+ readonly description: 'Place reached by One-to-All';
395
+ };
396
+ readonly duration: {
397
+ readonly type: 'integer';
398
+ readonly description: 'Total travel duration';
399
+ };
400
+ readonly k: {
401
+ readonly type: 'integer';
402
+ readonly description: 'k is the smallest number, for which a journey with the shortest duration and at most k-1 transfers exist.\nYou can think of k as the number of connections used.\n\nIn more detail:\n\nk=0: No connection, e.g. for the one location\nk=1: Direct connection\nk=2: Connection with 1 transfer\n';
403
+ };
404
+ };
354
405
  };
355
406
  declare const ReachableSchema: {
356
- readonly description: "Object containing all reachable places by One-to-All search";
357
- readonly type: "object";
358
- readonly properties: {
359
- readonly one: {
360
- readonly $ref: "#/components/schemas/Place";
361
- readonly description: "One location used in One-to-All search";
362
- };
363
- readonly all: {
364
- readonly description: "List of locations reachable by One-to-All";
365
- readonly type: "array";
366
- readonly items: {
367
- readonly $ref: "#/components/schemas/ReachablePlace";
368
- };
369
- };
370
- };
407
+ readonly description: 'Object containing all reachable places by One-to-All search';
408
+ readonly type: 'object';
409
+ readonly properties: {
410
+ readonly one: {
411
+ readonly $ref: '#/components/schemas/Place';
412
+ readonly description: 'One location used in One-to-All search';
413
+ };
414
+ readonly all: {
415
+ readonly description: 'List of locations reachable by One-to-All';
416
+ readonly type: 'array';
417
+ readonly items: {
418
+ readonly $ref: '#/components/schemas/ReachablePlace';
419
+ };
420
+ };
421
+ };
371
422
  };
372
423
  declare const StopTimeSchema: {
373
- readonly description: "departure or arrival event at a stop";
374
- readonly type: "object";
375
- readonly required: readonly ["place", "mode", "realTime", "headsign", "agencyId", "agencyName", "agencyUrl", "tripId", "routeShortName", "pickupDropoffType", "cancelled", "source"];
376
- readonly properties: {
377
- readonly place: {
378
- readonly $ref: "#/components/schemas/Place";
379
- readonly description: "information about the stop place and time";
380
- };
381
- readonly mode: {
382
- readonly $ref: "#/components/schemas/Mode";
383
- readonly description: "Transport mode for this leg";
384
- };
385
- readonly realTime: {
386
- readonly description: "Whether there is real-time data about this leg";
387
- readonly type: "boolean";
388
- };
389
- readonly headsign: {
390
- readonly description: "For transit legs, the headsign of the bus or train being used.\nFor non-transit legs, null\n";
391
- readonly type: "string";
392
- };
393
- readonly agencyId: {
394
- readonly type: "string";
395
- };
396
- readonly agencyName: {
397
- readonly type: "string";
398
- };
399
- readonly agencyUrl: {
400
- readonly type: "string";
401
- };
402
- readonly routeColor: {
403
- readonly type: "string";
404
- };
405
- readonly routeTextColor: {
406
- readonly type: "string";
407
- };
408
- readonly tripId: {
409
- readonly type: "string";
410
- };
411
- readonly routeShortName: {
412
- readonly type: "string";
413
- };
414
- readonly pickupDropoffType: {
415
- readonly description: "Type of pickup (for departures) or dropoff (for arrivals), may be disallowed either due to schedule, skipped stops or cancellations";
416
- readonly $ref: "#/components/schemas/PickupDropoffType";
417
- };
418
- readonly cancelled: {
419
- readonly description: "Whether the departure/arrival is cancelled due to the realtime situation.";
420
- readonly type: "boolean";
421
- };
422
- readonly source: {
423
- readonly description: "Filename and line number where this trip is from";
424
- readonly type: "string";
425
- };
426
- };
424
+ readonly description: 'departure or arrival event at a stop';
425
+ readonly type: 'object';
426
+ readonly required: readonly [
427
+ 'place',
428
+ 'mode',
429
+ 'realTime',
430
+ 'headsign',
431
+ 'agencyId',
432
+ 'agencyName',
433
+ 'agencyUrl',
434
+ 'tripId',
435
+ 'routeShortName',
436
+ 'pickupDropoffType',
437
+ 'cancelled',
438
+ 'source'
439
+ ];
440
+ readonly properties: {
441
+ readonly place: {
442
+ readonly $ref: '#/components/schemas/Place';
443
+ readonly description: 'information about the stop place and time';
444
+ };
445
+ readonly mode: {
446
+ readonly $ref: '#/components/schemas/Mode';
447
+ readonly description: 'Transport mode for this leg';
448
+ };
449
+ readonly realTime: {
450
+ readonly description: 'Whether there is real-time data about this leg';
451
+ readonly type: 'boolean';
452
+ };
453
+ readonly headsign: {
454
+ readonly description: 'For transit legs, the headsign of the bus or train being used.\nFor non-transit legs, null\n';
455
+ readonly type: 'string';
456
+ };
457
+ readonly agencyId: {
458
+ readonly type: 'string';
459
+ };
460
+ readonly agencyName: {
461
+ readonly type: 'string';
462
+ };
463
+ readonly agencyUrl: {
464
+ readonly type: 'string';
465
+ };
466
+ readonly routeColor: {
467
+ readonly type: 'string';
468
+ };
469
+ readonly routeTextColor: {
470
+ readonly type: 'string';
471
+ };
472
+ readonly tripId: {
473
+ readonly type: 'string';
474
+ };
475
+ readonly routeShortName: {
476
+ readonly type: 'string';
477
+ };
478
+ readonly pickupDropoffType: {
479
+ readonly description: 'Type of pickup (for departures) or dropoff (for arrivals), may be disallowed either due to schedule, skipped stops or cancellations';
480
+ readonly $ref: '#/components/schemas/PickupDropoffType';
481
+ };
482
+ readonly cancelled: {
483
+ readonly description: 'Whether the departure/arrival is cancelled due to the realtime situation.';
484
+ readonly type: 'boolean';
485
+ };
486
+ readonly source: {
487
+ readonly description: 'Filename and line number where this trip is from';
488
+ readonly type: 'string';
489
+ };
490
+ };
427
491
  };
428
492
  declare const TripInfoSchema: {
429
- readonly description: "trip id and name";
430
- readonly type: "object";
431
- readonly required: readonly ["tripId", "routeShortName"];
432
- readonly properties: {
433
- readonly tripId: {
434
- readonly description: "trip ID (dataset trip id prefixed with the dataset tag)";
435
- readonly type: "string";
436
- };
437
- readonly routeShortName: {
438
- readonly description: "trip display name";
439
- readonly type: "string";
440
- };
441
- };
493
+ readonly description: 'trip id and name';
494
+ readonly type: 'object';
495
+ readonly required: readonly ['tripId', 'routeShortName'];
496
+ readonly properties: {
497
+ readonly tripId: {
498
+ readonly description: 'trip ID (dataset trip id prefixed with the dataset tag)';
499
+ readonly type: 'string';
500
+ };
501
+ readonly routeShortName: {
502
+ readonly description: 'trip display name';
503
+ readonly type: 'string';
504
+ };
505
+ };
442
506
  };
443
507
  declare const TripSegmentSchema: {
444
- readonly description: "trip segment between two stops to show a trip on a map";
445
- readonly type: "object";
446
- readonly required: readonly ["trips", "mode", "distance", "from", "to", "departure", "arrival", "scheduledArrival", "scheduledDeparture", "realTime", "polyline"];
447
- readonly properties: {
448
- readonly trips: {
449
- readonly type: "array";
450
- readonly items: {
451
- readonly $ref: "#/components/schemas/TripInfo";
452
- };
453
- };
454
- readonly routeColor: {
455
- readonly type: "string";
456
- };
457
- readonly mode: {
458
- readonly $ref: "#/components/schemas/Mode";
459
- readonly description: "Transport mode for this leg";
460
- };
461
- readonly distance: {
462
- readonly type: "number";
463
- readonly description: "distance in meters";
464
- };
465
- readonly from: {
466
- readonly $ref: "#/components/schemas/Place";
467
- };
468
- readonly to: {
469
- readonly $ref: "#/components/schemas/Place";
470
- };
471
- readonly departure: {
472
- readonly description: "departure time";
473
- readonly type: "string";
474
- readonly format: "date-time";
475
- };
476
- readonly arrival: {
477
- readonly description: "arrival time";
478
- readonly type: "string";
479
- readonly format: "date-time";
480
- };
481
- readonly scheduledDeparture: {
482
- readonly description: "scheduled departure time";
483
- readonly type: "string";
484
- readonly format: "date-time";
485
- };
486
- readonly scheduledArrival: {
487
- readonly description: "scheduled arrival time";
488
- readonly type: "string";
489
- readonly format: "date-time";
490
- };
491
- readonly realTime: {
492
- readonly description: "Whether there is real-time data about this leg";
493
- readonly type: "boolean";
494
- };
495
- readonly polyline: {
496
- readonly description: "Google polyline encoded coordinate sequence (with precision 5) where the trip travels on this segment.";
497
- readonly type: "string";
498
- };
499
- };
508
+ readonly description: 'trip segment between two stops to show a trip on a map';
509
+ readonly type: 'object';
510
+ readonly required: readonly [
511
+ 'trips',
512
+ 'mode',
513
+ 'distance',
514
+ 'from',
515
+ 'to',
516
+ 'departure',
517
+ 'arrival',
518
+ 'scheduledArrival',
519
+ 'scheduledDeparture',
520
+ 'realTime',
521
+ 'polyline'
522
+ ];
523
+ readonly properties: {
524
+ readonly trips: {
525
+ readonly type: 'array';
526
+ readonly items: {
527
+ readonly $ref: '#/components/schemas/TripInfo';
528
+ };
529
+ };
530
+ readonly routeColor: {
531
+ readonly type: 'string';
532
+ };
533
+ readonly mode: {
534
+ readonly $ref: '#/components/schemas/Mode';
535
+ readonly description: 'Transport mode for this leg';
536
+ };
537
+ readonly distance: {
538
+ readonly type: 'number';
539
+ readonly description: 'distance in meters';
540
+ };
541
+ readonly from: {
542
+ readonly $ref: '#/components/schemas/Place';
543
+ };
544
+ readonly to: {
545
+ readonly $ref: '#/components/schemas/Place';
546
+ };
547
+ readonly departure: {
548
+ readonly description: 'departure time';
549
+ readonly type: 'string';
550
+ readonly format: 'date-time';
551
+ };
552
+ readonly arrival: {
553
+ readonly description: 'arrival time';
554
+ readonly type: 'string';
555
+ readonly format: 'date-time';
556
+ };
557
+ readonly scheduledDeparture: {
558
+ readonly description: 'scheduled departure time';
559
+ readonly type: 'string';
560
+ readonly format: 'date-time';
561
+ };
562
+ readonly scheduledArrival: {
563
+ readonly description: 'scheduled arrival time';
564
+ readonly type: 'string';
565
+ readonly format: 'date-time';
566
+ };
567
+ readonly realTime: {
568
+ readonly description: 'Whether there is real-time data about this leg';
569
+ readonly type: 'boolean';
570
+ };
571
+ readonly polyline: {
572
+ readonly description: 'Google polyline encoded coordinate sequence (with precision 5) where the trip travels on this segment.';
573
+ readonly type: 'string';
574
+ };
575
+ };
500
576
  };
501
577
  declare const DirectionSchema: {
502
- readonly type: "string";
503
- readonly enum: readonly ["DEPART", "HARD_LEFT", "LEFT", "SLIGHTLY_LEFT", "CONTINUE", "SLIGHTLY_RIGHT", "RIGHT", "HARD_RIGHT", "CIRCLE_CLOCKWISE", "CIRCLE_COUNTERCLOCKWISE", "STAIRS", "ELEVATOR", "UTURN_LEFT", "UTURN_RIGHT"];
578
+ readonly type: 'string';
579
+ readonly enum: readonly [
580
+ 'DEPART',
581
+ 'HARD_LEFT',
582
+ 'LEFT',
583
+ 'SLIGHTLY_LEFT',
584
+ 'CONTINUE',
585
+ 'SLIGHTLY_RIGHT',
586
+ 'RIGHT',
587
+ 'HARD_RIGHT',
588
+ 'CIRCLE_CLOCKWISE',
589
+ 'CIRCLE_COUNTERCLOCKWISE',
590
+ 'STAIRS',
591
+ 'ELEVATOR',
592
+ 'UTURN_LEFT',
593
+ 'UTURN_RIGHT'
594
+ ];
504
595
  };
505
596
  declare const EncodedPolylineSchema: {
506
- readonly type: "object";
507
- readonly required: readonly ["points", "precision", "length"];
508
- readonly properties: {
509
- readonly points: {
510
- readonly description: "The encoded points of the polyline using the Google polyline encoding.";
511
- readonly type: "string";
512
- };
513
- readonly precision: {
514
- readonly description: "The precision of the returned polyline (7 for /v1, 6 for /v2)\nBe aware that with precision 7, coordinates with |longitude| > 107.37 are undefined/will overflow.\n";
515
- readonly type: "integer";
516
- };
517
- readonly length: {
518
- readonly description: "The number of points in the string";
519
- readonly type: "integer";
520
- readonly minimum: 0;
521
- };
522
- };
597
+ readonly type: 'object';
598
+ readonly required: readonly ['points', 'precision', 'length'];
599
+ readonly properties: {
600
+ readonly points: {
601
+ readonly description: 'The encoded points of the polyline using the Google polyline encoding.';
602
+ readonly type: 'string';
603
+ };
604
+ readonly precision: {
605
+ readonly description: 'The precision of the returned polyline (7 for /v1, 6 for /v2)\nBe aware that with precision 7, coordinates with |longitude| > 107.37 are undefined/will overflow.\n';
606
+ readonly type: 'integer';
607
+ };
608
+ readonly length: {
609
+ readonly description: 'The number of points in the string';
610
+ readonly type: 'integer';
611
+ readonly minimum: 0;
612
+ };
613
+ };
523
614
  };
524
615
  declare const StepInstructionSchema: {
525
- readonly type: "object";
526
- readonly required: readonly ["fromLevel", "toLevel", "polyline", "relativeDirection", "distance", "streetName", "exit", "stayOn", "area"];
527
- readonly properties: {
528
- readonly relativeDirection: {
529
- readonly $ref: "#/components/schemas/Direction";
530
- };
531
- readonly distance: {
532
- readonly description: "The distance in meters that this step takes.";
533
- readonly type: "number";
534
- };
535
- readonly fromLevel: {
536
- readonly description: "level where this segment starts, based on OpenStreetMap data";
537
- readonly type: "number";
538
- };
539
- readonly toLevel: {
540
- readonly description: "level where this segment starts, based on OpenStreetMap data";
541
- readonly type: "number";
542
- };
543
- readonly osmWay: {
544
- readonly description: "OpenStreetMap way index";
545
- readonly type: "integer";
546
- };
547
- readonly polyline: {
548
- readonly $ref: "#/components/schemas/EncodedPolyline";
549
- };
550
- readonly streetName: {
551
- readonly description: "The name of the street.";
552
- readonly type: "string";
553
- };
554
- readonly exit: {
555
- readonly description: "Not implemented!\nWhen exiting a highway or traffic circle, the exit name/number.\n";
556
- readonly type: "string";
557
- };
558
- readonly stayOn: {
559
- readonly description: "Not implemented!\nIndicates whether or not a street changes direction at an intersection.\n";
560
- readonly type: "boolean";
561
- };
562
- readonly area: {
563
- readonly description: "Not implemented!\nThis step is on an open area, such as a plaza or train platform,\nand thus the directions should say something like \"cross\"\n";
564
- readonly type: "boolean";
565
- };
566
- readonly toll: {
567
- readonly description: "Indicates that a fee must be paid by general traffic to use a road, road bridge or road tunnel.";
568
- readonly type: "boolean";
569
- };
570
- readonly accessRestriction: {
571
- readonly description: "Experimental. Indicates whether access to this part of the route is restricted.\nSee: https://wiki.openstreetmap.org/wiki/Conditional_restrictions\n";
572
- readonly type: "string";
573
- };
574
- readonly elevationUp: {
575
- readonly type: "integer";
576
- readonly description: "incline in meters across this path segment";
577
- };
578
- readonly elevationDown: {
579
- readonly type: "integer";
580
- readonly description: "decline in meters across this path segment";
581
- };
582
- };
616
+ readonly type: 'object';
617
+ readonly required: readonly [
618
+ 'fromLevel',
619
+ 'toLevel',
620
+ 'polyline',
621
+ 'relativeDirection',
622
+ 'distance',
623
+ 'streetName',
624
+ 'exit',
625
+ 'stayOn',
626
+ 'area'
627
+ ];
628
+ readonly properties: {
629
+ readonly relativeDirection: {
630
+ readonly $ref: '#/components/schemas/Direction';
631
+ };
632
+ readonly distance: {
633
+ readonly description: 'The distance in meters that this step takes.';
634
+ readonly type: 'number';
635
+ };
636
+ readonly fromLevel: {
637
+ readonly description: 'level where this segment starts, based on OpenStreetMap data';
638
+ readonly type: 'number';
639
+ };
640
+ readonly toLevel: {
641
+ readonly description: 'level where this segment starts, based on OpenStreetMap data';
642
+ readonly type: 'number';
643
+ };
644
+ readonly osmWay: {
645
+ readonly description: 'OpenStreetMap way index';
646
+ readonly type: 'integer';
647
+ };
648
+ readonly polyline: {
649
+ readonly $ref: '#/components/schemas/EncodedPolyline';
650
+ };
651
+ readonly streetName: {
652
+ readonly description: 'The name of the street.';
653
+ readonly type: 'string';
654
+ };
655
+ readonly exit: {
656
+ readonly description: 'Not implemented!\nWhen exiting a highway or traffic circle, the exit name/number.\n';
657
+ readonly type: 'string';
658
+ };
659
+ readonly stayOn: {
660
+ readonly description: 'Not implemented!\nIndicates whether or not a street changes direction at an intersection.\n';
661
+ readonly type: 'boolean';
662
+ };
663
+ readonly area: {
664
+ readonly description: 'Not implemented!\nThis step is on an open area, such as a plaza or train platform,\nand thus the directions should say something like "cross"\n';
665
+ readonly type: 'boolean';
666
+ };
667
+ readonly toll: {
668
+ readonly description: 'Indicates that a fee must be paid by general traffic to use a road, road bridge or road tunnel.';
669
+ readonly type: 'boolean';
670
+ };
671
+ readonly accessRestriction: {
672
+ readonly description: 'Experimental. Indicates whether access to this part of the route is restricted.\nSee: https://wiki.openstreetmap.org/wiki/Conditional_restrictions\n';
673
+ readonly type: 'string';
674
+ };
675
+ readonly elevationUp: {
676
+ readonly type: 'integer';
677
+ readonly description: 'incline in meters across this path segment';
678
+ };
679
+ readonly elevationDown: {
680
+ readonly type: 'integer';
681
+ readonly description: 'decline in meters across this path segment';
682
+ };
683
+ };
583
684
  };
584
685
  declare const RentalFormFactorSchema: {
585
- readonly type: "string";
586
- readonly enum: readonly ["BICYCLE", "CARGO_BICYCLE", "CAR", "MOPED", "SCOOTER_STANDING", "SCOOTER_SEATED", "OTHER"];
686
+ readonly type: 'string';
687
+ readonly enum: readonly [
688
+ 'BICYCLE',
689
+ 'CARGO_BICYCLE',
690
+ 'CAR',
691
+ 'MOPED',
692
+ 'SCOOTER_STANDING',
693
+ 'SCOOTER_SEATED',
694
+ 'OTHER'
695
+ ];
587
696
  };
588
697
  declare const RentalPropulsionTypeSchema: {
589
- readonly type: "string";
590
- readonly enum: readonly ["HUMAN", "ELECTRIC_ASSIST", "ELECTRIC", "COMBUSTION", "COMBUSTION_DIESEL", "HYBRID", "PLUG_IN_HYBRID", "HYDROGEN_FUEL_CELL"];
698
+ readonly type: 'string';
699
+ readonly enum: readonly [
700
+ 'HUMAN',
701
+ 'ELECTRIC_ASSIST',
702
+ 'ELECTRIC',
703
+ 'COMBUSTION',
704
+ 'COMBUSTION_DIESEL',
705
+ 'HYBRID',
706
+ 'PLUG_IN_HYBRID',
707
+ 'HYDROGEN_FUEL_CELL'
708
+ ];
591
709
  };
592
710
  declare const RentalReturnConstraintSchema: {
593
- readonly type: "string";
594
- readonly enum: readonly ["NONE", "ANY_STATION", "ROUNDTRIP_STATION"];
711
+ readonly type: 'string';
712
+ readonly enum: readonly ['NONE', 'ANY_STATION', 'ROUNDTRIP_STATION'];
595
713
  };
596
714
  declare const RentalSchema: {
597
- readonly description: "Vehicle rental";
598
- readonly type: "object";
599
- readonly required: readonly ["systemId"];
600
- readonly properties: {
601
- readonly systemId: {
602
- readonly type: "string";
603
- readonly description: "Vehicle share system ID";
604
- };
605
- readonly systemName: {
606
- readonly type: "string";
607
- readonly description: "Vehicle share system name";
608
- };
609
- readonly url: {
610
- readonly type: "string";
611
- readonly description: "URL of the vehicle share system";
612
- };
613
- readonly stationName: {
614
- readonly type: "string";
615
- readonly description: "Name of the station";
616
- };
617
- readonly fromStationName: {
618
- readonly type: "string";
619
- readonly description: "Name of the station where the vehicle is picked up (empty for free floating vehicles)";
620
- };
621
- readonly toStationName: {
622
- readonly type: "string";
623
- readonly description: "Name of the station where the vehicle is returned (empty for free floating vehicles)";
624
- };
625
- readonly rentalUriAndroid: {
626
- readonly type: "string";
627
- readonly description: "Rental URI for Android (deep link to the specific station or vehicle)";
628
- };
629
- readonly rentalUriIOS: {
630
- readonly type: "string";
631
- readonly description: "Rental URI for iOS (deep link to the specific station or vehicle)";
632
- };
633
- readonly rentalUriWeb: {
634
- readonly type: "string";
635
- readonly description: "Rental URI for web (deep link to the specific station or vehicle)";
636
- };
637
- readonly formFactor: {
638
- readonly $ref: "#/components/schemas/RentalFormFactor";
639
- };
640
- readonly propulsionType: {
641
- readonly $ref: "#/components/schemas/RentalPropulsionType";
642
- };
643
- readonly returnConstraint: {
644
- readonly $ref: "#/components/schemas/RentalReturnConstraint";
645
- };
646
- };
715
+ readonly description: 'Vehicle rental';
716
+ readonly type: 'object';
717
+ readonly required: readonly ['systemId'];
718
+ readonly properties: {
719
+ readonly systemId: {
720
+ readonly type: 'string';
721
+ readonly description: 'Vehicle share system ID';
722
+ };
723
+ readonly systemName: {
724
+ readonly type: 'string';
725
+ readonly description: 'Vehicle share system name';
726
+ };
727
+ readonly url: {
728
+ readonly type: 'string';
729
+ readonly description: 'URL of the vehicle share system';
730
+ };
731
+ readonly stationName: {
732
+ readonly type: 'string';
733
+ readonly description: 'Name of the station';
734
+ };
735
+ readonly fromStationName: {
736
+ readonly type: 'string';
737
+ readonly description: 'Name of the station where the vehicle is picked up (empty for free floating vehicles)';
738
+ };
739
+ readonly toStationName: {
740
+ readonly type: 'string';
741
+ readonly description: 'Name of the station where the vehicle is returned (empty for free floating vehicles)';
742
+ };
743
+ readonly rentalUriAndroid: {
744
+ readonly type: 'string';
745
+ readonly description: 'Rental URI for Android (deep link to the specific station or vehicle)';
746
+ };
747
+ readonly rentalUriIOS: {
748
+ readonly type: 'string';
749
+ readonly description: 'Rental URI for iOS (deep link to the specific station or vehicle)';
750
+ };
751
+ readonly rentalUriWeb: {
752
+ readonly type: 'string';
753
+ readonly description: 'Rental URI for web (deep link to the specific station or vehicle)';
754
+ };
755
+ readonly formFactor: {
756
+ readonly $ref: '#/components/schemas/RentalFormFactor';
757
+ };
758
+ readonly propulsionType: {
759
+ readonly $ref: '#/components/schemas/RentalPropulsionType';
760
+ };
761
+ readonly returnConstraint: {
762
+ readonly $ref: '#/components/schemas/RentalReturnConstraint';
763
+ };
764
+ };
647
765
  };
648
766
  declare const LegSchema: {
649
- readonly type: "object";
650
- readonly required: readonly ["mode", "startTime", "endTime", "scheduledStartTime", "scheduledEndTime", "realTime", "scheduled", "duration", "from", "to", "legGeometry"];
651
- readonly properties: {
652
- readonly mode: {
653
- readonly $ref: "#/components/schemas/Mode";
654
- readonly description: "Transport mode for this leg";
655
- };
656
- readonly from: {
657
- readonly $ref: "#/components/schemas/Place";
658
- };
659
- readonly to: {
660
- readonly $ref: "#/components/schemas/Place";
661
- };
662
- readonly duration: {
663
- readonly description: "Leg duration in seconds\n\nIf leg is footpath:\n The footpath duration is derived from the default footpath\n duration using the query parameters `transferTimeFactor` and\n `additionalTransferTime` as follows:\n `leg.duration = defaultDuration * transferTimeFactor + additionalTransferTime.`\n In case the defaultDuration is needed, it can be calculated by\n `defaultDuration = (leg.duration - additionalTransferTime) / transferTimeFactor`.\n Note that the default values are `transferTimeFactor = 1` and\n `additionalTransferTime = 0` in case they are not explicitly\n provided in the query.\n";
664
- readonly type: "integer";
665
- };
666
- readonly startTime: {
667
- readonly type: "string";
668
- readonly format: "date-time";
669
- readonly description: "leg departure time";
670
- };
671
- readonly endTime: {
672
- readonly type: "string";
673
- readonly format: "date-time";
674
- readonly description: "leg arrival time";
675
- };
676
- readonly scheduledStartTime: {
677
- readonly type: "string";
678
- readonly format: "date-time";
679
- readonly description: "scheduled leg departure time";
680
- };
681
- readonly scheduledEndTime: {
682
- readonly type: "string";
683
- readonly format: "date-time";
684
- readonly description: "scheduled leg arrival time";
685
- };
686
- readonly realTime: {
687
- readonly description: "Whether there is real-time data about this leg";
688
- readonly type: "boolean";
689
- };
690
- readonly scheduled: {
691
- readonly description: "Whether this leg was originally scheduled to run or is an additional service.\nScheduled times will equal realtime times in this case.\n";
692
- readonly type: "boolean";
693
- };
694
- readonly distance: {
695
- readonly description: "For non-transit legs the distance traveled while traversing this leg in meters.";
696
- readonly type: "number";
697
- };
698
- readonly interlineWithPreviousLeg: {
699
- readonly description: "For transit legs, if the rider should stay on the vehicle as it changes route names.";
700
- readonly type: "boolean";
701
- };
702
- readonly headsign: {
703
- readonly description: "For transit legs, the headsign of the bus or train being used.\nFor non-transit legs, null\n";
704
- readonly type: "string";
705
- };
706
- readonly routeColor: {
707
- readonly type: "string";
708
- };
709
- readonly routeTextColor: {
710
- readonly type: "string";
711
- };
712
- readonly routeType: {
713
- readonly type: "string";
714
- };
715
- readonly agencyName: {
716
- readonly type: "string";
717
- };
718
- readonly agencyUrl: {
719
- readonly type: "string";
720
- };
721
- readonly agencyId: {
722
- readonly type: "string";
723
- };
724
- readonly tripId: {
725
- readonly type: "string";
726
- };
727
- readonly routeShortName: {
728
- readonly type: "string";
729
- };
730
- readonly cancelled: {
731
- readonly description: "Whether this trip is cancelled";
732
- readonly type: "boolean";
733
- };
734
- readonly source: {
735
- readonly description: "Filename and line number where this trip is from";
736
- readonly type: "string";
737
- };
738
- readonly intermediateStops: {
739
- readonly description: "For transit legs, intermediate stops between the Place where the leg originates\nand the Place where the leg ends. For non-transit legs, null.\n";
740
- readonly type: "array";
741
- readonly items: {
742
- readonly $ref: "#/components/schemas/Place";
743
- };
744
- };
745
- readonly legGeometry: {
746
- readonly $ref: "#/components/schemas/EncodedPolyline";
747
- };
748
- readonly steps: {
749
- readonly description: "A series of turn by turn instructions\nused for walking, biking and driving.\n";
750
- readonly type: "array";
751
- readonly items: {
752
- readonly $ref: "#/components/schemas/StepInstruction";
753
- };
754
- };
755
- readonly rental: {
756
- readonly $ref: "#/components/schemas/Rental";
757
- };
758
- readonly fareTransferIndex: {
759
- readonly type: "integer";
760
- readonly description: "Index into `Itinerary.fareTransfers` array\nto identify which fare transfer this leg belongs to\n";
761
- };
762
- readonly effectiveFareLegIndex: {
763
- readonly type: "integer";
764
- readonly description: "Index into the `Itinerary.fareTransfers[fareTransferIndex].effectiveFareLegProducts` array\nto identify which effective fare leg this itinerary leg belongs to\n";
765
- };
766
- readonly alerts: {
767
- readonly description: "Alerts for this stop.";
768
- readonly type: "array";
769
- readonly items: {
770
- readonly $ref: "#/components/schemas/Alert";
771
- };
772
- };
773
- };
767
+ readonly type: 'object';
768
+ readonly required: readonly [
769
+ 'mode',
770
+ 'startTime',
771
+ 'endTime',
772
+ 'scheduledStartTime',
773
+ 'scheduledEndTime',
774
+ 'realTime',
775
+ 'scheduled',
776
+ 'duration',
777
+ 'from',
778
+ 'to',
779
+ 'legGeometry'
780
+ ];
781
+ readonly properties: {
782
+ readonly mode: {
783
+ readonly $ref: '#/components/schemas/Mode';
784
+ readonly description: 'Transport mode for this leg';
785
+ };
786
+ readonly from: {
787
+ readonly $ref: '#/components/schemas/Place';
788
+ };
789
+ readonly to: {
790
+ readonly $ref: '#/components/schemas/Place';
791
+ };
792
+ readonly duration: {
793
+ readonly description: 'Leg duration in seconds\n\nIf leg is footpath:\n The footpath duration is derived from the default footpath\n duration using the query parameters `transferTimeFactor` and\n `additionalTransferTime` as follows:\n `leg.duration = defaultDuration * transferTimeFactor + additionalTransferTime.`\n In case the defaultDuration is needed, it can be calculated by\n `defaultDuration = (leg.duration - additionalTransferTime) / transferTimeFactor`.\n Note that the default values are `transferTimeFactor = 1` and\n `additionalTransferTime = 0` in case they are not explicitly\n provided in the query.\n';
794
+ readonly type: 'integer';
795
+ };
796
+ readonly startTime: {
797
+ readonly type: 'string';
798
+ readonly format: 'date-time';
799
+ readonly description: 'leg departure time';
800
+ };
801
+ readonly endTime: {
802
+ readonly type: 'string';
803
+ readonly format: 'date-time';
804
+ readonly description: 'leg arrival time';
805
+ };
806
+ readonly scheduledStartTime: {
807
+ readonly type: 'string';
808
+ readonly format: 'date-time';
809
+ readonly description: 'scheduled leg departure time';
810
+ };
811
+ readonly scheduledEndTime: {
812
+ readonly type: 'string';
813
+ readonly format: 'date-time';
814
+ readonly description: 'scheduled leg arrival time';
815
+ };
816
+ readonly realTime: {
817
+ readonly description: 'Whether there is real-time data about this leg';
818
+ readonly type: 'boolean';
819
+ };
820
+ readonly scheduled: {
821
+ readonly description: 'Whether this leg was originally scheduled to run or is an additional service.\nScheduled times will equal realtime times in this case.\n';
822
+ readonly type: 'boolean';
823
+ };
824
+ readonly distance: {
825
+ readonly description: 'For non-transit legs the distance traveled while traversing this leg in meters.';
826
+ readonly type: 'number';
827
+ };
828
+ readonly interlineWithPreviousLeg: {
829
+ readonly description: 'For transit legs, if the rider should stay on the vehicle as it changes route names.';
830
+ readonly type: 'boolean';
831
+ };
832
+ readonly headsign: {
833
+ readonly description: 'For transit legs, the headsign of the bus or train being used.\nFor non-transit legs, null\n';
834
+ readonly type: 'string';
835
+ };
836
+ readonly routeColor: {
837
+ readonly type: 'string';
838
+ };
839
+ readonly routeTextColor: {
840
+ readonly type: 'string';
841
+ };
842
+ readonly routeType: {
843
+ readonly type: 'string';
844
+ };
845
+ readonly agencyName: {
846
+ readonly type: 'string';
847
+ };
848
+ readonly agencyUrl: {
849
+ readonly type: 'string';
850
+ };
851
+ readonly agencyId: {
852
+ readonly type: 'string';
853
+ };
854
+ readonly tripId: {
855
+ readonly type: 'string';
856
+ };
857
+ readonly routeShortName: {
858
+ readonly type: 'string';
859
+ };
860
+ readonly cancelled: {
861
+ readonly description: 'Whether this trip is cancelled';
862
+ readonly type: 'boolean';
863
+ };
864
+ readonly source: {
865
+ readonly description: 'Filename and line number where this trip is from';
866
+ readonly type: 'string';
867
+ };
868
+ readonly intermediateStops: {
869
+ readonly description: 'For transit legs, intermediate stops between the Place where the leg originates\nand the Place where the leg ends. For non-transit legs, null.\n';
870
+ readonly type: 'array';
871
+ readonly items: {
872
+ readonly $ref: '#/components/schemas/Place';
873
+ };
874
+ };
875
+ readonly legGeometry: {
876
+ readonly $ref: '#/components/schemas/EncodedPolyline';
877
+ };
878
+ readonly steps: {
879
+ readonly description: 'A series of turn by turn instructions\nused for walking, biking and driving.\n';
880
+ readonly type: 'array';
881
+ readonly items: {
882
+ readonly $ref: '#/components/schemas/StepInstruction';
883
+ };
884
+ };
885
+ readonly rental: {
886
+ readonly $ref: '#/components/schemas/Rental';
887
+ };
888
+ readonly fareTransferIndex: {
889
+ readonly type: 'integer';
890
+ readonly description: 'Index into `Itinerary.fareTransfers` array\nto identify which fare transfer this leg belongs to\n';
891
+ };
892
+ readonly effectiveFareLegIndex: {
893
+ readonly type: 'integer';
894
+ readonly description: 'Index into the `Itinerary.fareTransfers[fareTransferIndex].effectiveFareLegProducts` array\nto identify which effective fare leg this itinerary leg belongs to\n';
895
+ };
896
+ readonly alerts: {
897
+ readonly description: 'Alerts for this stop.';
898
+ readonly type: 'array';
899
+ readonly items: {
900
+ readonly $ref: '#/components/schemas/Alert';
901
+ };
902
+ };
903
+ };
774
904
  };
775
905
  declare const RiderCategorySchema: {
776
- readonly type: "object";
777
- readonly required: readonly ["riderCategoryName", "isDefaultFareCategory"];
778
- readonly properties: {
779
- readonly riderCategoryName: {
780
- readonly description: "Rider category name as displayed to the rider.";
781
- readonly type: "string";
782
- };
783
- readonly isDefaultFareCategory: {
784
- readonly description: "Specifies if this category should be considered the default (i.e. the main category displayed to riders).";
785
- readonly type: "boolean";
786
- };
787
- readonly eligibilityUrl: {
788
- readonly description: "URL to a web page providing detailed information about the rider category and/or its eligibility criteria.";
789
- readonly type: "string";
790
- };
791
- };
906
+ readonly type: 'object';
907
+ readonly required: readonly ['riderCategoryName', 'isDefaultFareCategory'];
908
+ readonly properties: {
909
+ readonly riderCategoryName: {
910
+ readonly description: 'Rider category name as displayed to the rider.';
911
+ readonly type: 'string';
912
+ };
913
+ readonly isDefaultFareCategory: {
914
+ readonly description: 'Specifies if this category should be considered the default (i.e. the main category displayed to riders).';
915
+ readonly type: 'boolean';
916
+ };
917
+ readonly eligibilityUrl: {
918
+ readonly description: 'URL to a web page providing detailed information about the rider category and/or its eligibility criteria.';
919
+ readonly type: 'string';
920
+ };
921
+ };
792
922
  };
793
923
  declare const FareMediaTypeSchema: {
794
- readonly type: "string";
795
- readonly enum: readonly ["NONE", "PAPER_TICKET", "TRANSIT_CARD", "CONTACTLESS_EMV", "MOBILE_APP"];
796
- readonly enumDescriptions: {
797
- readonly NONE: "No fare media involved (e.g., cash payment)";
798
- readonly PAPER_TICKET: "Physical paper ticket";
799
- readonly TRANSIT_CARD: "Physical transit card with stored value";
800
- readonly CONTACTLESS_EMV: "cEMV (contactless payment)";
801
- readonly MOBILE_APP: "Mobile app with virtual transit cards/passes";
802
- };
924
+ readonly type: 'string';
925
+ readonly enum: readonly ['NONE', 'PAPER_TICKET', 'TRANSIT_CARD', 'CONTACTLESS_EMV', 'MOBILE_APP'];
926
+ readonly enumDescriptions: {
927
+ readonly NONE: 'No fare media involved (e.g., cash payment)';
928
+ readonly PAPER_TICKET: 'Physical paper ticket';
929
+ readonly TRANSIT_CARD: 'Physical transit card with stored value';
930
+ readonly CONTACTLESS_EMV: 'cEMV (contactless payment)';
931
+ readonly MOBILE_APP: 'Mobile app with virtual transit cards/passes';
932
+ };
803
933
  };
804
934
  declare const FareMediaSchema: {
805
- readonly type: "object";
806
- readonly required: readonly ["fareMediaType"];
807
- readonly properties: {
808
- readonly fareMediaName: {
809
- readonly description: "Name of the fare media. Required for transit cards and mobile apps.";
810
- readonly type: "string";
811
- };
812
- readonly fareMediaType: {
813
- readonly description: "The type of fare media.";
814
- readonly $ref: "#/components/schemas/FareMediaType";
815
- };
816
- };
935
+ readonly type: 'object';
936
+ readonly required: readonly ['fareMediaType'];
937
+ readonly properties: {
938
+ readonly fareMediaName: {
939
+ readonly description: 'Name of the fare media. Required for transit cards and mobile apps.';
940
+ readonly type: 'string';
941
+ };
942
+ readonly fareMediaType: {
943
+ readonly description: 'The type of fare media.';
944
+ readonly $ref: '#/components/schemas/FareMediaType';
945
+ };
946
+ };
817
947
  };
818
948
  declare const FareProductSchema: {
819
- readonly type: "object";
820
- readonly required: readonly ["name", "amount", "currency"];
821
- readonly properties: {
822
- readonly name: {
823
- readonly description: "The name of the fare product as displayed to riders.";
824
- readonly type: "string";
825
- };
826
- readonly amount: {
827
- readonly description: "The cost of the fare product. May be negative to represent transfer discounts. May be zero to represent a fare product that is free.";
828
- readonly type: "number";
829
- };
830
- readonly currency: {
831
- readonly description: "ISO 4217 currency code. The currency of the cost of the fare product.";
832
- readonly type: "string";
833
- };
834
- readonly riderCategory: {
835
- readonly $ref: "#/components/schemas/RiderCategory";
836
- };
837
- readonly media: {
838
- readonly $ref: "#/components/schemas/FareMedia";
839
- };
840
- };
949
+ readonly type: 'object';
950
+ readonly required: readonly ['name', 'amount', 'currency'];
951
+ readonly properties: {
952
+ readonly name: {
953
+ readonly description: 'The name of the fare product as displayed to riders.';
954
+ readonly type: 'string';
955
+ };
956
+ readonly amount: {
957
+ readonly description: 'The cost of the fare product. May be negative to represent transfer discounts. May be zero to represent a fare product that is free.';
958
+ readonly type: 'number';
959
+ };
960
+ readonly currency: {
961
+ readonly description: 'ISO 4217 currency code. The currency of the cost of the fare product.';
962
+ readonly type: 'string';
963
+ };
964
+ readonly riderCategory: {
965
+ readonly $ref: '#/components/schemas/RiderCategory';
966
+ };
967
+ readonly media: {
968
+ readonly $ref: '#/components/schemas/FareMedia';
969
+ };
970
+ };
841
971
  };
842
972
  declare const FareTransferRuleSchema: {
843
- readonly type: "string";
844
- readonly enum: readonly ["A_AB", "A_AB_B", "AB"];
973
+ readonly type: 'string';
974
+ readonly enum: readonly ['A_AB', 'A_AB_B', 'AB'];
845
975
  };
846
976
  declare const FareTransferSchema: {
847
- readonly type: "object";
848
- readonly description: "The concept is derived from: https://gtfs.org/documentation/schedule/reference/#fare_transfer_rulestxt\n\nTerminology:\n - **Leg**: An itinerary leg as described by the `Leg` type of this API description.\n - **Effective Fare Leg**: Itinerary legs can be joined together to form one *effective fare leg*.\n - **Fare Transfer**: A fare transfer groups two or more effective fare legs.\n - **A** is the first *effective fare leg* of potentially multiple consecutive legs contained in a fare transfer\n - **B** is any *effective fare leg* following the first *effective fare leg* in this transfer\n - **AB** are all changes between *effective fare legs* contained in this transfer\n\nThe fare transfer rule is used to derive the final set of products of the itinerary legs contained in this transfer:\n - A_AB means that any product from the first effective fare leg combined with the product attached to the transfer itself (AB) which can be empty (= free). Note that all subsequent effective fare leg products need to be ignored in this case.\n - A_AB_B mean that a product for each effective fare leg needs to be purchased in a addition to the product attached to the transfer itself (AB) which can be empty (= free)\n - AB only the transfer product itself has to be purchased. Note that all fare products attached to the contained effective fare legs need to be ignored in this case.\n\nAn itinerary `Leg` references the index of the fare transfer and the index of the effective fare leg in this transfer it belongs to.\n";
849
- readonly required: readonly ["effectiveFareLegProducts"];
850
- readonly properties: {
851
- readonly rule: {
852
- readonly $ref: "#/components/schemas/FareTransferRule";
853
- };
854
- readonly transferProducts: {
855
- readonly type: "array";
856
- readonly items: {
857
- readonly $ref: "#/components/schemas/FareProduct";
858
- };
859
- };
860
- readonly effectiveFareLegProducts: {
861
- readonly description: "Lists all valid fare products for the effective fare legs.\nThis is an `array<array<FareProduct>>` where the inner array\nlists all possible fare products that would cover this effective fare leg.\nEach \"effective fare leg\" can have multiple options for adult/child/weekly/monthly/day/one-way tickets etc.\nYou can see the outer array as AND (you need one ticket for each effective fare leg (`A_AB_B`), the first effective fare leg (`A_AB`) or no fare leg at all but only the transfer product (`AB`)\nand the inner array as OR (you can choose which ticket to buy)\n";
862
- readonly type: "array";
863
- readonly items: {
864
- readonly type: "array";
865
- readonly items: {
866
- readonly type: "array";
867
- readonly items: {
868
- readonly $ref: "#/components/schemas/FareProduct";
869
- };
870
- };
871
- };
872
- };
873
- };
977
+ readonly type: 'object';
978
+ readonly description: 'The concept is derived from: https://gtfs.org/documentation/schedule/reference/#fare_transfer_rulestxt\n\nTerminology:\n - **Leg**: An itinerary leg as described by the `Leg` type of this API description.\n - **Effective Fare Leg**: Itinerary legs can be joined together to form one *effective fare leg*.\n - **Fare Transfer**: A fare transfer groups two or more effective fare legs.\n - **A** is the first *effective fare leg* of potentially multiple consecutive legs contained in a fare transfer\n - **B** is any *effective fare leg* following the first *effective fare leg* in this transfer\n - **AB** are all changes between *effective fare legs* contained in this transfer\n\nThe fare transfer rule is used to derive the final set of products of the itinerary legs contained in this transfer:\n - A_AB means that any product from the first effective fare leg combined with the product attached to the transfer itself (AB) which can be empty (= free). Note that all subsequent effective fare leg products need to be ignored in this case.\n - A_AB_B mean that a product for each effective fare leg needs to be purchased in a addition to the product attached to the transfer itself (AB) which can be empty (= free)\n - AB only the transfer product itself has to be purchased. Note that all fare products attached to the contained effective fare legs need to be ignored in this case.\n\nAn itinerary `Leg` references the index of the fare transfer and the index of the effective fare leg in this transfer it belongs to.\n';
979
+ readonly required: readonly ['effectiveFareLegProducts'];
980
+ readonly properties: {
981
+ readonly rule: {
982
+ readonly $ref: '#/components/schemas/FareTransferRule';
983
+ };
984
+ readonly transferProducts: {
985
+ readonly type: 'array';
986
+ readonly items: {
987
+ readonly $ref: '#/components/schemas/FareProduct';
988
+ };
989
+ };
990
+ readonly effectiveFareLegProducts: {
991
+ readonly description: 'Lists all valid fare products for the effective fare legs.\nThis is an `array<array<FareProduct>>` where the inner array\nlists all possible fare products that would cover this effective fare leg.\nEach "effective fare leg" can have multiple options for adult/child/weekly/monthly/day/one-way tickets etc.\nYou can see the outer array as AND (you need one ticket for each effective fare leg (`A_AB_B`), the first effective fare leg (`A_AB`) or no fare leg at all but only the transfer product (`AB`)\nand the inner array as OR (you can choose which ticket to buy)\n';
992
+ readonly type: 'array';
993
+ readonly items: {
994
+ readonly type: 'array';
995
+ readonly items: {
996
+ readonly type: 'array';
997
+ readonly items: {
998
+ readonly $ref: '#/components/schemas/FareProduct';
999
+ };
1000
+ };
1001
+ };
1002
+ };
1003
+ };
874
1004
  };
875
1005
  declare const ItinerarySchema: {
876
- readonly type: "object";
877
- readonly required: readonly ["duration", "startTime", "endTime", "transfers", "legs"];
878
- readonly properties: {
879
- readonly duration: {
880
- readonly description: "journey duration in seconds";
881
- readonly type: "integer";
882
- };
883
- readonly startTime: {
884
- readonly type: "string";
885
- readonly format: "date-time";
886
- readonly description: "journey departure time";
887
- };
888
- readonly endTime: {
889
- readonly type: "string";
890
- readonly format: "date-time";
891
- readonly description: "journey arrival time";
892
- };
893
- readonly transfers: {
894
- readonly type: "integer";
895
- readonly description: "The number of transfers this trip has.";
896
- };
897
- readonly legs: {
898
- readonly description: "Journey legs";
899
- readonly type: "array";
900
- readonly items: {
901
- readonly $ref: "#/components/schemas/Leg";
902
- };
903
- };
904
- readonly fareTransfers: {
905
- readonly description: "Fare information";
906
- readonly type: "array";
907
- readonly items: {
908
- readonly $ref: "#/components/schemas/FareTransfer";
909
- };
910
- };
911
- };
1006
+ readonly type: 'object';
1007
+ readonly required: readonly ['duration', 'startTime', 'endTime', 'transfers', 'legs'];
1008
+ readonly properties: {
1009
+ readonly duration: {
1010
+ readonly description: 'journey duration in seconds';
1011
+ readonly type: 'integer';
1012
+ };
1013
+ readonly startTime: {
1014
+ readonly type: 'string';
1015
+ readonly format: 'date-time';
1016
+ readonly description: 'journey departure time';
1017
+ };
1018
+ readonly endTime: {
1019
+ readonly type: 'string';
1020
+ readonly format: 'date-time';
1021
+ readonly description: 'journey arrival time';
1022
+ };
1023
+ readonly transfers: {
1024
+ readonly type: 'integer';
1025
+ readonly description: 'The number of transfers this trip has.';
1026
+ };
1027
+ readonly legs: {
1028
+ readonly description: 'Journey legs';
1029
+ readonly type: 'array';
1030
+ readonly items: {
1031
+ readonly $ref: '#/components/schemas/Leg';
1032
+ };
1033
+ };
1034
+ readonly fareTransfers: {
1035
+ readonly description: 'Fare information';
1036
+ readonly type: 'array';
1037
+ readonly items: {
1038
+ readonly $ref: '#/components/schemas/FareTransfer';
1039
+ };
1040
+ };
1041
+ };
912
1042
  };
913
1043
  declare const TransferSchema: {
914
- readonly description: "transfer from one location to another";
915
- readonly type: "object";
916
- readonly required: readonly ["to"];
917
- readonly properties: {
918
- readonly to: {
919
- readonly $ref: "#/components/schemas/Place";
920
- };
921
- readonly default: {
922
- readonly type: "number";
923
- readonly description: "optional; missing if the GTFS did not contain a transfer\ntransfer duration in minutes according to GTFS (+heuristics)\n";
924
- };
925
- readonly foot: {
926
- readonly type: "number";
927
- readonly description: "optional; missing if no path was found (timetable / osr)\ntransfer duration in minutes for the foot profile\n";
928
- };
929
- readonly footRouted: {
930
- readonly type: "number";
931
- readonly description: "optional; missing if no path was found with foot routing\ntransfer duration in minutes for the foot profile\n";
932
- };
933
- readonly wheelchair: {
934
- readonly type: "number";
935
- readonly description: "optional; missing if no path was found with the wheelchair profile \ntransfer duration in minutes for the wheelchair profile\n";
936
- };
937
- readonly wheelchairRouted: {
938
- readonly type: "number";
939
- readonly description: "optional; missing if no path was found with the wheelchair profile\ntransfer duration in minutes for the wheelchair profile\n";
940
- };
941
- readonly wheelchairUsesElevator: {
942
- readonly type: "boolean";
943
- readonly description: "optional; missing if no path was found with the wheelchair profile\ntrue if the wheelchair path uses an elevator\n";
944
- };
945
- readonly car: {
946
- readonly type: "number";
947
- readonly description: "optional; missing if no path was found with car routing\ntransfer duration in minutes for the car profile\n";
948
- };
949
- };
1044
+ readonly description: 'transfer from one location to another';
1045
+ readonly type: 'object';
1046
+ readonly required: readonly ['to'];
1047
+ readonly properties: {
1048
+ readonly to: {
1049
+ readonly $ref: '#/components/schemas/Place';
1050
+ };
1051
+ readonly default: {
1052
+ readonly type: 'number';
1053
+ readonly description: 'optional; missing if the GTFS did not contain a transfer\ntransfer duration in minutes according to GTFS (+heuristics)\n';
1054
+ };
1055
+ readonly foot: {
1056
+ readonly type: 'number';
1057
+ readonly description: 'optional; missing if no path was found (timetable / osr)\ntransfer duration in minutes for the foot profile\n';
1058
+ };
1059
+ readonly footRouted: {
1060
+ readonly type: 'number';
1061
+ readonly description: 'optional; missing if no path was found with foot routing\ntransfer duration in minutes for the foot profile\n';
1062
+ };
1063
+ readonly wheelchair: {
1064
+ readonly type: 'number';
1065
+ readonly description: 'optional; missing if no path was found with the wheelchair profile \ntransfer duration in minutes for the wheelchair profile\n';
1066
+ };
1067
+ readonly wheelchairRouted: {
1068
+ readonly type: 'number';
1069
+ readonly description: 'optional; missing if no path was found with the wheelchair profile\ntransfer duration in minutes for the wheelchair profile\n';
1070
+ };
1071
+ readonly wheelchairUsesElevator: {
1072
+ readonly type: 'boolean';
1073
+ readonly description: 'optional; missing if no path was found with the wheelchair profile\ntrue if the wheelchair path uses an elevator\n';
1074
+ };
1075
+ readonly car: {
1076
+ readonly type: 'number';
1077
+ readonly description: 'optional; missing if no path was found with car routing\ntransfer duration in minutes for the car profile\n';
1078
+ };
1079
+ };
950
1080
  };
951
1081
 
952
- export { AlertCauseSchema, AlertEffectSchema, AlertSchema, AlertSeverityLevelSchema, AreaSchema, DirectionSchema, DurationSchema, ElevationCostsSchema, EncodedPolylineSchema, FareMediaSchema, FareMediaTypeSchema, FareProductSchema, FareTransferRuleSchema, FareTransferSchema, ItinerarySchema, LegSchema, LocationTypeSchema, MatchSchema, ModeSchema, PedestrianProfileSchema, PickupDropoffTypeSchema, PlaceSchema, ReachablePlaceSchema, ReachableSchema, RentalFormFactorSchema, RentalPropulsionTypeSchema, RentalReturnConstraintSchema, RentalSchema, RiderCategorySchema, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema };
1082
+ export {
1083
+ AlertCauseSchema,
1084
+ AlertEffectSchema,
1085
+ AlertSchema,
1086
+ AlertSeverityLevelSchema,
1087
+ AreaSchema,
1088
+ DirectionSchema,
1089
+ DurationSchema,
1090
+ ElevationCostsSchema,
1091
+ EncodedPolylineSchema,
1092
+ FareMediaSchema,
1093
+ FareMediaTypeSchema,
1094
+ FareProductSchema,
1095
+ FareTransferRuleSchema,
1096
+ FareTransferSchema,
1097
+ ItinerarySchema,
1098
+ LegSchema,
1099
+ LocationTypeSchema,
1100
+ MatchSchema,
1101
+ ModeSchema,
1102
+ PedestrianProfileSchema,
1103
+ PickupDropoffTypeSchema,
1104
+ PlaceSchema,
1105
+ ReachablePlaceSchema,
1106
+ ReachableSchema,
1107
+ RentalFormFactorSchema,
1108
+ RentalPropulsionTypeSchema,
1109
+ RentalReturnConstraintSchema,
1110
+ RentalSchema,
1111
+ RiderCategorySchema,
1112
+ StepInstructionSchema,
1113
+ StopTimeSchema,
1114
+ TimeRangeSchema,
1115
+ TokenSchema,
1116
+ TransferSchema,
1117
+ TripInfoSchema,
1118
+ TripSegmentSchema,
1119
+ VertexTypeSchema
1120
+ };