@motis-project/motis-client 2.0.92 → 2.0.98

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,34 +1,11 @@
1
1
  /**
2
2
  * Cause of this alert.
3
3
  */
4
- type AlertCause =
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';
4
+ type AlertCause = 'UNKNOWN_CAUSE' | 'OTHER_CAUSE' | 'TECHNICAL_PROBLEM' | 'STRIKE' | 'DEMONSTRATION' | 'ACCIDENT' | 'HOLIDAY' | 'WEATHER' | 'MAINTENANCE' | 'CONSTRUCTION' | 'POLICE_ACTIVITY' | 'MEDICAL_EMERGENCY';
17
5
  /**
18
6
  * The effect of this problem on the affected entity.
19
7
  */
20
- type AlertEffect =
21
- | 'NO_SERVICE'
22
- | 'REDUCED_SERVICE'
23
- | 'SIGNIFICANT_DELAYS'
24
- | 'DETOUR'
25
- | 'ADDITIONAL_SERVICE'
26
- | 'MODIFIED_SERVICE'
27
- | 'OTHER_EFFECT'
28
- | 'UNKNOWN_EFFECT'
29
- | 'STOP_MOVED'
30
- | 'NO_EFFECT'
31
- | 'ACCESSIBILITY_ISSUE';
8
+ type AlertEffect = 'NO_SERVICE' | 'REDUCED_SERVICE' | 'SIGNIFICANT_DELAYS' | 'DETOUR' | 'ADDITIONAL_SERVICE' | 'MODIFIED_SERVICE' | 'OTHER_EFFECT' | 'UNKNOWN_EFFECT' | 'STOP_MOVED' | 'NO_EFFECT' | 'ACCESSIBILITY_ISSUE';
32
9
  /**
33
10
  * The severity of the alert.
34
11
  */
@@ -39,143 +16,146 @@ type AlertSeverityLevel = 'UNKNOWN_SEVERITY' | 'INFO' | 'WARNING' | 'SEVERE';
39
16
  *
40
17
  */
41
18
  type TimeRange = {
42
- /**
43
- * If missing, the interval starts at minus infinity.
44
- * If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
45
- *
46
- */
47
- start?: string;
48
- /**
49
- * If missing, the interval ends at plus infinity.
50
- * If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
51
- *
52
- */
53
- end?: string;
19
+ /**
20
+ * If missing, the interval starts at minus infinity.
21
+ * If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
22
+ *
23
+ */
24
+ start?: string;
25
+ /**
26
+ * If missing, the interval ends at plus infinity.
27
+ * If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
28
+ *
29
+ */
30
+ end?: string;
54
31
  };
55
32
  /**
56
33
  * An alert, indicating some sort of incident in the public transit network.
57
34
  */
58
35
  type Alert = {
59
- /**
60
- * Time when the alert should be shown to the user.
61
- * If missing, the alert will be shown as long as it appears in the feed.
62
- * If multiple ranges are given, the alert will be shown during all of them.
63
- *
64
- */
65
- communicationPeriod?: Array<TimeRange>;
66
- /**
67
- * Time when the services are affected by the disruption mentioned in the alert.
68
- */
69
- impactPeriod?: Array<TimeRange>;
70
- cause?: AlertCause;
71
- /**
72
- * Description of the cause of the alert that allows for agency-specific language;
73
- * more specific than the Cause.
74
- *
75
- */
76
- causeDetail?: string;
77
- effect?: AlertEffect;
78
- /**
79
- * Description of the effect of the alert that allows for agency-specific language;
80
- * more specific than the Effect.
81
- *
82
- */
83
- effectDetail?: string;
84
- /**
85
- * The URL which provides additional information about the alert.
86
- */
87
- url?: string;
88
- /**
89
- * Header for the alert. This plain-text string will be highlighted, for example in boldface.
90
- *
91
- */
92
- headerText: string;
93
- /**
94
- * Description for the alert.
95
- * This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user).
96
- * The information in the description should add to the information of the header.
97
- *
98
- */
99
- descriptionText: string;
100
- /**
101
- * Text containing the alert's header to be used for text-to-speech implementations.
102
- * This field is the text-to-speech version of header_text.
103
- * It should contain the same information as headerText but formatted such that it can read as text-to-speech
104
- * (for example, abbreviations removed, numbers spelled out, etc.)
105
- *
106
- */
107
- ttsHeaderText?: string;
108
- /**
109
- * Text containing a description for the alert to be used for text-to-speech implementations.
110
- * This field is the text-to-speech version of description_text.
111
- * It should contain the same information as description_text but formatted such that it can be read as text-to-speech
112
- * (for example, abbreviations removed, numbers spelled out, etc.)
113
- *
114
- */
115
- ttsDescriptionText?: string;
116
- /**
117
- * Severity of the alert.
118
- */
119
- severityLevel?: AlertSeverityLevel;
120
- /**
121
- * String containing an URL linking to an image.
122
- */
123
- imageUrl?: string;
124
- /**
125
- * IANA media type as to specify the type of image to be displayed. The type must start with "image/"
126
- *
127
- */
128
- imageMediaType?: string;
129
- /**
130
- * Text describing the appearance of the linked image in the image field
131
- * (e.g., in case the image can't be displayed or the user can't see the image for accessibility reasons).
132
- * See the HTML spec for alt image text.
133
- *
134
- */
135
- imageAlternativeText?: string;
36
+ /**
37
+ * Time when the alert should be shown to the user.
38
+ * If missing, the alert will be shown as long as it appears in the feed.
39
+ * If multiple ranges are given, the alert will be shown during all of them.
40
+ *
41
+ */
42
+ communicationPeriod?: Array<TimeRange>;
43
+ /**
44
+ * Time when the services are affected by the disruption mentioned in the alert.
45
+ */
46
+ impactPeriod?: Array<TimeRange>;
47
+ cause?: AlertCause;
48
+ /**
49
+ * Description of the cause of the alert that allows for agency-specific language;
50
+ * more specific than the Cause.
51
+ *
52
+ */
53
+ causeDetail?: string;
54
+ effect?: AlertEffect;
55
+ /**
56
+ * Description of the effect of the alert that allows for agency-specific language;
57
+ * more specific than the Effect.
58
+ *
59
+ */
60
+ effectDetail?: string;
61
+ /**
62
+ * The URL which provides additional information about the alert.
63
+ */
64
+ url?: string;
65
+ /**
66
+ * Header for the alert. This plain-text string will be highlighted, for example in boldface.
67
+ *
68
+ */
69
+ headerText: string;
70
+ /**
71
+ * Description for the alert.
72
+ * This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user).
73
+ * The information in the description should add to the information of the header.
74
+ *
75
+ */
76
+ descriptionText: string;
77
+ /**
78
+ * Text containing the alert's header to be used for text-to-speech implementations.
79
+ * This field is the text-to-speech version of header_text.
80
+ * It should contain the same information as headerText but formatted such that it can read as text-to-speech
81
+ * (for example, abbreviations removed, numbers spelled out, etc.)
82
+ *
83
+ */
84
+ ttsHeaderText?: string;
85
+ /**
86
+ * Text containing a description for the alert to be used for text-to-speech implementations.
87
+ * This field is the text-to-speech version of description_text.
88
+ * It should contain the same information as description_text but formatted such that it can be read as text-to-speech
89
+ * (for example, abbreviations removed, numbers spelled out, etc.)
90
+ *
91
+ */
92
+ ttsDescriptionText?: string;
93
+ /**
94
+ * Severity of the alert.
95
+ */
96
+ severityLevel?: AlertSeverityLevel;
97
+ /**
98
+ * String containing an URL linking to an image.
99
+ */
100
+ imageUrl?: string;
101
+ /**
102
+ * IANA media type as to specify the type of image to be displayed. The type must start with "image/"
103
+ *
104
+ */
105
+ imageMediaType?: string;
106
+ /**
107
+ * Text describing the appearance of the linked image in the image field
108
+ * (e.g., in case the image can't be displayed or the user can't see the image for accessibility reasons).
109
+ * See the HTML spec for alt image text.
110
+ *
111
+ */
112
+ imageAlternativeText?: string;
136
113
  };
137
114
  /**
138
115
  * Object containing duration if a path was found or none if no path was found
139
116
  */
140
117
  type Duration = {
141
- /**
142
- * duration in seconds if a path was found, otherwise missing
143
- */
144
- duration?: number;
118
+ /**
119
+ * duration in seconds if a path was found, otherwise missing
120
+ */
121
+ duration?: number;
145
122
  };
146
123
  /**
147
124
  * Administrative area
148
125
  */
149
126
  type Area = {
150
- /**
151
- * Name of the area
152
- */
153
- name: string;
154
- /**
155
- * [OpenStreetMap `admin_level`](https://wiki.openstreetmap.org/wiki/Key:admin_level)
156
- * of the area
157
- *
158
- */
159
- adminLevel: number;
160
- /**
161
- * Whether this area was matched by the input text
162
- */
163
- matched: boolean;
164
- /**
165
- * Set for the first area after the `default` area that distinguishes areas
166
- * if the match is ambiguous regarding (`default` area + place name / street [+ house number]).
167
- *
168
- */
169
- unique?: boolean;
170
- /**
171
- * Whether this area should be displayed as default area (area with admin level closest 7)
172
- */
173
- default?: boolean;
127
+ /**
128
+ * Name of the area
129
+ */
130
+ name: string;
131
+ /**
132
+ * [OpenStreetMap `admin_level`](https://wiki.openstreetmap.org/wiki/Key:admin_level)
133
+ * of the area
134
+ *
135
+ */
136
+ adminLevel: number;
137
+ /**
138
+ * Whether this area was matched by the input text
139
+ */
140
+ matched: boolean;
141
+ /**
142
+ * Set for the first area after the `default` area that distinguishes areas
143
+ * if the match is ambiguous regarding (`default` area + place name / street [+ house number]).
144
+ *
145
+ */
146
+ unique?: boolean;
147
+ /**
148
+ * Whether this area should be displayed as default area (area with admin level closest 7)
149
+ */
150
+ default?: boolean;
174
151
  };
175
152
  /**
176
153
  * Matched token range (from index, length)
177
154
  */
178
- type Token = [number, number];
155
+ type Token = [
156
+ number,
157
+ number
158
+ ];
179
159
  /**
180
160
  * location type
181
161
  */
@@ -184,53 +164,53 @@ type LocationType = 'ADDRESS' | 'PLACE' | 'STOP';
184
164
  * GeoCoding match
185
165
  */
186
166
  type Match = {
187
- type: LocationType;
188
- /**
189
- * list of non-overlapping tokens that were matched
190
- */
191
- tokens: Array<Token>;
192
- /**
193
- * name of the location (transit stop / PoI / address)
194
- */
195
- name: string;
196
- /**
197
- * unique ID of the location
198
- */
199
- id: string;
200
- /**
201
- * latitude
202
- */
203
- lat: number;
204
- /**
205
- * longitude
206
- */
207
- lon: number;
208
- /**
209
- * level according to OpenStreetMap
210
- * (at the moment only for public transport)
211
- *
212
- */
213
- level?: number;
214
- /**
215
- * street name
216
- */
217
- street?: string;
218
- /**
219
- * house number
220
- */
221
- houseNumber?: string;
222
- /**
223
- * zip code
224
- */
225
- zip?: string;
226
- /**
227
- * list of areas
228
- */
229
- areas: Array<Area>;
230
- /**
231
- * score according to the internal scoring system (the scoring algorithm might change in the future)
232
- */
233
- score: number;
167
+ type: LocationType;
168
+ /**
169
+ * list of non-overlapping tokens that were matched
170
+ */
171
+ tokens: Array<Token>;
172
+ /**
173
+ * name of the location (transit stop / PoI / address)
174
+ */
175
+ name: string;
176
+ /**
177
+ * unique ID of the location
178
+ */
179
+ id: string;
180
+ /**
181
+ * latitude
182
+ */
183
+ lat: number;
184
+ /**
185
+ * longitude
186
+ */
187
+ lon: number;
188
+ /**
189
+ * level according to OpenStreetMap
190
+ * (at the moment only for public transport)
191
+ *
192
+ */
193
+ level?: number;
194
+ /**
195
+ * street name
196
+ */
197
+ street?: string;
198
+ /**
199
+ * house number
200
+ */
201
+ houseNumber?: string;
202
+ /**
203
+ * zip code
204
+ */
205
+ zip?: string;
206
+ /**
207
+ * list of areas
208
+ */
209
+ areas: Array<Area>;
210
+ /**
211
+ * score according to the internal scoring system (the scoring algorithm might change in the future)
212
+ */
213
+ score: number;
234
214
  };
235
215
  /**
236
216
  * Different elevation cost profiles for street routing.
@@ -279,33 +259,7 @@ type PedestrianProfile = 'FOOT' | 'WHEELCHAIR';
279
259
  * - `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.
280
260
  *
281
261
  */
282
- type Mode =
283
- | 'WALK'
284
- | 'BIKE'
285
- | 'RENTAL'
286
- | 'CAR'
287
- | 'CAR_PARKING'
288
- | 'CAR_DROPOFF'
289
- | 'ODM'
290
- | 'FLEX'
291
- | 'TRANSIT'
292
- | 'TRAM'
293
- | 'SUBWAY'
294
- | 'FERRY'
295
- | 'AIRPLANE'
296
- | 'METRO'
297
- | 'BUS'
298
- | 'COACH'
299
- | 'RAIL'
300
- | 'HIGHSPEED_RAIL'
301
- | 'LONG_DISTANCE'
302
- | 'NIGHT_RAIL'
303
- | 'REGIONAL_FAST_RAIL'
304
- | 'REGIONAL_RAIL'
305
- | 'CABLE_CAR'
306
- | 'FUNICULAR'
307
- | 'AREAL_LIFT'
308
- | 'OTHER';
262
+ type Mode = 'WALK' | 'BIKE' | 'RENTAL' | 'CAR' | 'CAR_PARKING' | 'CAR_DROPOFF' | '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';
309
263
  /**
310
264
  * - `NORMAL` - latitude / longitude coordinate or address
311
265
  * - `BIKESHARE` - bike sharing station
@@ -320,532 +274,503 @@ type VertexType = 'NORMAL' | 'BIKESHARE' | 'TRANSIT';
320
274
  */
321
275
  type PickupDropoffType = 'NORMAL' | 'NOT_ALLOWED';
322
276
  type Place = {
323
- /**
324
- * name of the transit stop / PoI / address
325
- */
326
- name: string;
327
- /**
328
- * The ID of the stop. This is often something that users don't care about.
329
- */
330
- stopId?: string;
331
- /**
332
- * latitude
333
- */
334
- lat: number;
335
- /**
336
- * longitude
337
- */
338
- lon: number;
339
- /**
340
- * level according to OpenStreetMap
341
- */
342
- level: number;
343
- /**
344
- * arrival time
345
- */
346
- arrival?: string;
347
- /**
348
- * departure time
349
- */
350
- departure?: string;
351
- /**
352
- * scheduled arrival time
353
- */
354
- scheduledArrival?: string;
355
- /**
356
- * scheduled departure time
357
- */
358
- scheduledDeparture?: string;
359
- /**
360
- * scheduled track from the static schedule timetable dataset
361
- */
362
- scheduledTrack?: string;
363
- /**
364
- * The current track/platform information, updated with real-time updates if available.
365
- * Can be missing if neither real-time updates nor the schedule timetable contains track information.
366
- *
367
- */
368
- track?: string;
369
- /**
370
- * description of the location that provides more detailed information
371
- */
372
- description?: string;
373
- vertexType?: VertexType;
374
- /**
375
- * Type of pickup. It could be disallowed due to schedule, skipped stops or cancellations.
376
- */
377
- pickupType?: PickupDropoffType;
378
- /**
379
- * Type of dropoff. It could be disallowed due to schedule, skipped stops or cancellations.
380
- */
381
- dropoffType?: PickupDropoffType;
382
- /**
383
- * Whether this stop is cancelled due to the realtime situation.
384
- */
385
- cancelled?: boolean;
386
- /**
387
- * Alerts for this stop.
388
- */
389
- alerts?: Array<Alert>;
390
- /**
391
- * for `FLEX` transports, the flex location area or location group name
392
- */
393
- flex?: string;
394
- /**
395
- * for `FLEX` transports, the flex location area ID or location group ID
396
- */
397
- flexId?: string;
398
- /**
399
- * Time that on-demand service becomes available
400
- */
401
- flexStartPickupDropOffWindow?: string;
402
- /**
403
- * Time that on-demand service ends
404
- */
405
- flexEndPickupDropOffWindow?: string;
277
+ /**
278
+ * name of the transit stop / PoI / address
279
+ */
280
+ name: string;
281
+ /**
282
+ * The ID of the stop. This is often something that users don't care about.
283
+ */
284
+ stopId?: string;
285
+ /**
286
+ * latitude
287
+ */
288
+ lat: number;
289
+ /**
290
+ * longitude
291
+ */
292
+ lon: number;
293
+ /**
294
+ * level according to OpenStreetMap
295
+ */
296
+ level: number;
297
+ /**
298
+ * arrival time
299
+ */
300
+ arrival?: string;
301
+ /**
302
+ * departure time
303
+ */
304
+ departure?: string;
305
+ /**
306
+ * scheduled arrival time
307
+ */
308
+ scheduledArrival?: string;
309
+ /**
310
+ * scheduled departure time
311
+ */
312
+ scheduledDeparture?: string;
313
+ /**
314
+ * scheduled track from the static schedule timetable dataset
315
+ */
316
+ scheduledTrack?: string;
317
+ /**
318
+ * The current track/platform information, updated with real-time updates if available.
319
+ * Can be missing if neither real-time updates nor the schedule timetable contains track information.
320
+ *
321
+ */
322
+ track?: string;
323
+ /**
324
+ * description of the location that provides more detailed information
325
+ */
326
+ description?: string;
327
+ vertexType?: VertexType;
328
+ /**
329
+ * Type of pickup. It could be disallowed due to schedule, skipped stops or cancellations.
330
+ */
331
+ pickupType?: PickupDropoffType;
332
+ /**
333
+ * Type of dropoff. It could be disallowed due to schedule, skipped stops or cancellations.
334
+ */
335
+ dropoffType?: PickupDropoffType;
336
+ /**
337
+ * Whether this stop is cancelled due to the realtime situation.
338
+ */
339
+ cancelled?: boolean;
340
+ /**
341
+ * Alerts for this stop.
342
+ */
343
+ alerts?: Array<Alert>;
344
+ /**
345
+ * for `FLEX` transports, the flex location area or location group name
346
+ */
347
+ flex?: string;
348
+ /**
349
+ * for `FLEX` transports, the flex location area ID or location group ID
350
+ */
351
+ flexId?: string;
352
+ /**
353
+ * Time that on-demand service becomes available
354
+ */
355
+ flexStartPickupDropOffWindow?: string;
356
+ /**
357
+ * Time that on-demand service ends
358
+ */
359
+ flexEndPickupDropOffWindow?: string;
406
360
  };
407
361
  /**
408
362
  * Place reachable by One-to-All
409
363
  */
410
364
  type ReachablePlace = {
411
- /**
412
- * Place reached by One-to-All
413
- */
414
- place?: Place;
415
- /**
416
- * Total travel duration
417
- */
418
- duration?: number;
419
- /**
420
- * k is the smallest number, for which a journey with the shortest duration and at most k-1 transfers exist.
421
- * You can think of k as the number of connections used.
422
- *
423
- * In more detail:
424
- *
425
- * k=0: No connection, e.g. for the one location
426
- * k=1: Direct connection
427
- * k=2: Connection with 1 transfer
428
- *
429
- */
430
- k?: number;
365
+ /**
366
+ * Place reached by One-to-All
367
+ */
368
+ place?: Place;
369
+ /**
370
+ * Total travel duration
371
+ */
372
+ duration?: number;
373
+ /**
374
+ * k is the smallest number, for which a journey with the shortest duration and at most k-1 transfers exist.
375
+ * You can think of k as the number of connections used.
376
+ *
377
+ * In more detail:
378
+ *
379
+ * k=0: No connection, e.g. for the one location
380
+ * k=1: Direct connection
381
+ * k=2: Connection with 1 transfer
382
+ *
383
+ */
384
+ k?: number;
431
385
  };
432
386
  /**
433
387
  * Object containing all reachable places by One-to-All search
434
388
  */
435
389
  type Reachable = {
436
- /**
437
- * One location used in One-to-All search
438
- */
439
- one?: Place;
440
- /**
441
- * List of locations reachable by One-to-All
442
- */
443
- all?: Array<ReachablePlace>;
390
+ /**
391
+ * One location used in One-to-All search
392
+ */
393
+ one?: Place;
394
+ /**
395
+ * List of locations reachable by One-to-All
396
+ */
397
+ all?: Array<ReachablePlace>;
444
398
  };
445
399
  /**
446
400
  * departure or arrival event at a stop
447
401
  */
448
402
  type StopTime = {
449
- /**
450
- * information about the stop place and time
451
- */
452
- place: Place;
453
- /**
454
- * Transport mode for this leg
455
- */
456
- mode: Mode;
457
- /**
458
- * Whether there is real-time data about this leg
459
- */
460
- realTime: boolean;
461
- /**
462
- * For transit legs, the headsign of the bus or train being used.
463
- * For non-transit legs, null
464
- *
465
- */
466
- headsign: string;
467
- agencyId: string;
468
- agencyName: string;
469
- agencyUrl: string;
470
- routeColor?: string;
471
- routeTextColor?: string;
472
- tripId: string;
473
- routeShortName: string;
474
- /**
475
- * Type of pickup (for departures) or dropoff (for arrivals), may be disallowed either due to schedule, skipped stops or cancellations
476
- */
477
- pickupDropoffType: PickupDropoffType;
478
- /**
479
- * Whether the departure/arrival is cancelled due to the realtime situation (either because the stop is skipped or because the entire trip is cancelled).
480
- */
481
- cancelled: boolean;
482
- /**
483
- * Whether the entire trip is cancelled due to the realtime situation.
484
- */
485
- tripCancelled: boolean;
486
- /**
487
- * Filename and line number where this trip is from
488
- */
489
- source: string;
403
+ /**
404
+ * information about the stop place and time
405
+ */
406
+ place: Place;
407
+ /**
408
+ * Transport mode for this leg
409
+ */
410
+ mode: Mode;
411
+ /**
412
+ * Whether there is real-time data about this leg
413
+ */
414
+ realTime: boolean;
415
+ /**
416
+ * For transit legs, the headsign of the bus or train being used.
417
+ * For non-transit legs, null
418
+ *
419
+ */
420
+ headsign: string;
421
+ agencyId: string;
422
+ agencyName: string;
423
+ agencyUrl: string;
424
+ routeColor?: string;
425
+ routeTextColor?: string;
426
+ tripId: string;
427
+ routeShortName: string;
428
+ /**
429
+ * Type of pickup (for departures) or dropoff (for arrivals), may be disallowed either due to schedule, skipped stops or cancellations
430
+ */
431
+ pickupDropoffType: PickupDropoffType;
432
+ /**
433
+ * Whether the departure/arrival is cancelled due to the realtime situation (either because the stop is skipped or because the entire trip is cancelled).
434
+ */
435
+ cancelled: boolean;
436
+ /**
437
+ * Whether the entire trip is cancelled due to the realtime situation.
438
+ */
439
+ tripCancelled: boolean;
440
+ /**
441
+ * Filename and line number where this trip is from
442
+ */
443
+ source: string;
490
444
  };
491
445
  /**
492
446
  * trip id and name
493
447
  */
494
448
  type TripInfo = {
495
- /**
496
- * trip ID (dataset trip id prefixed with the dataset tag)
497
- */
498
- tripId: string;
499
- /**
500
- * trip display name
501
- */
502
- routeShortName: string;
449
+ /**
450
+ * trip ID (dataset trip id prefixed with the dataset tag)
451
+ */
452
+ tripId: string;
453
+ /**
454
+ * trip display name
455
+ */
456
+ routeShortName: string;
503
457
  };
504
458
  /**
505
459
  * trip segment between two stops to show a trip on a map
506
460
  */
507
461
  type TripSegment = {
508
- trips: Array<TripInfo>;
509
- routeColor?: string;
510
- /**
511
- * Transport mode for this leg
512
- */
513
- mode: Mode;
514
- /**
515
- * distance in meters
516
- */
517
- distance: number;
518
- from: Place;
519
- to: Place;
520
- /**
521
- * departure time
522
- */
523
- departure: string;
524
- /**
525
- * arrival time
526
- */
527
- arrival: string;
528
- /**
529
- * scheduled departure time
530
- */
531
- scheduledDeparture: string;
532
- /**
533
- * scheduled arrival time
534
- */
535
- scheduledArrival: string;
536
- /**
537
- * Whether there is real-time data about this leg
538
- */
539
- realTime: boolean;
540
- /**
541
- * Google polyline encoded coordinate sequence (with precision 5) where the trip travels on this segment.
542
- */
543
- polyline: string;
462
+ trips: Array<TripInfo>;
463
+ routeColor?: string;
464
+ /**
465
+ * Transport mode for this leg
466
+ */
467
+ mode: Mode;
468
+ /**
469
+ * distance in meters
470
+ */
471
+ distance: number;
472
+ from: Place;
473
+ to: Place;
474
+ /**
475
+ * departure time
476
+ */
477
+ departure: string;
478
+ /**
479
+ * arrival time
480
+ */
481
+ arrival: string;
482
+ /**
483
+ * scheduled departure time
484
+ */
485
+ scheduledDeparture: string;
486
+ /**
487
+ * scheduled arrival time
488
+ */
489
+ scheduledArrival: string;
490
+ /**
491
+ * Whether there is real-time data about this leg
492
+ */
493
+ realTime: boolean;
494
+ /**
495
+ * Google polyline encoded coordinate sequence (with precision 5) where the trip travels on this segment.
496
+ */
497
+ polyline: string;
544
498
  };
545
- type Direction =
546
- | 'DEPART'
547
- | 'HARD_LEFT'
548
- | 'LEFT'
549
- | 'SLIGHTLY_LEFT'
550
- | 'CONTINUE'
551
- | 'SLIGHTLY_RIGHT'
552
- | 'RIGHT'
553
- | 'HARD_RIGHT'
554
- | 'CIRCLE_CLOCKWISE'
555
- | 'CIRCLE_COUNTERCLOCKWISE'
556
- | 'STAIRS'
557
- | 'ELEVATOR'
558
- | 'UTURN_LEFT'
559
- | 'UTURN_RIGHT';
499
+ type Direction = 'DEPART' | 'HARD_LEFT' | 'LEFT' | 'SLIGHTLY_LEFT' | 'CONTINUE' | 'SLIGHTLY_RIGHT' | 'RIGHT' | 'HARD_RIGHT' | 'CIRCLE_CLOCKWISE' | 'CIRCLE_COUNTERCLOCKWISE' | 'STAIRS' | 'ELEVATOR' | 'UTURN_LEFT' | 'UTURN_RIGHT';
560
500
  type EncodedPolyline = {
561
- /**
562
- * The encoded points of the polyline using the Google polyline encoding.
563
- */
564
- points: string;
565
- /**
566
- * The precision of the returned polyline (7 for /v1, 6 for /v2)
567
- * Be aware that with precision 7, coordinates with |longitude| > 107.37 are undefined/will overflow.
568
- *
569
- */
570
- precision: number;
571
- /**
572
- * The number of points in the string
573
- */
574
- length: number;
501
+ /**
502
+ * The encoded points of the polyline using the Google polyline encoding.
503
+ */
504
+ points: string;
505
+ /**
506
+ * The precision of the returned polyline (7 for /v1, 6 for /v2)
507
+ * Be aware that with precision 7, coordinates with |longitude| > 107.37 are undefined/will overflow.
508
+ *
509
+ */
510
+ precision: number;
511
+ /**
512
+ * The number of points in the string
513
+ */
514
+ length: number;
575
515
  };
576
516
  type StepInstruction = {
577
- relativeDirection: Direction;
578
- /**
579
- * The distance in meters that this step takes.
580
- */
581
- distance: number;
582
- /**
583
- * level where this segment starts, based on OpenStreetMap data
584
- */
585
- fromLevel: number;
586
- /**
587
- * level where this segment starts, based on OpenStreetMap data
588
- */
589
- toLevel: number;
590
- /**
591
- * OpenStreetMap way index
592
- */
593
- osmWay?: number;
594
- polyline: EncodedPolyline;
595
- /**
596
- * The name of the street.
597
- */
598
- streetName: string;
599
- /**
600
- * Not implemented!
601
- * When exiting a highway or traffic circle, the exit name/number.
602
- *
603
- */
604
- exit: string;
605
- /**
606
- * Not implemented!
607
- * Indicates whether or not a street changes direction at an intersection.
608
- *
609
- */
610
- stayOn: boolean;
611
- /**
612
- * Not implemented!
613
- * This step is on an open area, such as a plaza or train platform,
614
- * and thus the directions should say something like "cross"
615
- *
616
- */
617
- area: boolean;
618
- /**
619
- * Indicates that a fee must be paid by general traffic to use a road, road bridge or road tunnel.
620
- */
621
- toll?: boolean;
622
- /**
623
- * Experimental. Indicates whether access to this part of the route is restricted.
624
- * See: https://wiki.openstreetmap.org/wiki/Conditional_restrictions
625
- *
626
- */
627
- accessRestriction?: string;
628
- /**
629
- * incline in meters across this path segment
630
- */
631
- elevationUp?: number;
632
- /**
633
- * decline in meters across this path segment
634
- */
635
- elevationDown?: number;
517
+ relativeDirection: Direction;
518
+ /**
519
+ * The distance in meters that this step takes.
520
+ */
521
+ distance: number;
522
+ /**
523
+ * level where this segment starts, based on OpenStreetMap data
524
+ */
525
+ fromLevel: number;
526
+ /**
527
+ * level where this segment starts, based on OpenStreetMap data
528
+ */
529
+ toLevel: number;
530
+ /**
531
+ * OpenStreetMap way index
532
+ */
533
+ osmWay?: number;
534
+ polyline: EncodedPolyline;
535
+ /**
536
+ * The name of the street.
537
+ */
538
+ streetName: string;
539
+ /**
540
+ * Not implemented!
541
+ * When exiting a highway or traffic circle, the exit name/number.
542
+ *
543
+ */
544
+ exit: string;
545
+ /**
546
+ * Not implemented!
547
+ * Indicates whether or not a street changes direction at an intersection.
548
+ *
549
+ */
550
+ stayOn: boolean;
551
+ /**
552
+ * Not implemented!
553
+ * This step is on an open area, such as a plaza or train platform,
554
+ * and thus the directions should say something like "cross"
555
+ *
556
+ */
557
+ area: boolean;
558
+ /**
559
+ * Indicates that a fee must be paid by general traffic to use a road, road bridge or road tunnel.
560
+ */
561
+ toll?: boolean;
562
+ /**
563
+ * Experimental. Indicates whether access to this part of the route is restricted.
564
+ * See: https://wiki.openstreetmap.org/wiki/Conditional_restrictions
565
+ *
566
+ */
567
+ accessRestriction?: string;
568
+ /**
569
+ * incline in meters across this path segment
570
+ */
571
+ elevationUp?: number;
572
+ /**
573
+ * decline in meters across this path segment
574
+ */
575
+ elevationDown?: number;
636
576
  };
637
- type RentalFormFactor =
638
- | 'BICYCLE'
639
- | 'CARGO_BICYCLE'
640
- | 'CAR'
641
- | 'MOPED'
642
- | 'SCOOTER_STANDING'
643
- | 'SCOOTER_SEATED'
644
- | 'OTHER';
645
- type RentalPropulsionType =
646
- | 'HUMAN'
647
- | 'ELECTRIC_ASSIST'
648
- | 'ELECTRIC'
649
- | 'COMBUSTION'
650
- | 'COMBUSTION_DIESEL'
651
- | 'HYBRID'
652
- | 'PLUG_IN_HYBRID'
653
- | 'HYDROGEN_FUEL_CELL';
577
+ type RentalFormFactor = 'BICYCLE' | 'CARGO_BICYCLE' | 'CAR' | 'MOPED' | 'SCOOTER_STANDING' | 'SCOOTER_SEATED' | 'OTHER';
578
+ type RentalPropulsionType = 'HUMAN' | 'ELECTRIC_ASSIST' | 'ELECTRIC' | 'COMBUSTION' | 'COMBUSTION_DIESEL' | 'HYBRID' | 'PLUG_IN_HYBRID' | 'HYDROGEN_FUEL_CELL';
654
579
  type RentalReturnConstraint = 'NONE' | 'ANY_STATION' | 'ROUNDTRIP_STATION';
655
580
  /**
656
581
  * Vehicle rental
657
582
  */
658
583
  type Rental = {
659
- /**
660
- * Vehicle share system ID
661
- */
662
- systemId: string;
663
- /**
664
- * Vehicle share system name
665
- */
666
- systemName?: string;
667
- /**
668
- * URL of the vehicle share system
669
- */
670
- url?: string;
671
- /**
672
- * Name of the station
673
- */
674
- stationName?: string;
675
- /**
676
- * Name of the station where the vehicle is picked up (empty for free floating vehicles)
677
- */
678
- fromStationName?: string;
679
- /**
680
- * Name of the station where the vehicle is returned (empty for free floating vehicles)
681
- */
682
- toStationName?: string;
683
- /**
684
- * Rental URI for Android (deep link to the specific station or vehicle)
685
- */
686
- rentalUriAndroid?: string;
687
- /**
688
- * Rental URI for iOS (deep link to the specific station or vehicle)
689
- */
690
- rentalUriIOS?: string;
691
- /**
692
- * Rental URI for web (deep link to the specific station or vehicle)
693
- */
694
- rentalUriWeb?: string;
695
- formFactor?: RentalFormFactor;
696
- propulsionType?: RentalPropulsionType;
697
- returnConstraint?: RentalReturnConstraint;
584
+ /**
585
+ * Vehicle share system ID
586
+ */
587
+ systemId: string;
588
+ /**
589
+ * Vehicle share system name
590
+ */
591
+ systemName?: string;
592
+ /**
593
+ * URL of the vehicle share system
594
+ */
595
+ url?: string;
596
+ /**
597
+ * Name of the station
598
+ */
599
+ stationName?: string;
600
+ /**
601
+ * Name of the station where the vehicle is picked up (empty for free floating vehicles)
602
+ */
603
+ fromStationName?: string;
604
+ /**
605
+ * Name of the station where the vehicle is returned (empty for free floating vehicles)
606
+ */
607
+ toStationName?: string;
608
+ /**
609
+ * Rental URI for Android (deep link to the specific station or vehicle)
610
+ */
611
+ rentalUriAndroid?: string;
612
+ /**
613
+ * Rental URI for iOS (deep link to the specific station or vehicle)
614
+ */
615
+ rentalUriIOS?: string;
616
+ /**
617
+ * Rental URI for web (deep link to the specific station or vehicle)
618
+ */
619
+ rentalUriWeb?: string;
620
+ formFactor?: RentalFormFactor;
621
+ propulsionType?: RentalPropulsionType;
622
+ returnConstraint?: RentalReturnConstraint;
698
623
  };
699
624
  type Leg = {
700
- /**
701
- * Transport mode for this leg
702
- */
703
- mode: Mode;
704
- from: Place;
705
- to: Place;
706
- /**
707
- * Leg duration in seconds
708
- *
709
- * If leg is footpath:
710
- * The footpath duration is derived from the default footpath
711
- * duration using the query parameters `transferTimeFactor` and
712
- * `additionalTransferTime` as follows:
713
- * `leg.duration = defaultDuration * transferTimeFactor + additionalTransferTime.`
714
- * In case the defaultDuration is needed, it can be calculated by
715
- * `defaultDuration = (leg.duration - additionalTransferTime) / transferTimeFactor`.
716
- * Note that the default values are `transferTimeFactor = 1` and
717
- * `additionalTransferTime = 0` in case they are not explicitly
718
- * provided in the query.
719
- *
720
- */
721
- duration: number;
722
- /**
723
- * leg departure time
724
- */
725
- startTime: string;
726
- /**
727
- * leg arrival time
728
- */
729
- endTime: string;
730
- /**
731
- * scheduled leg departure time
732
- */
733
- scheduledStartTime: string;
734
- /**
735
- * scheduled leg arrival time
736
- */
737
- scheduledEndTime: string;
738
- /**
739
- * Whether there is real-time data about this leg
740
- */
741
- realTime: boolean;
742
- /**
743
- * Whether this leg was originally scheduled to run or is an additional service.
744
- * Scheduled times will equal realtime times in this case.
745
- *
746
- */
747
- scheduled: boolean;
748
- /**
749
- * For non-transit legs the distance traveled while traversing this leg in meters.
750
- */
751
- distance?: number;
752
- /**
753
- * For transit legs, if the rider should stay on the vehicle as it changes route names.
754
- */
755
- interlineWithPreviousLeg?: boolean;
756
- /**
757
- * For transit legs, the headsign of the bus or train being used.
758
- * For non-transit legs, null
759
- *
760
- */
761
- headsign?: string;
762
- routeColor?: string;
763
- routeTextColor?: string;
764
- routeType?: string;
765
- agencyName?: string;
766
- agencyUrl?: string;
767
- agencyId?: string;
768
- tripId?: string;
769
- routeShortName?: string;
770
- /**
771
- * Whether this trip is cancelled
772
- */
773
- cancelled?: boolean;
774
- /**
775
- * Filename and line number where this trip is from
776
- */
777
- source?: string;
778
- /**
779
- * For transit legs, intermediate stops between the Place where the leg originates
780
- * and the Place where the leg ends. For non-transit legs, null.
781
- *
782
- */
783
- intermediateStops?: Array<Place>;
784
- legGeometry: EncodedPolyline;
785
- /**
786
- * A series of turn by turn instructions
787
- * used for walking, biking and driving.
788
- *
789
- */
790
- steps?: Array<StepInstruction>;
791
- rental?: Rental;
792
- /**
793
- * Index into `Itinerary.fareTransfers` array
794
- * to identify which fare transfer this leg belongs to
795
- *
796
- */
797
- fareTransferIndex?: number;
798
- /**
799
- * Index into the `Itinerary.fareTransfers[fareTransferIndex].effectiveFareLegProducts` array
800
- * to identify which effective fare leg this itinerary leg belongs to
801
- *
802
- */
803
- effectiveFareLegIndex?: number;
804
- /**
805
- * Alerts for this stop.
806
- */
807
- alerts?: Array<Alert>;
625
+ /**
626
+ * Transport mode for this leg
627
+ */
628
+ mode: Mode;
629
+ from: Place;
630
+ to: Place;
631
+ /**
632
+ * Leg duration in seconds
633
+ *
634
+ * If leg is footpath:
635
+ * The footpath duration is derived from the default footpath
636
+ * duration using the query parameters `transferTimeFactor` and
637
+ * `additionalTransferTime` as follows:
638
+ * `leg.duration = defaultDuration * transferTimeFactor + additionalTransferTime.`
639
+ * In case the defaultDuration is needed, it can be calculated by
640
+ * `defaultDuration = (leg.duration - additionalTransferTime) / transferTimeFactor`.
641
+ * Note that the default values are `transferTimeFactor = 1` and
642
+ * `additionalTransferTime = 0` in case they are not explicitly
643
+ * provided in the query.
644
+ *
645
+ */
646
+ duration: number;
647
+ /**
648
+ * leg departure time
649
+ */
650
+ startTime: string;
651
+ /**
652
+ * leg arrival time
653
+ */
654
+ endTime: string;
655
+ /**
656
+ * scheduled leg departure time
657
+ */
658
+ scheduledStartTime: string;
659
+ /**
660
+ * scheduled leg arrival time
661
+ */
662
+ scheduledEndTime: string;
663
+ /**
664
+ * Whether there is real-time data about this leg
665
+ */
666
+ realTime: boolean;
667
+ /**
668
+ * Whether this leg was originally scheduled to run or is an additional service.
669
+ * Scheduled times will equal realtime times in this case.
670
+ *
671
+ */
672
+ scheduled: boolean;
673
+ /**
674
+ * For non-transit legs the distance traveled while traversing this leg in meters.
675
+ */
676
+ distance?: number;
677
+ /**
678
+ * For transit legs, if the rider should stay on the vehicle as it changes route names.
679
+ */
680
+ interlineWithPreviousLeg?: boolean;
681
+ /**
682
+ * For transit legs, the headsign of the bus or train being used.
683
+ * For non-transit legs, null
684
+ *
685
+ */
686
+ headsign?: string;
687
+ routeColor?: string;
688
+ routeTextColor?: string;
689
+ routeType?: string;
690
+ agencyName?: string;
691
+ agencyUrl?: string;
692
+ agencyId?: string;
693
+ tripId?: string;
694
+ routeShortName?: string;
695
+ /**
696
+ * Whether this trip is cancelled
697
+ */
698
+ cancelled?: boolean;
699
+ /**
700
+ * Filename and line number where this trip is from
701
+ */
702
+ source?: string;
703
+ /**
704
+ * For transit legs, intermediate stops between the Place where the leg originates
705
+ * and the Place where the leg ends. For non-transit legs, null.
706
+ *
707
+ */
708
+ intermediateStops?: Array<Place>;
709
+ legGeometry: EncodedPolyline;
710
+ /**
711
+ * A series of turn by turn instructions
712
+ * used for walking, biking and driving.
713
+ *
714
+ */
715
+ steps?: Array<StepInstruction>;
716
+ rental?: Rental;
717
+ /**
718
+ * Index into `Itinerary.fareTransfers` array
719
+ * to identify which fare transfer this leg belongs to
720
+ *
721
+ */
722
+ fareTransferIndex?: number;
723
+ /**
724
+ * Index into the `Itinerary.fareTransfers[fareTransferIndex].effectiveFareLegProducts` array
725
+ * to identify which effective fare leg this itinerary leg belongs to
726
+ *
727
+ */
728
+ effectiveFareLegIndex?: number;
729
+ /**
730
+ * Alerts for this stop.
731
+ */
732
+ alerts?: Array<Alert>;
808
733
  };
809
734
  type RiderCategory = {
810
- /**
811
- * Rider category name as displayed to the rider.
812
- */
813
- riderCategoryName: string;
814
- /**
815
- * Specifies if this category should be considered the default (i.e. the main category displayed to riders).
816
- */
817
- isDefaultFareCategory: boolean;
818
- /**
819
- * URL to a web page providing detailed information about the rider category and/or its eligibility criteria.
820
- */
821
- eligibilityUrl?: string;
735
+ /**
736
+ * Rider category name as displayed to the rider.
737
+ */
738
+ riderCategoryName: string;
739
+ /**
740
+ * Specifies if this category should be considered the default (i.e. the main category displayed to riders).
741
+ */
742
+ isDefaultFareCategory: boolean;
743
+ /**
744
+ * URL to a web page providing detailed information about the rider category and/or its eligibility criteria.
745
+ */
746
+ eligibilityUrl?: string;
822
747
  };
823
748
  type FareMediaType = 'NONE' | 'PAPER_TICKET' | 'TRANSIT_CARD' | 'CONTACTLESS_EMV' | 'MOBILE_APP';
824
749
  type FareMedia = {
825
- /**
826
- * Name of the fare media. Required for transit cards and mobile apps.
827
- */
828
- fareMediaName?: string;
829
- /**
830
- * The type of fare media.
831
- */
832
- fareMediaType: FareMediaType;
750
+ /**
751
+ * Name of the fare media. Required for transit cards and mobile apps.
752
+ */
753
+ fareMediaName?: string;
754
+ /**
755
+ * The type of fare media.
756
+ */
757
+ fareMediaType: FareMediaType;
833
758
  };
834
759
  type FareProduct = {
835
- /**
836
- * The name of the fare product as displayed to riders.
837
- */
838
- name: string;
839
- /**
840
- * The cost of the fare product. May be negative to represent transfer discounts. May be zero to represent a fare product that is free.
841
- */
842
- amount: number;
843
- /**
844
- * ISO 4217 currency code. The currency of the cost of the fare product.
845
- */
846
- currency: string;
847
- riderCategory?: RiderCategory;
848
- media?: FareMedia;
760
+ /**
761
+ * The name of the fare product as displayed to riders.
762
+ */
763
+ name: string;
764
+ /**
765
+ * The cost of the fare product. May be negative to represent transfer discounts. May be zero to represent a fare product that is free.
766
+ */
767
+ amount: number;
768
+ /**
769
+ * ISO 4217 currency code. The currency of the cost of the fare product.
770
+ */
771
+ currency: string;
772
+ riderCategory?: RiderCategory;
773
+ media?: FareMedia;
849
774
  };
850
775
  type FareTransferRule = 'A_AB' | 'A_AB_B' | 'AB';
851
776
  /**
@@ -868,1135 +793,1072 @@ type FareTransferRule = 'A_AB' | 'A_AB_B' | 'AB';
868
793
  *
869
794
  */
870
795
  type FareTransfer = {
871
- rule?: FareTransferRule;
872
- transferProducts?: Array<FareProduct>;
873
- /**
874
- * Lists all valid fare products for the effective fare legs.
875
- * This is an `array<array<FareProduct>>` where the inner array
876
- * lists all possible fare products that would cover this effective fare leg.
877
- * Each "effective fare leg" can have multiple options for adult/child/weekly/monthly/day/one-way tickets etc.
878
- * You 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`)
879
- * and the inner array as OR (you can choose which ticket to buy)
880
- *
881
- */
882
- effectiveFareLegProducts: Array<Array<Array<FareProduct>>>;
796
+ rule?: FareTransferRule;
797
+ transferProducts?: Array<FareProduct>;
798
+ /**
799
+ * Lists all valid fare products for the effective fare legs.
800
+ * This is an `array<array<FareProduct>>` where the inner array
801
+ * lists all possible fare products that would cover this effective fare leg.
802
+ * Each "effective fare leg" can have multiple options for adult/child/weekly/monthly/day/one-way tickets etc.
803
+ * You 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`)
804
+ * and the inner array as OR (you can choose which ticket to buy)
805
+ *
806
+ */
807
+ effectiveFareLegProducts: Array<Array<Array<FareProduct>>>;
883
808
  };
884
809
  type Itinerary = {
885
- /**
886
- * journey duration in seconds
887
- */
888
- duration: number;
889
- /**
890
- * journey departure time
891
- */
892
- startTime: string;
893
- /**
894
- * journey arrival time
895
- */
896
- endTime: string;
897
- /**
898
- * The number of transfers this trip has.
899
- */
900
- transfers: number;
901
- /**
902
- * Journey legs
903
- */
904
- legs: Array<Leg>;
905
- /**
906
- * Fare information
907
- */
908
- fareTransfers?: Array<FareTransfer>;
810
+ /**
811
+ * journey duration in seconds
812
+ */
813
+ duration: number;
814
+ /**
815
+ * journey departure time
816
+ */
817
+ startTime: string;
818
+ /**
819
+ * journey arrival time
820
+ */
821
+ endTime: string;
822
+ /**
823
+ * The number of transfers this trip has.
824
+ */
825
+ transfers: number;
826
+ /**
827
+ * Journey legs
828
+ */
829
+ legs: Array<Leg>;
830
+ /**
831
+ * Fare information
832
+ */
833
+ fareTransfers?: Array<FareTransfer>;
909
834
  };
910
835
  /**
911
836
  * transfer from one location to another
912
837
  */
913
838
  type Transfer = {
914
- to: Place;
915
- /**
916
- * optional; missing if the GTFS did not contain a transfer
917
- * transfer duration in minutes according to GTFS (+heuristics)
918
- *
919
- */
920
- default?: number;
921
- /**
922
- * optional; missing if no path was found (timetable / osr)
923
- * transfer duration in minutes for the foot profile
924
- *
925
- */
926
- foot?: number;
927
- /**
928
- * optional; missing if no path was found with foot routing
929
- * transfer duration in minutes for the foot profile
930
- *
931
- */
932
- footRouted?: number;
933
- /**
934
- * optional; missing if no path was found with the wheelchair profile
935
- * transfer duration in minutes for the wheelchair profile
936
- *
937
- */
938
- wheelchair?: number;
939
- /**
940
- * optional; missing if no path was found with the wheelchair profile
941
- * transfer duration in minutes for the wheelchair profile
942
- *
943
- */
944
- wheelchairRouted?: number;
945
- /**
946
- * optional; missing if no path was found with the wheelchair profile
947
- * true if the wheelchair path uses an elevator
948
- *
949
- */
950
- wheelchairUsesElevator?: boolean;
951
- /**
952
- * optional; missing if no path was found with car routing
953
- * transfer duration in minutes for the car profile
954
- *
955
- */
956
- car?: number;
839
+ to: Place;
840
+ /**
841
+ * optional; missing if the GTFS did not contain a transfer
842
+ * transfer duration in minutes according to GTFS (+heuristics)
843
+ *
844
+ */
845
+ default?: number;
846
+ /**
847
+ * optional; missing if no path was found (timetable / osr)
848
+ * transfer duration in minutes for the foot profile
849
+ *
850
+ */
851
+ foot?: number;
852
+ /**
853
+ * optional; missing if no path was found with foot routing
854
+ * transfer duration in minutes for the foot profile
855
+ *
856
+ */
857
+ footRouted?: number;
858
+ /**
859
+ * optional; missing if no path was found with the wheelchair profile
860
+ * transfer duration in minutes for the wheelchair profile
861
+ *
862
+ */
863
+ wheelchair?: number;
864
+ /**
865
+ * optional; missing if no path was found with the wheelchair profile
866
+ * transfer duration in minutes for the wheelchair profile
867
+ *
868
+ */
869
+ wheelchairRouted?: number;
870
+ /**
871
+ * optional; missing if no path was found with the wheelchair profile
872
+ * true if the wheelchair path uses an elevator
873
+ *
874
+ */
875
+ wheelchairUsesElevator?: boolean;
876
+ /**
877
+ * optional; missing if no path was found with car routing
878
+ * transfer duration in minutes for the car profile
879
+ *
880
+ */
881
+ car?: number;
957
882
  };
958
883
  type PlanData = {
959
- query: {
960
- /**
961
- * Optional. Default is 0 minutes.
962
- *
963
- * Additional transfer time reserved for each transfer in minutes.
964
- *
965
- */
966
- additionalTransferTime?: number;
967
- /**
968
- * Optional. Default is `false`.
969
- *
970
- * - `arriveBy=true`: the parameters `date` and `time` refer to the arrival time
971
- * - `arriveBy=false`: the parameters `date` and `time` refer to the departure time
972
- *
973
- */
974
- arriveBy?: boolean;
975
- /**
976
- * - true: Compute transfer polylines and step instructions.
977
- * - false: Only return basic information (start time, end time, duration) for transfers.
978
- *
979
- */
980
- detailedTransfers: boolean;
981
- /**
982
- * Optional. Default is `WALK` which will compute walking routes as direct connections.
983
- *
984
- * Modes used for direction connections from start to destination without using transit.
985
- * Results will be returned on the `direct` key.
986
- *
987
- * Note: Direct connections will only be returned on the first call. For paging calls, they can be omitted.
988
- *
989
- * Note: Transit connections that are slower than the fastest direct connection will not show up.
990
- * This is being used as a cut-off during transit routing to speed up the search.
991
- * To prevent this, it's possible to send two separate requests (one with only `transitModes` and one with only `directModes`).
992
- *
993
- * Note: the output `direct` array will stay empty if the input param `maxDirectTime` makes any direct trip impossible.
994
- *
995
- * Only non-transit modes such as `WALK`, `BIKE`, `CAR`, `BIKE_SHARING`, etc. can be used.
996
- *
997
- */
998
- directModes?: Array<Mode>;
999
- /**
1000
- * Experimental. Expect unannounced breaking changes (without version bumps).
1001
- *
1002
- * Optional. Only applies to direct connections.
1003
- *
1004
- * A list of vehicle type form factors that are allowed to be used for direct connections.
1005
- * If empty (the default), all form factors are allowed.
1006
- * Example: `BICYCLE,SCOOTER_STANDING`.
1007
- *
1008
- */
1009
- directRentalFormFactors?: Array<RentalFormFactor>;
1010
- /**
1011
- * Experimental. Expect unannounced breaking changes (without version bumps).
1012
- *
1013
- * Optional. Only applies to direct connections.
1014
- *
1015
- * A list of vehicle type form factors that are allowed to be used for direct connections.
1016
- * If empty (the default), all propulsion types are allowed.
1017
- * Example: `HUMAN,ELECTRIC,ELECTRIC_ASSIST`.
1018
- *
1019
- */
1020
- directRentalPropulsionTypes?: Array<RentalPropulsionType>;
1021
- /**
1022
- * Experimental. Expect unannounced breaking changes (without version bumps).
1023
- *
1024
- * Optional. Only applies to direct connections.
1025
- *
1026
- * A list of rental providers that are allowed to be used for direct connections.
1027
- * If empty (the default), all providers are allowed.
1028
- *
1029
- */
1030
- directRentalProviders?: Array<string>;
1031
- /**
1032
- * Optional. Default is `NONE`.
1033
- *
1034
- * Set an elevation cost profile, to penalize routes with incline.
1035
- * - `NONE`: No additional costs for elevations. This is the default behavior
1036
- * - `LOW`: Add a low cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if small detours are required.
1037
- * - `HIGH`: Add a high cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if larger detours are required.
1038
- *
1039
- * As using an elevation costs profile will increase the travel duration,
1040
- * routing through steep terrain may exceed the maximal allowed duration,
1041
- * causing a location to appear unreachable.
1042
- * Increasing the maximum travel time for these segments may resolve this issue.
1043
- *
1044
- * The profile is used for direct routing, on the first mile, and last mile.
1045
- *
1046
- * Elevation cost profiles are currently used by following street modes:
1047
- * - `BIKE`
1048
- *
1049
- */
1050
- elevationCosts?: ElevationCosts;
1051
- /**
1052
- * Optional. Experimental. Default is `1.0`.
1053
- * Factor with which the duration of the fastest direct connection is multiplied.
1054
- * Values > 1.0 allow connections that are slower than the fastest direct connection to be found.
1055
- *
1056
- */
1057
- fastestDirectFactor?: number;
1058
- /**
1059
- * \`latitude,longitude[,level]\` tuple with
1060
- * - latitude and longitude in degrees
1061
- * - (optional) level: the OSM level (default: 0)
1062
- *
1063
- * OR
1064
- *
1065
- * stop id
1066
- *
1067
- */
1068
- fromPlace: string;
1069
- /**
1070
- * Experimental. Expect unannounced breaking changes (without version bumps).
1071
- *
1072
- * Optional. Default is `false`.
1073
- *
1074
- * If set to `true`, the routing will ignore rental return constraints for direct connections,
1075
- * allowing the rental vehicle to be parked anywhere.
1076
- *
1077
- */
1078
- ignoreDirectRentalReturnConstraints?: boolean;
1079
- /**
1080
- * Experimental. Expect unannounced breaking changes (without version bumps).
1081
- *
1082
- * Optional. Default is `false`.
1083
- *
1084
- * If set to `true`, the routing will ignore rental return constraints for the part from the last transit stop to the `to` coordinate,
1085
- * allowing the rental vehicle to be parked anywhere.
1086
- *
1087
- */
1088
- ignorePostTransitRentalReturnConstraints?: boolean;
1089
- /**
1090
- * Experimental. Expect unannounced breaking changes (without version bumps).
1091
- *
1092
- * Optional. Default is `false`.
1093
- *
1094
- * If set to `true`, the routing will ignore rental return constraints for the part from the `from` coordinate to the first transit stop,
1095
- * allowing the rental vehicle to be parked anywhere.
1096
- *
1097
- */
1098
- ignorePreTransitRentalReturnConstraints?: boolean;
1099
- /**
1100
- * Optional. Default is `true`.
1101
- *
1102
- * Controls if a journey section with stay-seated transfers is returned:
1103
- * - `joinInterlinedLegs=false`: as several legs (full information about all trip numbers, headsigns, etc.).
1104
- * Legs that do not require a transfer (stay-seated transfer) are marked with `interlineWithPreviousLeg=true`.
1105
- * - `joinInterlinedLegs=true` (default behavior): as only one joined leg containing all stops
1106
- *
1107
- */
1108
- joinInterlinedLegs?: boolean;
1109
- /**
1110
- * Optional. Experimental. Number of luggage pieces; base unit: airline cabin luggage (e.g. for ODM or price calculation)
1111
- *
1112
- */
1113
- luggage?: number;
1114
- /**
1115
- * Optional. Default is 30min which is `1800`.
1116
- * Maximum time in seconds for direct connections.
1117
- *
1118
- */
1119
- maxDirectTime?: number;
1120
- /**
1121
- * Optional. Default is 25 meters.
1122
- *
1123
- * Maximum matching distance in meters to match geo coordinates to the street network.
1124
- *
1125
- */
1126
- maxMatchingDistance?: number;
1127
- /**
1128
- * Optional. Default is 15min which is `900`.
1129
- * Maximum time in seconds for the last street leg.
1130
- *
1131
- */
1132
- maxPostTransitTime?: number;
1133
- /**
1134
- * Optional. Default is 15min which is `900`.
1135
- * Maximum time in seconds for the first street leg.
1136
- *
1137
- */
1138
- maxPreTransitTime?: number;
1139
- /**
1140
- * The maximum number of allowed transfers (i.e. interchanges between transit legs,
1141
- * pre- and postTransit do not count as transfers).
1142
- * `maxTransfers=0` searches for direct transit connections without any transfers.
1143
- * If you want to search only for non-transit connections (`FOOT`, `CAR`, etc.),
1144
- * send an empty `transitModes` parameter instead.
1145
- *
1146
- * If not provided, the routing uses the server-side default value
1147
- * which is hardcoded and very high to cover all use cases.
1148
- *
1149
- * *Warning*: Use with care. Setting this too low can lead to
1150
- * optimal (e.g. the fastest) journeys not being found.
1151
- * If this value is too low to reach the destination at all,
1152
- * it can lead to slow routing performance.
1153
- *
1154
- * In plan endpoints before v3, the behavior is off by one,
1155
- * i.e. `maxTransfers=0` only returns non-transit connections.
1156
- *
1157
- */
1158
- maxTransfers?: number;
1159
- /**
1160
- * The maximum travel time in minutes.
1161
- * If not provided, the routing to uses the value
1162
- * hardcoded in the server which is usually quite high.
1163
- *
1164
- * *Warning*: Use with care. Setting this too low can lead to
1165
- * optimal (e.g. the least transfers) journeys not being found.
1166
- * If this value is too low to reach the destination at all,
1167
- * it can lead to slow routing performance.
1168
- *
1169
- */
1170
- maxTravelTime?: number;
1171
- /**
1172
- * Optional. Default is 0 minutes.
1173
- *
1174
- * Minimum transfer time for each transfer in minutes.
1175
- *
1176
- */
1177
- minTransferTime?: number;
1178
- /**
1179
- * The minimum number of itineraries to compute.
1180
- * This is only relevant if `timetableView=true`.
1181
- * The default value is 5.
1182
- *
1183
- */
1184
- numItineraries?: number;
1185
- /**
1186
- * Use the cursor to go to the next "page" of itineraries.
1187
- * Copy the cursor from the last response and keep the original request as is.
1188
- * This will enable you to search for itineraries in the next or previous time-window.
1189
- *
1190
- */
1191
- pageCursor?: string;
1192
- /**
1193
- * Optional. Experimental. Number of passengers (e.g. for ODM or price calculation)
1194
- */
1195
- passengers?: number;
1196
- /**
1197
- * Optional. Default is `FOOT`.
1198
- *
1199
- * Accessibility profile to use for pedestrian routing in transfers
1200
- * between transit connections, on the first mile, and last mile.
1201
- *
1202
- */
1203
- pedestrianProfile?: PedestrianProfile;
1204
- /**
1205
- * Optional. Default is `WALK`. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directModes`).
1206
- *
1207
- * A list of modes that are allowed to be used from the last transit stop to the `to` coordinate. Example: `WALK,BIKE_SHARING`.
1208
- *
1209
- */
1210
- postTransitModes?: Array<Mode>;
1211
- /**
1212
- * Experimental. Expect unannounced breaking changes (without version bumps).
1213
- *
1214
- * Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalFormFactors`).
1215
- *
1216
- * A list of vehicle type form factors that are allowed to be used from the last transit stop to the `to` coordinate.
1217
- * If empty (the default), all form factors are allowed.
1218
- * Example: `BICYCLE,SCOOTER_STANDING`.
1219
- *
1220
- */
1221
- postTransitRentalFormFactors?: Array<RentalFormFactor>;
1222
- /**
1223
- * Experimental. Expect unannounced breaking changes (without version bumps).
1224
- *
1225
- * Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalPropulsionTypes`).
1226
- *
1227
- * A list of vehicle propulsion types that are allowed to be used from the last transit stop to the `to` coordinate.
1228
- * If empty (the default), all propulsion types are allowed.
1229
- * Example: `HUMAN,ELECTRIC,ELECTRIC_ASSIST`.
1230
- *
1231
- */
1232
- postTransitRentalPropulsionTypes?: Array<RentalPropulsionType>;
1233
- /**
1234
- * Experimental. Expect unannounced breaking changes (without version bumps).
1235
- *
1236
- * Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviders`).
1237
- *
1238
- * A list of rental providers that are allowed to be used from the last transit stop to the `to` coordinate.
1239
- * If empty (the default), all providers are allowed.
1240
- *
1241
- */
1242
- postTransitRentalProviders?: Array<string>;
1243
- /**
1244
- * Optional. Default is `WALK`. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directModes`).
1245
- *
1246
- * A list of modes that are allowed to be used from the `from` coordinate to the first transit stop. Example: `WALK,BIKE_SHARING`.
1247
- *
1248
- */
1249
- preTransitModes?: Array<Mode>;
1250
- /**
1251
- * Experimental. Expect unannounced breaking changes (without version bumps).
1252
- *
1253
- * Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalFormFactors`).
1254
- *
1255
- * A list of vehicle type form factors that are allowed to be used from the `from` coordinate to the first transit stop.
1256
- * If empty (the default), all form factors are allowed.
1257
- * Example: `BICYCLE,SCOOTER_STANDING`.
1258
- *
1259
- */
1260
- preTransitRentalFormFactors?: Array<RentalFormFactor>;
1261
- /**
1262
- * Experimental. Expect unannounced breaking changes (without version bumps).
1263
- *
1264
- * Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalPropulsionTypes`).
1265
- *
1266
- * A list of vehicle propulsion types that are allowed to be used from the `from` coordinate to the first transit stop.
1267
- * If empty (the default), all propulsion types are allowed.
1268
- * Example: `HUMAN,ELECTRIC,ELECTRIC_ASSIST`.
1269
- *
1270
- */
1271
- preTransitRentalPropulsionTypes?: Array<RentalPropulsionType>;
1272
- /**
1273
- * Experimental. Expect unannounced breaking changes (without version bumps).
1274
- *
1275
- * Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviders`).
1276
- *
1277
- * A list of rental providers that are allowed to be used from the `from` coordinate to the first transit stop.
1278
- * If empty (the default), all providers are allowed.
1279
- *
1280
- */
1281
- preTransitRentalProviders?: Array<string>;
1282
- /**
1283
- * Optional. Default is `false`.
1284
- *
1285
- * If set to `true`, all used transit trips are required to allow bike carriage.
1286
- *
1287
- */
1288
- requireBikeTransport?: boolean;
1289
- /**
1290
- * Optional. Default is `false`.
1291
- *
1292
- * If set to `true`, all used transit trips are required to allow car carriage.
1293
- *
1294
- */
1295
- requireCarTransport?: boolean;
1296
- /**
1297
- * Optional. Default is 2 hours which is `7200`.
1298
- *
1299
- * The length of the search-window in seconds. Default value two hours.
1300
- *
1301
- * - `arriveBy=true`: number of seconds between the earliest departure time and latest departure time
1302
- * - `arriveBy=false`: number of seconds between the earliest arrival time and the latest arrival time
1303
- *
1304
- */
1305
- searchWindow?: number;
1306
- /**
1307
- * Optional. Experimental. Adds overtaken direct connections.
1308
- */
1309
- slowDirect?: boolean;
1310
- /**
1311
- * Optional. Defaults to the current time.
1312
- *
1313
- * Departure time ($arriveBy=false) / arrival date ($arriveBy=true),
1314
- *
1315
- */
1316
- time?: string;
1317
- /**
1318
- * Optional. Query timeout in seconds.
1319
- */
1320
- timeout?: number;
1321
- /**
1322
- * Optional. Default is `true`.
1323
- *
1324
- * Search for the best trip options within a time window.
1325
- * If true two itineraries are considered optimal
1326
- * if one is better on arrival time (earliest wins)
1327
- * and the other is better on departure time (latest wins).
1328
- * In combination with arriveBy this parameter cover the following use cases:
1329
- *
1330
- * `timetable=false` = waiting for the first transit departure/arrival is considered travel time:
1331
- * - `arriveBy=true`: event (e.g. a meeting) starts at 10:00 am,
1332
- * compute the best journeys that arrive by that time (maximizes departure time)
1333
- * - `arriveBy=false`: event (e.g. a meeting) ends at 11:00 am,
1334
- * compute the best journeys that depart after that time
1335
- *
1336
- * `timetable=true` = optimize "later departure" + "earlier arrival" and give all options over a time window:
1337
- * - `arriveBy=true`: the time window around `date` and `time` refers to the arrival time window
1338
- * - `arriveBy=false`: the time window around `date` and `time` refers to the departure time window
1339
- *
1340
- */
1341
- timetableView?: boolean;
1342
- /**
1343
- * \`latitude,longitude[,level]\` tuple with
1344
- * - latitude and longitude in degrees
1345
- * - (optional) level: the OSM level (default: 0)
1346
- *
1347
- * OR
1348
- *
1349
- * stop id
1350
- *
1351
- */
1352
- toPlace: string;
1353
- /**
1354
- * Optional. Default is 1.0
1355
- *
1356
- * Factor to multiply minimum required transfer times with.
1357
- * Values smaller than 1.0 are not supported.
1358
- *
1359
- */
1360
- transferTimeFactor?: number;
1361
- /**
1362
- * Optional. Default is `TRANSIT` which allows all transit modes (no restriction).
1363
- * Allowed modes for the transit part. If empty, no transit connections will be computed.
1364
- * For example, this can be used to allow only `METRO,SUBWAY,TRAM`.
1365
- *
1366
- */
1367
- transitModes?: Array<Mode>;
1368
- /**
1369
- * Optional. Default is `false`.
1370
- *
1371
- * Whether to use transfers routed on OpenStreetMap data.
1372
- *
1373
- */
1374
- useRoutedTransfers?: boolean;
1375
- /**
1376
- * List of via stops to visit (only stop IDs, no coordinates allowed for now).
1377
- * Also see the optional parameter `viaMinimumStay` to set a set a minimum stay duration for each via stop.
1378
- *
1379
- */
1380
- via?: Array<string>;
1381
- /**
1382
- * Optional. If not set, the default is `0,0` - no stay required.
1383
- *
1384
- * For each `via` stop a minimum stay duration in minutes.
1385
- *
1386
- * The value `0` signals that it's allowed to stay in the same trip.
1387
- * This enables via stays without counting a transfer and can lead
1388
- * to better connections with less transfers. Transfer connections can
1389
- * still be found with `viaMinimumStay=0`.
1390
- *
1391
- */
1392
- viaMinimumStay?: Array<number>;
1393
- /**
1394
- * Optional. Experimental. If set to true, the response will contain fare information.
1395
- */
1396
- withFares?: boolean;
1397
- /**
1398
- * Optional. Include intermediate stops where passengers can not alight/board according to schedule.
1399
- */
1400
- withScheduledSkippedStops?: boolean;
1401
- };
1402
- };
1403
- type PlanResponse = {
1404
- /**
1405
- * the routing query
1406
- */
1407
- requestParameters: {
1408
- [key: string]: string;
1409
- };
1410
- /**
1411
- * debug statistics
1412
- */
1413
- debugOutput: {
1414
- [key: string]: number;
1415
- };
1416
- from: Place;
1417
- to: Place;
1418
- /**
1419
- * Direct trips by `WALK`, `BIKE`, `CAR`, etc. without time-dependency.
1420
- * The starting time (`arriveBy=false`) / arrival time (`arriveBy=true`) is always the queried `time` parameter (set to \"now\" if not set).
1421
- * But all `direct` connections are meant to be independent of absolute times.
1422
- *
1423
- */
1424
- direct: Array<Itinerary>;
1425
- /**
1426
- * list of itineraries
1427
- */
1428
- itineraries: Array<Itinerary>;
1429
- /**
1430
- * Use the cursor to get the previous page of results. Insert the cursor into the request and post it to get the previous page.
1431
- * The previous page is a set of itineraries departing BEFORE the first itinerary in the result for a depart after search. When using the default sort order the previous set of itineraries is inserted before the current result.
1432
- *
1433
- */
1434
- previousPageCursor: string;
1435
- /**
1436
- * Use the cursor to get the next page of results. Insert the cursor into the request and post it to get the next page.
1437
- * The next page is a set of itineraries departing AFTER the last itinerary in this result.
1438
- *
1439
- */
1440
- nextPageCursor: string;
884
+ query: {
885
+ /**
886
+ * Optional. Default is 0 minutes.
887
+ *
888
+ * Additional transfer time reserved for each transfer in minutes.
889
+ *
890
+ */
891
+ additionalTransferTime?: number;
892
+ /**
893
+ * Optional. Default is `false`.
894
+ *
895
+ * - `arriveBy=true`: the parameters `date` and `time` refer to the arrival time
896
+ * - `arriveBy=false`: the parameters `date` and `time` refer to the departure time
897
+ *
898
+ */
899
+ arriveBy?: boolean;
900
+ /**
901
+ * - true: Compute transfer polylines and step instructions.
902
+ * - false: Only return basic information (start time, end time, duration) for transfers.
903
+ *
904
+ */
905
+ detailedTransfers: boolean;
906
+ /**
907
+ * Optional. Default is `WALK` which will compute walking routes as direct connections.
908
+ *
909
+ * Modes used for direction connections from start to destination without using transit.
910
+ * Results will be returned on the `direct` key.
911
+ *
912
+ * Note: Direct connections will only be returned on the first call. For paging calls, they can be omitted.
913
+ *
914
+ * Note: Transit connections that are slower than the fastest direct connection will not show up.
915
+ * This is being used as a cut-off during transit routing to speed up the search.
916
+ * To prevent this, it's possible to send two separate requests (one with only `transitModes` and one with only `directModes`).
917
+ *
918
+ * Note: the output `direct` array will stay empty if the input param `maxDirectTime` makes any direct trip impossible.
919
+ *
920
+ * Only non-transit modes such as `WALK`, `BIKE`, `CAR`, `BIKE_SHARING`, etc. can be used.
921
+ *
922
+ */
923
+ directModes?: Array<Mode>;
924
+ /**
925
+ * Experimental. Expect unannounced breaking changes (without version bumps).
926
+ *
927
+ * Optional. Only applies to direct connections.
928
+ *
929
+ * A list of vehicle type form factors that are allowed to be used for direct connections.
930
+ * If empty (the default), all form factors are allowed.
931
+ * Example: `BICYCLE,SCOOTER_STANDING`.
932
+ *
933
+ */
934
+ directRentalFormFactors?: Array<RentalFormFactor>;
935
+ /**
936
+ * Experimental. Expect unannounced breaking changes (without version bumps).
937
+ *
938
+ * Optional. Only applies to direct connections.
939
+ *
940
+ * A list of vehicle type form factors that are allowed to be used for direct connections.
941
+ * If empty (the default), all propulsion types are allowed.
942
+ * Example: `HUMAN,ELECTRIC,ELECTRIC_ASSIST`.
943
+ *
944
+ */
945
+ directRentalPropulsionTypes?: Array<RentalPropulsionType>;
946
+ /**
947
+ * Experimental. Expect unannounced breaking changes (without version bumps).
948
+ *
949
+ * Optional. Only applies to direct connections.
950
+ *
951
+ * A list of rental providers that are allowed to be used for direct connections.
952
+ * If empty (the default), all providers are allowed.
953
+ *
954
+ */
955
+ directRentalProviders?: Array<(string)>;
956
+ /**
957
+ * Optional. Default is `NONE`.
958
+ *
959
+ * Set an elevation cost profile, to penalize routes with incline.
960
+ * - `NONE`: No additional costs for elevations. This is the default behavior
961
+ * - `LOW`: Add a low cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if small detours are required.
962
+ * - `HIGH`: Add a high cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if larger detours are required.
963
+ *
964
+ * As using an elevation costs profile will increase the travel duration,
965
+ * routing through steep terrain may exceed the maximal allowed duration,
966
+ * causing a location to appear unreachable.
967
+ * Increasing the maximum travel time for these segments may resolve this issue.
968
+ *
969
+ * The profile is used for direct routing, on the first mile, and last mile.
970
+ *
971
+ * Elevation cost profiles are currently used by following street modes:
972
+ * - `BIKE`
973
+ *
974
+ */
975
+ elevationCosts?: ElevationCosts;
976
+ /**
977
+ * Optional. Experimental. Default is `1.0`.
978
+ * Factor with which the duration of the fastest direct connection is multiplied.
979
+ * Values > 1.0 allow connections that are slower than the fastest direct connection to be found.
980
+ *
981
+ */
982
+ fastestDirectFactor?: number;
983
+ /**
984
+ * \`latitude,longitude[,level]\` tuple with
985
+ * - latitude and longitude in degrees
986
+ * - (optional) level: the OSM level (default: 0)
987
+ *
988
+ * OR
989
+ *
990
+ * stop id
991
+ *
992
+ */
993
+ fromPlace: string;
994
+ /**
995
+ * Experimental. Expect unannounced breaking changes (without version bumps).
996
+ *
997
+ * Optional. Default is `false`.
998
+ *
999
+ * If set to `true`, the routing will ignore rental return constraints for direct connections,
1000
+ * allowing the rental vehicle to be parked anywhere.
1001
+ *
1002
+ */
1003
+ ignoreDirectRentalReturnConstraints?: boolean;
1004
+ /**
1005
+ * Experimental. Expect unannounced breaking changes (without version bumps).
1006
+ *
1007
+ * Optional. Default is `false`.
1008
+ *
1009
+ * If set to `true`, the routing will ignore rental return constraints for the part from the last transit stop to the `to` coordinate,
1010
+ * allowing the rental vehicle to be parked anywhere.
1011
+ *
1012
+ */
1013
+ ignorePostTransitRentalReturnConstraints?: boolean;
1014
+ /**
1015
+ * Experimental. Expect unannounced breaking changes (without version bumps).
1016
+ *
1017
+ * Optional. Default is `false`.
1018
+ *
1019
+ * If set to `true`, the routing will ignore rental return constraints for the part from the `from` coordinate to the first transit stop,
1020
+ * allowing the rental vehicle to be parked anywhere.
1021
+ *
1022
+ */
1023
+ ignorePreTransitRentalReturnConstraints?: boolean;
1024
+ /**
1025
+ * Optional. Default is `true`.
1026
+ *
1027
+ * Controls if a journey section with stay-seated transfers is returned:
1028
+ * - `joinInterlinedLegs=false`: as several legs (full information about all trip numbers, headsigns, etc.).
1029
+ * Legs that do not require a transfer (stay-seated transfer) are marked with `interlineWithPreviousLeg=true`.
1030
+ * - `joinInterlinedLegs=true` (default behavior): as only one joined leg containing all stops
1031
+ *
1032
+ */
1033
+ joinInterlinedLegs?: boolean;
1034
+ /**
1035
+ * Optional. Experimental. Number of luggage pieces; base unit: airline cabin luggage (e.g. for ODM or price calculation)
1036
+ *
1037
+ */
1038
+ luggage?: number;
1039
+ /**
1040
+ * Optional. Default is 30min which is `1800`.
1041
+ * Maximum time in seconds for direct connections.
1042
+ *
1043
+ */
1044
+ maxDirectTime?: number;
1045
+ /**
1046
+ * Optional. Default is 25 meters.
1047
+ *
1048
+ * Maximum matching distance in meters to match geo coordinates to the street network.
1049
+ *
1050
+ */
1051
+ maxMatchingDistance?: number;
1052
+ /**
1053
+ * Optional. Default is 15min which is `900`.
1054
+ * Maximum time in seconds for the last street leg.
1055
+ *
1056
+ */
1057
+ maxPostTransitTime?: number;
1058
+ /**
1059
+ * Optional. Default is 15min which is `900`.
1060
+ * Maximum time in seconds for the first street leg.
1061
+ *
1062
+ */
1063
+ maxPreTransitTime?: number;
1064
+ /**
1065
+ * The maximum number of allowed transfers (i.e. interchanges between transit legs,
1066
+ * pre- and postTransit do not count as transfers).
1067
+ * `maxTransfers=0` searches for direct transit connections without any transfers.
1068
+ * If you want to search only for non-transit connections (`FOOT`, `CAR`, etc.),
1069
+ * send an empty `transitModes` parameter instead.
1070
+ *
1071
+ * If not provided, the routing uses the server-side default value
1072
+ * which is hardcoded and very high to cover all use cases.
1073
+ *
1074
+ * *Warning*: Use with care. Setting this too low can lead to
1075
+ * optimal (e.g. the fastest) journeys not being found.
1076
+ * If this value is too low to reach the destination at all,
1077
+ * it can lead to slow routing performance.
1078
+ *
1079
+ * In plan endpoints before v3, the behavior is off by one,
1080
+ * i.e. `maxTransfers=0` only returns non-transit connections.
1081
+ *
1082
+ */
1083
+ maxTransfers?: number;
1084
+ /**
1085
+ * The maximum travel time in minutes.
1086
+ * If not provided, the routing to uses the value
1087
+ * hardcoded in the server which is usually quite high.
1088
+ *
1089
+ * *Warning*: Use with care. Setting this too low can lead to
1090
+ * optimal (e.g. the least transfers) journeys not being found.
1091
+ * If this value is too low to reach the destination at all,
1092
+ * it can lead to slow routing performance.
1093
+ *
1094
+ */
1095
+ maxTravelTime?: number;
1096
+ /**
1097
+ * Optional. Default is 0 minutes.
1098
+ *
1099
+ * Minimum transfer time for each transfer in minutes.
1100
+ *
1101
+ */
1102
+ minTransferTime?: number;
1103
+ /**
1104
+ * The minimum number of itineraries to compute.
1105
+ * This is only relevant if `timetableView=true`.
1106
+ * The default value is 5.
1107
+ *
1108
+ */
1109
+ numItineraries?: number;
1110
+ /**
1111
+ * Use the cursor to go to the next "page" of itineraries.
1112
+ * Copy the cursor from the last response and keep the original request as is.
1113
+ * This will enable you to search for itineraries in the next or previous time-window.
1114
+ *
1115
+ */
1116
+ pageCursor?: string;
1117
+ /**
1118
+ * Optional. Experimental. Number of passengers (e.g. for ODM or price calculation)
1119
+ */
1120
+ passengers?: number;
1121
+ /**
1122
+ * Optional. Default is `FOOT`.
1123
+ *
1124
+ * Accessibility profile to use for pedestrian routing in transfers
1125
+ * between transit connections, on the first mile, and last mile.
1126
+ *
1127
+ */
1128
+ pedestrianProfile?: PedestrianProfile;
1129
+ /**
1130
+ * Optional. Default is `WALK`. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directModes`).
1131
+ *
1132
+ * A list of modes that are allowed to be used from the last transit stop to the `to` coordinate. Example: `WALK,BIKE_SHARING`.
1133
+ *
1134
+ */
1135
+ postTransitModes?: Array<Mode>;
1136
+ /**
1137
+ * Experimental. Expect unannounced breaking changes (without version bumps).
1138
+ *
1139
+ * Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalFormFactors`).
1140
+ *
1141
+ * A list of vehicle type form factors that are allowed to be used from the last transit stop to the `to` coordinate.
1142
+ * If empty (the default), all form factors are allowed.
1143
+ * Example: `BICYCLE,SCOOTER_STANDING`.
1144
+ *
1145
+ */
1146
+ postTransitRentalFormFactors?: Array<RentalFormFactor>;
1147
+ /**
1148
+ * Experimental. Expect unannounced breaking changes (without version bumps).
1149
+ *
1150
+ * Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalPropulsionTypes`).
1151
+ *
1152
+ * A list of vehicle propulsion types that are allowed to be used from the last transit stop to the `to` coordinate.
1153
+ * If empty (the default), all propulsion types are allowed.
1154
+ * Example: `HUMAN,ELECTRIC,ELECTRIC_ASSIST`.
1155
+ *
1156
+ */
1157
+ postTransitRentalPropulsionTypes?: Array<RentalPropulsionType>;
1158
+ /**
1159
+ * Experimental. Expect unannounced breaking changes (without version bumps).
1160
+ *
1161
+ * Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviders`).
1162
+ *
1163
+ * A list of rental providers that are allowed to be used from the last transit stop to the `to` coordinate.
1164
+ * If empty (the default), all providers are allowed.
1165
+ *
1166
+ */
1167
+ postTransitRentalProviders?: Array<(string)>;
1168
+ /**
1169
+ * Optional. Default is `WALK`. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directModes`).
1170
+ *
1171
+ * A list of modes that are allowed to be used from the `from` coordinate to the first transit stop. Example: `WALK,BIKE_SHARING`.
1172
+ *
1173
+ */
1174
+ preTransitModes?: Array<Mode>;
1175
+ /**
1176
+ * Experimental. Expect unannounced breaking changes (without version bumps).
1177
+ *
1178
+ * Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalFormFactors`).
1179
+ *
1180
+ * A list of vehicle type form factors that are allowed to be used from the `from` coordinate to the first transit stop.
1181
+ * If empty (the default), all form factors are allowed.
1182
+ * Example: `BICYCLE,SCOOTER_STANDING`.
1183
+ *
1184
+ */
1185
+ preTransitRentalFormFactors?: Array<RentalFormFactor>;
1186
+ /**
1187
+ * Experimental. Expect unannounced breaking changes (without version bumps).
1188
+ *
1189
+ * Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalPropulsionTypes`).
1190
+ *
1191
+ * A list of vehicle propulsion types that are allowed to be used from the `from` coordinate to the first transit stop.
1192
+ * If empty (the default), all propulsion types are allowed.
1193
+ * Example: `HUMAN,ELECTRIC,ELECTRIC_ASSIST`.
1194
+ *
1195
+ */
1196
+ preTransitRentalPropulsionTypes?: Array<RentalPropulsionType>;
1197
+ /**
1198
+ * Experimental. Expect unannounced breaking changes (without version bumps).
1199
+ *
1200
+ * Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviders`).
1201
+ *
1202
+ * A list of rental providers that are allowed to be used from the `from` coordinate to the first transit stop.
1203
+ * If empty (the default), all providers are allowed.
1204
+ *
1205
+ */
1206
+ preTransitRentalProviders?: Array<(string)>;
1207
+ /**
1208
+ * Optional. Default is `false`.
1209
+ *
1210
+ * If set to `true`, all used transit trips are required to allow bike carriage.
1211
+ *
1212
+ */
1213
+ requireBikeTransport?: boolean;
1214
+ /**
1215
+ * Optional. Default is `false`.
1216
+ *
1217
+ * If set to `true`, all used transit trips are required to allow car carriage.
1218
+ *
1219
+ */
1220
+ requireCarTransport?: boolean;
1221
+ /**
1222
+ * Optional. Default is 2 hours which is `7200`.
1223
+ *
1224
+ * The length of the search-window in seconds. Default value two hours.
1225
+ *
1226
+ * - `arriveBy=true`: number of seconds between the earliest departure time and latest departure time
1227
+ * - `arriveBy=false`: number of seconds between the earliest arrival time and the latest arrival time
1228
+ *
1229
+ */
1230
+ searchWindow?: number;
1231
+ /**
1232
+ * Optional. Experimental. Adds overtaken direct connections.
1233
+ */
1234
+ slowDirect?: boolean;
1235
+ /**
1236
+ * Optional. Defaults to the current time.
1237
+ *
1238
+ * Departure time ($arriveBy=false) / arrival date ($arriveBy=true),
1239
+ *
1240
+ */
1241
+ time?: string;
1242
+ /**
1243
+ * Optional. Query timeout in seconds.
1244
+ */
1245
+ timeout?: number;
1246
+ /**
1247
+ * Optional. Default is `true`.
1248
+ *
1249
+ * Search for the best trip options within a time window.
1250
+ * If true two itineraries are considered optimal
1251
+ * if one is better on arrival time (earliest wins)
1252
+ * and the other is better on departure time (latest wins).
1253
+ * In combination with arriveBy this parameter cover the following use cases:
1254
+ *
1255
+ * `timetable=false` = waiting for the first transit departure/arrival is considered travel time:
1256
+ * - `arriveBy=true`: event (e.g. a meeting) starts at 10:00 am,
1257
+ * compute the best journeys that arrive by that time (maximizes departure time)
1258
+ * - `arriveBy=false`: event (e.g. a meeting) ends at 11:00 am,
1259
+ * compute the best journeys that depart after that time
1260
+ *
1261
+ * `timetable=true` = optimize "later departure" + "earlier arrival" and give all options over a time window:
1262
+ * - `arriveBy=true`: the time window around `date` and `time` refers to the arrival time window
1263
+ * - `arriveBy=false`: the time window around `date` and `time` refers to the departure time window
1264
+ *
1265
+ */
1266
+ timetableView?: boolean;
1267
+ /**
1268
+ * \`latitude,longitude[,level]\` tuple with
1269
+ * - latitude and longitude in degrees
1270
+ * - (optional) level: the OSM level (default: 0)
1271
+ *
1272
+ * OR
1273
+ *
1274
+ * stop id
1275
+ *
1276
+ */
1277
+ toPlace: string;
1278
+ /**
1279
+ * Optional. Default is 1.0
1280
+ *
1281
+ * Factor to multiply minimum required transfer times with.
1282
+ * Values smaller than 1.0 are not supported.
1283
+ *
1284
+ */
1285
+ transferTimeFactor?: number;
1286
+ /**
1287
+ * Optional. Default is `TRANSIT` which allows all transit modes (no restriction).
1288
+ * Allowed modes for the transit part. If empty, no transit connections will be computed.
1289
+ * For example, this can be used to allow only `METRO,SUBWAY,TRAM`.
1290
+ *
1291
+ */
1292
+ transitModes?: Array<Mode>;
1293
+ /**
1294
+ * Optional. Default is `false`.
1295
+ *
1296
+ * Whether to use transfers routed on OpenStreetMap data.
1297
+ *
1298
+ */
1299
+ useRoutedTransfers?: boolean;
1300
+ /**
1301
+ * List of via stops to visit (only stop IDs, no coordinates allowed for now).
1302
+ * Also see the optional parameter `viaMinimumStay` to set a set a minimum stay duration for each via stop.
1303
+ *
1304
+ */
1305
+ via?: Array<(string)>;
1306
+ /**
1307
+ * Optional. If not set, the default is `0,0` - no stay required.
1308
+ *
1309
+ * For each `via` stop a minimum stay duration in minutes.
1310
+ *
1311
+ * The value `0` signals that it's allowed to stay in the same trip.
1312
+ * This enables via stays without counting a transfer and can lead
1313
+ * to better connections with less transfers. Transfer connections can
1314
+ * still be found with `viaMinimumStay=0`.
1315
+ *
1316
+ */
1317
+ viaMinimumStay?: Array<(number)>;
1318
+ /**
1319
+ * Optional. Experimental. If set to true, the response will contain fare information.
1320
+ */
1321
+ withFares?: boolean;
1322
+ /**
1323
+ * Optional. Include intermediate stops where passengers can not alight/board according to schedule.
1324
+ */
1325
+ withScheduledSkippedStops?: boolean;
1326
+ };
1441
1327
  };
1328
+ type PlanResponse = ({
1329
+ /**
1330
+ * the routing query
1331
+ */
1332
+ requestParameters: {
1333
+ [key: string]: (string);
1334
+ };
1335
+ /**
1336
+ * debug statistics
1337
+ */
1338
+ debugOutput: {
1339
+ [key: string]: (number);
1340
+ };
1341
+ from: Place;
1342
+ to: Place;
1343
+ /**
1344
+ * Direct trips by `WALK`, `BIKE`, `CAR`, etc. without time-dependency.
1345
+ * The starting time (`arriveBy=false`) / arrival time (`arriveBy=true`) is always the queried `time` parameter (set to \"now\" if not set).
1346
+ * But all `direct` connections are meant to be independent of absolute times.
1347
+ *
1348
+ */
1349
+ direct: Array<Itinerary>;
1350
+ /**
1351
+ * list of itineraries
1352
+ */
1353
+ itineraries: Array<Itinerary>;
1354
+ /**
1355
+ * Use the cursor to get the previous page of results. Insert the cursor into the request and post it to get the previous page.
1356
+ * The previous page is a set of itineraries departing BEFORE the first itinerary in the result for a depart after search. When using the default sort order the previous set of itineraries is inserted before the current result.
1357
+ *
1358
+ */
1359
+ previousPageCursor: string;
1360
+ /**
1361
+ * Use the cursor to get the next page of results. Insert the cursor into the request and post it to get the next page.
1362
+ * The next page is a set of itineraries departing AFTER the last itinerary in this result.
1363
+ *
1364
+ */
1365
+ nextPageCursor: string;
1366
+ });
1442
1367
  type PlanError = unknown;
1443
1368
  type OneToManyData = {
1444
- query: {
1445
- /**
1446
- * true = many to one
1447
- * false = one to many
1448
- *
1449
- */
1450
- arriveBy: boolean;
1451
- /**
1452
- * Optional. Default is `NONE`.
1453
- *
1454
- * Set an elevation cost profile, to penalize routes with incline.
1455
- * - `NONE`: No additional costs for elevations. This is the default behavior
1456
- * - `LOW`: Add a low cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if small detours are required.
1457
- * - `HIGH`: Add a high cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if larger detours are required.
1458
- *
1459
- * As using an elevation costs profile will increase the travel duration,
1460
- * routing through steep terrain may exceed the maximal allowed duration,
1461
- * causing a location to appear unreachable.
1462
- * Increasing the maximum travel time for these segments may resolve this issue.
1463
- *
1464
- * Elevation cost profiles are currently used by following street modes:
1465
- * - `BIKE`
1466
- *
1467
- */
1468
- elevationCosts?: ElevationCosts;
1469
- /**
1470
- * geo locations as latitude;longitude,latitude;longitude,...
1471
- */
1472
- many: Array<string>;
1473
- /**
1474
- * maximum travel time in seconds
1475
- */
1476
- max: number;
1477
- /**
1478
- * maximum matching distance in meters to match geo coordinates to the street network
1479
- */
1480
- maxMatchingDistance: number;
1481
- /**
1482
- * routing profile to use (currently supported: \`WALK\`, \`BIKE\`, \`CAR\`)
1483
- *
1484
- */
1485
- mode: Mode;
1486
- /**
1487
- * geo location as latitude;longitude
1488
- */
1489
- one: string;
1490
- };
1369
+ query: {
1370
+ /**
1371
+ * true = many to one
1372
+ * false = one to many
1373
+ *
1374
+ */
1375
+ arriveBy: boolean;
1376
+ /**
1377
+ * Optional. Default is `NONE`.
1378
+ *
1379
+ * Set an elevation cost profile, to penalize routes with incline.
1380
+ * - `NONE`: No additional costs for elevations. This is the default behavior
1381
+ * - `LOW`: Add a low cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if small detours are required.
1382
+ * - `HIGH`: Add a high cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if larger detours are required.
1383
+ *
1384
+ * As using an elevation costs profile will increase the travel duration,
1385
+ * routing through steep terrain may exceed the maximal allowed duration,
1386
+ * causing a location to appear unreachable.
1387
+ * Increasing the maximum travel time for these segments may resolve this issue.
1388
+ *
1389
+ * Elevation cost profiles are currently used by following street modes:
1390
+ * - `BIKE`
1391
+ *
1392
+ */
1393
+ elevationCosts?: ElevationCosts;
1394
+ /**
1395
+ * geo locations as latitude;longitude,latitude;longitude,...
1396
+ */
1397
+ many: Array<(string)>;
1398
+ /**
1399
+ * maximum travel time in seconds
1400
+ */
1401
+ max: number;
1402
+ /**
1403
+ * maximum matching distance in meters to match geo coordinates to the street network
1404
+ */
1405
+ maxMatchingDistance: number;
1406
+ /**
1407
+ * routing profile to use (currently supported: \`WALK\`, \`BIKE\`, \`CAR\`)
1408
+ *
1409
+ */
1410
+ mode: Mode;
1411
+ /**
1412
+ * geo location as latitude;longitude
1413
+ */
1414
+ one: string;
1415
+ };
1491
1416
  };
1492
- type OneToManyResponse = Array<Duration>;
1417
+ type OneToManyResponse = (Array<Duration>);
1493
1418
  type OneToManyError = unknown;
1494
1419
  type OneToAllData = {
1495
- query: {
1496
- /**
1497
- * Optional. Default is 0 minutes.
1498
- *
1499
- * Additional transfer time reserved for each transfer in minutes.
1500
- *
1501
- */
1502
- additionalTransferTime?: number;
1503
- /**
1504
- * true = all to one,
1505
- * false = one to all
1506
- *
1507
- */
1508
- arriveBy?: boolean;
1509
- /**
1510
- * Optional. Default is `NONE`.
1511
- *
1512
- * Set an elevation cost profile, to penalize routes with incline.
1513
- * - `NONE`: No additional costs for elevations. This is the default behavior
1514
- * - `LOW`: Add a low cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if small detours are required.
1515
- * - `HIGH`: Add a high cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if larger detours are required.
1516
- *
1517
- * As using an elevation costs profile will increase the travel duration,
1518
- * routing through steep terrain may exceed the maximal allowed duration,
1519
- * causing a location to appear unreachable.
1520
- * Increasing the maximum travel time for these segments may resolve this issue.
1521
- *
1522
- * The profile is used for routing on both the first and last mile.
1523
- *
1524
- * Elevation cost profiles are currently used by following street modes:
1525
- * - `BIKE`
1526
- *
1527
- */
1528
- elevationCosts?: ElevationCosts;
1529
- /**
1530
- * Optional. Default is 25 meters.
1531
- *
1532
- * Maximum matching distance in meters to match geo coordinates to the street network.
1533
- *
1534
- */
1535
- maxMatchingDistance?: number;
1536
- /**
1537
- * Optional. Default is 15min which is `900`.
1538
- * - `arriveBy=true`: Maximum time in seconds for the street leg at `one` location.
1539
- * - `arriveBy=false`: Currently not used
1540
- *
1541
- */
1542
- maxPostTransitTime?: number;
1543
- /**
1544
- * Optional. Default is 15min which is `900`.
1545
- * - `arriveBy=true`: Currently not used
1546
- * - `arriveBy=false`: Maximum time in seconds for the street leg at `one` location.
1547
- *
1548
- */
1549
- maxPreTransitTime?: number;
1550
- /**
1551
- * The maximum number of allowed transfers (i.e. interchanges between transit legs,
1552
- * pre- and postTransit do not count as transfers).
1553
- * `maxTransfers=0` searches for direct transit connections without any transfers.
1554
- * If you want to search only for non-transit connections (`FOOT`, `CAR`, etc.),
1555
- * send an empty `transitModes` parameter instead.
1556
- *
1557
- * If not provided, the routing uses the server-side default value
1558
- * which is hardcoded and very high to cover all use cases.
1559
- *
1560
- * *Warning*: Use with care. Setting this too low can lead to
1561
- * optimal (e.g. the fastest) journeys not being found.
1562
- * If this value is too low to reach the destination at all,
1563
- * it can lead to slow routing performance.
1564
- *
1565
- * In plan endpoints before v3, the behavior is off by one,
1566
- * i.e. `maxTransfers=0` only returns non-transit connections.
1567
- *
1568
- */
1569
- maxTransfers?: number;
1570
- /**
1571
- * maximum travel time in minutes
1572
- */
1573
- maxTravelTime: number;
1574
- /**
1575
- * Optional. Default is 0 minutes.
1576
- *
1577
- * Minimum transfer time for each transfer in minutes.
1578
- *
1579
- */
1580
- minTransferTime?: number;
1581
- /**
1582
- * \`latitude,longitude[,level]\` tuple with
1583
- * - latitude and longitude in degrees
1584
- * - (optional) level: the OSM level (default: 0)
1585
- *
1586
- * OR
1587
- *
1588
- * stop id
1589
- *
1590
- */
1591
- one: string;
1592
- /**
1593
- * Optional. Default is `FOOT`.
1594
- *
1595
- * Accessibility profile to use for pedestrian routing in transfers
1596
- * between transit connections and the first and last mile respectively.
1597
- *
1598
- */
1599
- pedestrianProfile?: PedestrianProfile;
1600
- /**
1601
- * Optional. Default is `WALK`. The behavior depends on whether `arriveBy` is set:
1602
- * - `arriveBy=true`: Only applies if the `one` place is a coordinate (not a transit stop).
1603
- * - `arriveBy=false`: Currently not used
1604
- *
1605
- * A list of modes that are allowed to be used from the last transit stop to the `to` coordinate. Example: `WALK,BIKE_SHARING`.
1606
- *
1607
- */
1608
- postTransitModes?: Array<Mode>;
1609
- /**
1610
- * Optional. Default is `WALK`. The behavior depends on whether `arriveBy` is set:
1611
- * - `arriveBy=true`: Currently not used
1612
- * - `arriveBy=false`: Only applies if the `one` place is a coordinate (not a transit stop).
1613
- *
1614
- * A list of modes that are allowed to be used from the last transit stop to the `to` coordinate. Example: `WALK,BIKE_SHARING`.
1615
- *
1616
- */
1617
- preTransitModes?: Array<Mode>;
1618
- /**
1619
- * Optional. Default is `false`.
1620
- *
1621
- * If set to `true`, all used transit trips are required to allow bike carriage.
1622
- *
1623
- */
1624
- requireBikeTransport?: boolean;
1625
- /**
1626
- * Optional. Default is `false`.
1627
- *
1628
- * If set to `true`, all used transit trips are required to allow car carriage.
1629
- *
1630
- */
1631
- requireCarTransport?: boolean;
1632
- /**
1633
- * Optional. Defaults to the current time.
1634
- *
1635
- * Departure time ($arriveBy=false) / arrival date ($arriveBy=true),
1636
- *
1637
- */
1638
- time?: string;
1639
- /**
1640
- * Optional. Default is 1.0
1641
- *
1642
- * Factor to multiply minimum required transfer times with.
1643
- * Values smaller than 1.0 are not supported.
1644
- *
1645
- */
1646
- transferTimeFactor?: number;
1647
- /**
1648
- * Optional. Default is `TRANSIT` which allows all transit modes (no restriction).
1649
- * Allowed modes for the transit part. If empty, no transit connections will be computed.
1650
- * For example, this can be used to allow only `METRO,SUBWAY,TRAM`.
1651
- *
1652
- */
1653
- transitModes?: Array<Mode>;
1654
- /**
1655
- * Optional. Default is `false`.
1656
- *
1657
- * Whether to use transfers routed on OpenStreetMap data.
1658
- *
1659
- */
1660
- useRoutedTransfers?: boolean;
1661
- };
1420
+ query: {
1421
+ /**
1422
+ * Optional. Default is 0 minutes.
1423
+ *
1424
+ * Additional transfer time reserved for each transfer in minutes.
1425
+ *
1426
+ */
1427
+ additionalTransferTime?: number;
1428
+ /**
1429
+ * true = all to one,
1430
+ * false = one to all
1431
+ *
1432
+ */
1433
+ arriveBy?: boolean;
1434
+ /**
1435
+ * Optional. Default is `NONE`.
1436
+ *
1437
+ * Set an elevation cost profile, to penalize routes with incline.
1438
+ * - `NONE`: No additional costs for elevations. This is the default behavior
1439
+ * - `LOW`: Add a low cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if small detours are required.
1440
+ * - `HIGH`: Add a high cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if larger detours are required.
1441
+ *
1442
+ * As using an elevation costs profile will increase the travel duration,
1443
+ * routing through steep terrain may exceed the maximal allowed duration,
1444
+ * causing a location to appear unreachable.
1445
+ * Increasing the maximum travel time for these segments may resolve this issue.
1446
+ *
1447
+ * The profile is used for routing on both the first and last mile.
1448
+ *
1449
+ * Elevation cost profiles are currently used by following street modes:
1450
+ * - `BIKE`
1451
+ *
1452
+ */
1453
+ elevationCosts?: ElevationCosts;
1454
+ /**
1455
+ * Optional. Default is 25 meters.
1456
+ *
1457
+ * Maximum matching distance in meters to match geo coordinates to the street network.
1458
+ *
1459
+ */
1460
+ maxMatchingDistance?: number;
1461
+ /**
1462
+ * Optional. Default is 15min which is `900`.
1463
+ * - `arriveBy=true`: Maximum time in seconds for the street leg at `one` location.
1464
+ * - `arriveBy=false`: Currently not used
1465
+ *
1466
+ */
1467
+ maxPostTransitTime?: number;
1468
+ /**
1469
+ * Optional. Default is 15min which is `900`.
1470
+ * - `arriveBy=true`: Currently not used
1471
+ * - `arriveBy=false`: Maximum time in seconds for the street leg at `one` location.
1472
+ *
1473
+ */
1474
+ maxPreTransitTime?: number;
1475
+ /**
1476
+ * The maximum number of allowed transfers (i.e. interchanges between transit legs,
1477
+ * pre- and postTransit do not count as transfers).
1478
+ * `maxTransfers=0` searches for direct transit connections without any transfers.
1479
+ * If you want to search only for non-transit connections (`FOOT`, `CAR`, etc.),
1480
+ * send an empty `transitModes` parameter instead.
1481
+ *
1482
+ * If not provided, the routing uses the server-side default value
1483
+ * which is hardcoded and very high to cover all use cases.
1484
+ *
1485
+ * *Warning*: Use with care. Setting this too low can lead to
1486
+ * optimal (e.g. the fastest) journeys not being found.
1487
+ * If this value is too low to reach the destination at all,
1488
+ * it can lead to slow routing performance.
1489
+ *
1490
+ * In plan endpoints before v3, the behavior is off by one,
1491
+ * i.e. `maxTransfers=0` only returns non-transit connections.
1492
+ *
1493
+ */
1494
+ maxTransfers?: number;
1495
+ /**
1496
+ * maximum travel time in minutes
1497
+ */
1498
+ maxTravelTime: number;
1499
+ /**
1500
+ * Optional. Default is 0 minutes.
1501
+ *
1502
+ * Minimum transfer time for each transfer in minutes.
1503
+ *
1504
+ */
1505
+ minTransferTime?: number;
1506
+ /**
1507
+ * \`latitude,longitude[,level]\` tuple with
1508
+ * - latitude and longitude in degrees
1509
+ * - (optional) level: the OSM level (default: 0)
1510
+ *
1511
+ * OR
1512
+ *
1513
+ * stop id
1514
+ *
1515
+ */
1516
+ one: string;
1517
+ /**
1518
+ * Optional. Default is `FOOT`.
1519
+ *
1520
+ * Accessibility profile to use for pedestrian routing in transfers
1521
+ * between transit connections and the first and last mile respectively.
1522
+ *
1523
+ */
1524
+ pedestrianProfile?: PedestrianProfile;
1525
+ /**
1526
+ * Optional. Default is `WALK`. The behavior depends on whether `arriveBy` is set:
1527
+ * - `arriveBy=true`: Only applies if the `one` place is a coordinate (not a transit stop).
1528
+ * - `arriveBy=false`: Currently not used
1529
+ *
1530
+ * A list of modes that are allowed to be used from the last transit stop to the `to` coordinate. Example: `WALK,BIKE_SHARING`.
1531
+ *
1532
+ */
1533
+ postTransitModes?: Array<Mode>;
1534
+ /**
1535
+ * Optional. Default is `WALK`. The behavior depends on whether `arriveBy` is set:
1536
+ * - `arriveBy=true`: Currently not used
1537
+ * - `arriveBy=false`: Only applies if the `one` place is a coordinate (not a transit stop).
1538
+ *
1539
+ * A list of modes that are allowed to be used from the last transit stop to the `to` coordinate. Example: `WALK,BIKE_SHARING`.
1540
+ *
1541
+ */
1542
+ preTransitModes?: Array<Mode>;
1543
+ /**
1544
+ * Optional. Default is `false`.
1545
+ *
1546
+ * If set to `true`, all used transit trips are required to allow bike carriage.
1547
+ *
1548
+ */
1549
+ requireBikeTransport?: boolean;
1550
+ /**
1551
+ * Optional. Default is `false`.
1552
+ *
1553
+ * If set to `true`, all used transit trips are required to allow car carriage.
1554
+ *
1555
+ */
1556
+ requireCarTransport?: boolean;
1557
+ /**
1558
+ * Optional. Defaults to the current time.
1559
+ *
1560
+ * Departure time ($arriveBy=false) / arrival date ($arriveBy=true),
1561
+ *
1562
+ */
1563
+ time?: string;
1564
+ /**
1565
+ * Optional. Default is 1.0
1566
+ *
1567
+ * Factor to multiply minimum required transfer times with.
1568
+ * Values smaller than 1.0 are not supported.
1569
+ *
1570
+ */
1571
+ transferTimeFactor?: number;
1572
+ /**
1573
+ * Optional. Default is `TRANSIT` which allows all transit modes (no restriction).
1574
+ * Allowed modes for the transit part. If empty, no transit connections will be computed.
1575
+ * For example, this can be used to allow only `METRO,SUBWAY,TRAM`.
1576
+ *
1577
+ */
1578
+ transitModes?: Array<Mode>;
1579
+ /**
1580
+ * Optional. Default is `false`.
1581
+ *
1582
+ * Whether to use transfers routed on OpenStreetMap data.
1583
+ *
1584
+ */
1585
+ useRoutedTransfers?: boolean;
1586
+ };
1662
1587
  };
1663
- type OneToAllResponse = Reachable;
1588
+ type OneToAllResponse = (Reachable);
1664
1589
  type OneToAllError = unknown;
1665
1590
  type ReverseGeocodeData = {
1666
- query: {
1667
- /**
1668
- * latitude, longitude in degrees
1669
- */
1670
- place: string;
1671
- /**
1672
- * Optional. Default is all types.
1673
- *
1674
- * Only return results of the given type.
1675
- * For example, this can be used to allow only `ADDRESS` and `STOP` results.
1676
- *
1677
- */
1678
- type?: LocationType;
1679
- };
1591
+ query: {
1592
+ /**
1593
+ * latitude, longitude in degrees
1594
+ */
1595
+ place: string;
1596
+ /**
1597
+ * Optional. Default is all types.
1598
+ *
1599
+ * Only return results of the given type.
1600
+ * For example, this can be used to allow only `ADDRESS` and `STOP` results.
1601
+ *
1602
+ */
1603
+ type?: LocationType;
1604
+ };
1680
1605
  };
1681
- type ReverseGeocodeResponse = Array<Match>;
1606
+ type ReverseGeocodeResponse = (Array<Match>);
1682
1607
  type ReverseGeocodeError = unknown;
1683
1608
  type GeocodeData = {
1684
- query: {
1685
- /**
1686
- * language tags as used in OpenStreetMap
1687
- * (usually ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
1688
- *
1689
- */
1690
- language?: string;
1691
- /**
1692
- * Optional. Used for biasing results towards the coordinate.
1693
- *
1694
- * Format: latitude,longitude in degrees
1695
- *
1696
- */
1697
- place?: string;
1698
- /**
1699
- * Optional. Used for biasing results towards the coordinate. Higher number = higher bias.
1700
- *
1701
- */
1702
- placeBias?: number;
1703
- /**
1704
- * the (potentially partially typed) address to resolve
1705
- */
1706
- text: string;
1707
- /**
1708
- * Optional. Default is all types.
1709
- *
1710
- * Only return results of the given types.
1711
- * For example, this can be used to allow only `ADDRESS` and `STOP` results.
1712
- *
1713
- */
1714
- type?: LocationType;
1715
- };
1609
+ query: {
1610
+ /**
1611
+ * language tags as used in OpenStreetMap
1612
+ * (usually ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
1613
+ *
1614
+ */
1615
+ language?: string;
1616
+ /**
1617
+ * Optional. Used for biasing results towards the coordinate.
1618
+ *
1619
+ * Format: latitude,longitude in degrees
1620
+ *
1621
+ */
1622
+ place?: string;
1623
+ /**
1624
+ * Optional. Used for biasing results towards the coordinate. Higher number = higher bias.
1625
+ *
1626
+ */
1627
+ placeBias?: number;
1628
+ /**
1629
+ * the (potentially partially typed) address to resolve
1630
+ */
1631
+ text: string;
1632
+ /**
1633
+ * Optional. Default is all types.
1634
+ *
1635
+ * Only return results of the given types.
1636
+ * For example, this can be used to allow only `ADDRESS` and `STOP` results.
1637
+ *
1638
+ */
1639
+ type?: LocationType;
1640
+ };
1716
1641
  };
1717
- type GeocodeResponse = Array<Match>;
1642
+ type GeocodeResponse = (Array<Match>);
1718
1643
  type GeocodeError = unknown;
1719
1644
  type TripData = {
1720
- query: {
1721
- /**
1722
- * trip identifier (e.g. from an itinerary leg or stop event)
1723
- */
1724
- tripId: string;
1725
- /**
1726
- * Optional. Include intermediate stops where passengers can not alight/board according to schedule.
1727
- */
1728
- withScheduledSkippedStops?: boolean;
1729
- };
1645
+ query: {
1646
+ /**
1647
+ * Optional. Default is `true`.
1648
+ *
1649
+ * Controls if a trip with stay-seated transfers is returned:
1650
+ * - `joinInterlinedLegs=false`: as several legs (full information about all trip numbers, headsigns, etc.).
1651
+ * Legs that do not require a transfer (stay-seated transfer) are marked with `interlineWithPreviousLeg=true`.
1652
+ * - `joinInterlinedLegs=true` (default behavior): as only one joined leg containing all stops
1653
+ *
1654
+ */
1655
+ joinInterlinedLegs?: boolean;
1656
+ /**
1657
+ * trip identifier (e.g. from an itinerary leg or stop event)
1658
+ */
1659
+ tripId: string;
1660
+ /**
1661
+ * Optional. Include intermediate stops where passengers can not alight/board according to schedule.
1662
+ */
1663
+ withScheduledSkippedStops?: boolean;
1664
+ };
1730
1665
  };
1731
- type TripResponse = Itinerary;
1666
+ type TripResponse = (Itinerary);
1732
1667
  type TripError = unknown;
1733
1668
  type StoptimesData = {
1734
- query: {
1735
- /**
1736
- * Optional. Default is `false`.
1737
- *
1738
- * - `arriveBy=true`: the parameters `date` and `time` refer to the arrival time
1739
- * - `arriveBy=false`: the parameters `date` and `time` refer to the departure time
1740
- *
1741
- */
1742
- arriveBy?: boolean;
1743
- /**
1744
- * This parameter will be ignored in case `pageCursor` is set.
1745
- *
1746
- * Optional. Default is
1747
- * - `LATER` for `arriveBy=false`
1748
- * - `EARLIER` for `arriveBy=true`
1749
- *
1750
- * The response will contain the next `n` arrivals / departures
1751
- * in case `EARLIER` is selected and the previous `n`
1752
- * arrivals / departures if `LATER` is selected.
1753
- *
1754
- */
1755
- direction?: 'EARLIER' | 'LATER';
1756
- /**
1757
- * Optional. Default is `false`.
1758
- *
1759
- * If set to `true`, only stations that are phyiscally in the radius are considered.
1760
- * If set to `false`, additionally to the stations in the radius, equivalences with the same name and children are considered.
1761
- *
1762
- */
1763
- exactRadius?: boolean;
1764
- /**
1765
- * Optional. Default is all transit modes.
1766
- *
1767
- * Only return arrivals/departures of the given modes.
1768
- *
1769
- */
1770
- mode?: Array<Mode>;
1771
- /**
1772
- * the number of events
1773
- */
1774
- n: number;
1775
- /**
1776
- * Use the cursor to go to the next "page" of stop times.
1777
- * Copy the cursor from the last response and keep the original request as is.
1778
- * This will enable you to search for stop times in the next or previous time-window.
1779
- *
1780
- */
1781
- pageCursor?: string;
1782
- /**
1783
- * Optional. Radius in meters.
1784
- *
1785
- * Default is that only stop times of the parent of the stop itself
1786
- * and all stops with the same name (+ their child stops) are returned.
1787
- *
1788
- * If set, all stops at parent stations and their child stops in the specified radius
1789
- * are returned.
1790
- *
1791
- */
1792
- radius?: number;
1793
- /**
1794
- * stop id of the stop to retrieve departures/arrivals for
1795
- */
1796
- stopId: string;
1797
- /**
1798
- * Optional. Defaults to the current time.
1799
- *
1800
- */
1801
- time?: string;
1802
- /**
1803
- * Optional. Include stoptimes where passengers can not alight/board according to schedule.
1804
- */
1805
- withScheduledSkippedStops?: boolean;
1806
- };
1807
- };
1808
- type StoptimesResponse = {
1809
- /**
1810
- * list of stop times
1811
- */
1812
- stopTimes: Array<StopTime>;
1813
- /**
1814
- * metadata of the requested stop
1815
- */
1816
- place: Place;
1817
- /**
1818
- * Use the cursor to get the previous page of results. Insert the cursor into the request and post it to get the previous page.
1819
- * The previous page is a set of stop times BEFORE the first stop time in the result.
1820
- *
1821
- */
1822
- previousPageCursor: string;
1823
- /**
1824
- * Use the cursor to get the next page of results. Insert the cursor into the request and post it to get the next page.
1825
- * The next page is a set of stop times AFTER the last stop time in this result.
1826
- *
1827
- */
1828
- nextPageCursor: string;
1669
+ query: {
1670
+ /**
1671
+ * Optional. Default is `false`.
1672
+ *
1673
+ * - `arriveBy=true`: the parameters `date` and `time` refer to the arrival time
1674
+ * - `arriveBy=false`: the parameters `date` and `time` refer to the departure time
1675
+ *
1676
+ */
1677
+ arriveBy?: boolean;
1678
+ /**
1679
+ * This parameter will be ignored in case `pageCursor` is set.
1680
+ *
1681
+ * Optional. Default is
1682
+ * - `LATER` for `arriveBy=false`
1683
+ * - `EARLIER` for `arriveBy=true`
1684
+ *
1685
+ * The response will contain the next `n` arrivals / departures
1686
+ * in case `EARLIER` is selected and the previous `n`
1687
+ * arrivals / departures if `LATER` is selected.
1688
+ *
1689
+ */
1690
+ direction?: 'EARLIER' | 'LATER';
1691
+ /**
1692
+ * Optional. Default is `false`.
1693
+ *
1694
+ * If set to `true`, only stations that are phyiscally in the radius are considered.
1695
+ * If set to `false`, additionally to the stations in the radius, equivalences with the same name and children are considered.
1696
+ *
1697
+ */
1698
+ exactRadius?: boolean;
1699
+ /**
1700
+ * Optional. Default is all transit modes.
1701
+ *
1702
+ * Only return arrivals/departures of the given modes.
1703
+ *
1704
+ */
1705
+ mode?: Array<Mode>;
1706
+ /**
1707
+ * the number of events
1708
+ */
1709
+ n: number;
1710
+ /**
1711
+ * Use the cursor to go to the next "page" of stop times.
1712
+ * Copy the cursor from the last response and keep the original request as is.
1713
+ * This will enable you to search for stop times in the next or previous time-window.
1714
+ *
1715
+ */
1716
+ pageCursor?: string;
1717
+ /**
1718
+ * Optional. Radius in meters.
1719
+ *
1720
+ * Default is that only stop times of the parent of the stop itself
1721
+ * and all stops with the same name (+ their child stops) are returned.
1722
+ *
1723
+ * If set, all stops at parent stations and their child stops in the specified radius
1724
+ * are returned.
1725
+ *
1726
+ */
1727
+ radius?: number;
1728
+ /**
1729
+ * stop id of the stop to retrieve departures/arrivals for
1730
+ */
1731
+ stopId: string;
1732
+ /**
1733
+ * Optional. Defaults to the current time.
1734
+ *
1735
+ */
1736
+ time?: string;
1737
+ /**
1738
+ * Optional. Include stoptimes where passengers can not alight/board according to schedule.
1739
+ */
1740
+ withScheduledSkippedStops?: boolean;
1741
+ };
1829
1742
  };
1743
+ type StoptimesResponse = ({
1744
+ /**
1745
+ * list of stop times
1746
+ */
1747
+ stopTimes: Array<StopTime>;
1748
+ /**
1749
+ * metadata of the requested stop
1750
+ */
1751
+ place: Place;
1752
+ /**
1753
+ * Use the cursor to get the previous page of results. Insert the cursor into the request and post it to get the previous page.
1754
+ * The previous page is a set of stop times BEFORE the first stop time in the result.
1755
+ *
1756
+ */
1757
+ previousPageCursor: string;
1758
+ /**
1759
+ * Use the cursor to get the next page of results. Insert the cursor into the request and post it to get the next page.
1760
+ * The next page is a set of stop times AFTER the last stop time in this result.
1761
+ *
1762
+ */
1763
+ nextPageCursor: string;
1764
+ });
1830
1765
  type StoptimesError = unknown;
1831
1766
  type TripsData = {
1832
- query: {
1833
- /**
1834
- * end if the time window
1835
- */
1836
- endTime: string;
1837
- /**
1838
- * latitude,longitude pair of the upper left coordinate
1839
- */
1840
- max: string;
1841
- /**
1842
- * latitude,longitude pair of the lower right coordinate
1843
- */
1844
- min: string;
1845
- /**
1846
- * start of the time window
1847
- */
1848
- startTime: string;
1849
- /**
1850
- * current zoom level
1851
- */
1852
- zoom: number;
1853
- };
1767
+ query: {
1768
+ /**
1769
+ * end if the time window
1770
+ */
1771
+ endTime: string;
1772
+ /**
1773
+ * latitude,longitude pair of the upper left coordinate
1774
+ */
1775
+ max: string;
1776
+ /**
1777
+ * latitude,longitude pair of the lower right coordinate
1778
+ */
1779
+ min: string;
1780
+ /**
1781
+ * start of the time window
1782
+ */
1783
+ startTime: string;
1784
+ /**
1785
+ * current zoom level
1786
+ */
1787
+ zoom: number;
1788
+ };
1854
1789
  };
1855
- type TripsResponse = Array<TripSegment>;
1790
+ type TripsResponse = (Array<TripSegment>);
1856
1791
  type TripsError = unknown;
1857
- type InitialResponse = {
1858
- /**
1859
- * latitude
1860
- */
1861
- lat: number;
1862
- /**
1863
- * longitude
1864
- */
1865
- lon: number;
1866
- /**
1867
- * zoom level
1868
- */
1869
- zoom: number;
1870
- };
1792
+ type InitialResponse = ({
1793
+ /**
1794
+ * latitude
1795
+ */
1796
+ lat: number;
1797
+ /**
1798
+ * longitude
1799
+ */
1800
+ lon: number;
1801
+ /**
1802
+ * zoom level
1803
+ */
1804
+ zoom: number;
1805
+ });
1871
1806
  type InitialError = unknown;
1872
1807
  type StopsData = {
1873
- query: {
1874
- /**
1875
- * latitude,longitude pair of the upper left coordinate
1876
- */
1877
- max: string;
1878
- /**
1879
- * latitude,longitude pair of the lower right coordinate
1880
- */
1881
- min: string;
1882
- };
1808
+ query: {
1809
+ /**
1810
+ * latitude,longitude pair of the upper left coordinate
1811
+ */
1812
+ max: string;
1813
+ /**
1814
+ * latitude,longitude pair of the lower right coordinate
1815
+ */
1816
+ min: string;
1817
+ };
1883
1818
  };
1884
- type StopsResponse = Array<Place>;
1819
+ type StopsResponse = (Array<Place>);
1885
1820
  type StopsError = unknown;
1886
1821
  type LevelsData = {
1887
- query: {
1888
- /**
1889
- * latitude,longitude pair of the upper left coordinate
1890
- */
1891
- max: string;
1892
- /**
1893
- * latitude,longitude pair of the lower right coordinate
1894
- */
1895
- min: string;
1896
- };
1822
+ query: {
1823
+ /**
1824
+ * latitude,longitude pair of the upper left coordinate
1825
+ */
1826
+ max: string;
1827
+ /**
1828
+ * latitude,longitude pair of the lower right coordinate
1829
+ */
1830
+ min: string;
1831
+ };
1897
1832
  };
1898
- type LevelsResponse = Array<number>;
1833
+ type LevelsResponse = (Array<(number)>);
1899
1834
  type LevelsError = unknown;
1900
1835
  type TransfersData = {
1901
- query: {
1902
- /**
1903
- * location id
1904
- */
1905
- id: string;
1906
- };
1907
- };
1908
- type TransfersResponse = {
1909
- place: Place;
1910
- /**
1911
- * true if the server has foot transfers computed
1912
- */
1913
- hasFootTransfers: boolean;
1914
- /**
1915
- * true if the server has wheelchair transfers computed
1916
- */
1917
- hasWheelchairTransfers: boolean;
1918
- /**
1919
- * true if the server has car transfers computed
1920
- */
1921
- hasCarTransfers: boolean;
1922
- /**
1923
- * all outgoing transfers of this location
1924
- */
1925
- transfers: Array<Transfer>;
1836
+ query: {
1837
+ /**
1838
+ * location id
1839
+ */
1840
+ id: string;
1841
+ };
1926
1842
  };
1843
+ type TransfersResponse = ({
1844
+ place: Place;
1845
+ /**
1846
+ * true if the server has foot transfers computed
1847
+ */
1848
+ hasFootTransfers: boolean;
1849
+ /**
1850
+ * true if the server has wheelchair transfers computed
1851
+ */
1852
+ hasWheelchairTransfers: boolean;
1853
+ /**
1854
+ * true if the server has car transfers computed
1855
+ */
1856
+ hasCarTransfers: boolean;
1857
+ /**
1858
+ * all outgoing transfers of this location
1859
+ */
1860
+ transfers: Array<Transfer>;
1861
+ });
1927
1862
  type TransfersError = unknown;
1928
1863
 
1929
- export type {
1930
- Alert,
1931
- AlertCause,
1932
- AlertEffect,
1933
- AlertSeverityLevel,
1934
- Area,
1935
- Direction,
1936
- Duration,
1937
- ElevationCosts,
1938
- EncodedPolyline,
1939
- FareMedia,
1940
- FareMediaType,
1941
- FareProduct,
1942
- FareTransfer,
1943
- FareTransferRule,
1944
- GeocodeData,
1945
- GeocodeError,
1946
- GeocodeResponse,
1947
- InitialError,
1948
- InitialResponse,
1949
- Itinerary,
1950
- Leg,
1951
- LevelsData,
1952
- LevelsError,
1953
- LevelsResponse,
1954
- LocationType,
1955
- Match,
1956
- Mode,
1957
- OneToAllData,
1958
- OneToAllError,
1959
- OneToAllResponse,
1960
- OneToManyData,
1961
- OneToManyError,
1962
- OneToManyResponse,
1963
- PedestrianProfile,
1964
- PickupDropoffType,
1965
- Place,
1966
- PlanData,
1967
- PlanError,
1968
- PlanResponse,
1969
- Reachable,
1970
- ReachablePlace,
1971
- Rental,
1972
- RentalFormFactor,
1973
- RentalPropulsionType,
1974
- RentalReturnConstraint,
1975
- ReverseGeocodeData,
1976
- ReverseGeocodeError,
1977
- ReverseGeocodeResponse,
1978
- RiderCategory,
1979
- StepInstruction,
1980
- StopTime,
1981
- StopsData,
1982
- StopsError,
1983
- StopsResponse,
1984
- StoptimesData,
1985
- StoptimesError,
1986
- StoptimesResponse,
1987
- TimeRange,
1988
- Token,
1989
- Transfer,
1990
- TransfersData,
1991
- TransfersError,
1992
- TransfersResponse,
1993
- TripData,
1994
- TripError,
1995
- TripInfo,
1996
- TripResponse,
1997
- TripSegment,
1998
- TripsData,
1999
- TripsError,
2000
- TripsResponse,
2001
- VertexType
2002
- };
1864
+ export type { Alert, AlertCause, AlertEffect, AlertSeverityLevel, Area, Direction, Duration, ElevationCosts, EncodedPolyline, FareMedia, FareMediaType, FareProduct, FareTransfer, FareTransferRule, GeocodeData, GeocodeError, GeocodeResponse, InitialError, InitialResponse, Itinerary, Leg, LevelsData, LevelsError, LevelsResponse, LocationType, Match, Mode, OneToAllData, OneToAllError, OneToAllResponse, OneToManyData, OneToManyError, OneToManyResponse, PedestrianProfile, PickupDropoffType, Place, PlanData, PlanError, PlanResponse, Reachable, ReachablePlace, Rental, RentalFormFactor, RentalPropulsionType, RentalReturnConstraint, ReverseGeocodeData, ReverseGeocodeError, ReverseGeocodeResponse, RiderCategory, StepInstruction, StopTime, StopsData, StopsError, StopsResponse, StoptimesData, StoptimesError, StoptimesResponse, TimeRange, Token, Transfer, TransfersData, TransfersError, TransfersResponse, TripData, TripError, TripInfo, TripResponse, TripSegment, TripsData, TripsError, TripsResponse, VertexType };