@motis-project/motis-client 2.8.2 → 2.9.0

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.
@@ -13,6 +13,24 @@ var oneToMany = (options) => {
13
13
  url: "/api/v1/one-to-many"
14
14
  });
15
15
  };
16
+ var oneToManyPost = (options) => {
17
+ return (options?.client ?? client).post({
18
+ ...options,
19
+ url: "/api/v1/one-to-many"
20
+ });
21
+ };
22
+ var oneToManyIntermodal = (options) => {
23
+ return (options?.client ?? client).get({
24
+ ...options,
25
+ url: "/api/experimental/one-to-many-intermodal"
26
+ });
27
+ };
28
+ var oneToManyIntermodalPost = (options) => {
29
+ return (options?.client ?? client).post({
30
+ ...options,
31
+ url: "/api/experimental/one-to-many-intermodal"
32
+ });
33
+ };
16
34
  var oneToAll = (options) => {
17
35
  return (options?.client ?? client).get({
18
36
  ...options,
@@ -67,6 +85,12 @@ var levels = (options) => {
67
85
  url: "/api/v1/map/levels"
68
86
  });
69
87
  };
88
+ var routes = (options) => {
89
+ return (options?.client ?? client).get({
90
+ ...options,
91
+ url: "/api/experimental/map/routes"
92
+ });
93
+ };
70
94
  var rentals = (options) => {
71
95
  return (options?.client ?? client).get({
72
96
  ...options,
@@ -84,6 +108,9 @@ export {
84
108
  client,
85
109
  plan,
86
110
  oneToMany,
111
+ oneToManyPost,
112
+ oneToManyIntermodal,
113
+ oneToManyIntermodalPost,
87
114
  oneToAll,
88
115
  reverseGeocode,
89
116
  geocode,
@@ -93,6 +120,7 @@ export {
93
120
  initial,
94
121
  stops,
95
122
  levels,
123
+ routes,
96
124
  rentals,
97
125
  transfers
98
126
  };
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { AlertCauseSchema, AlertEffectSchema, AlertSchema, AlertSeverityLevelSchema, AreaSchema, CyclingSpeedSchema, DirectionSchema, DurationSchema, ElevationCostsSchema, EncodedPolylineSchema, ErrorSchema, FareMediaSchema, FareMediaTypeSchema, FareProductSchema, FareTransferRuleSchema, FareTransferSchema, ItinerarySchema, LegSchema, LocationTypeSchema, MatchSchema, ModeSchema, MultiPolygonSchema, OneToManyParamsSchema, PedestrianProfileSchema, PedestrianSpeedSchema, PickupDropoffTypeSchema, PlaceSchema, ReachablePlaceSchema, ReachableSchema, RentalFormFactorSchema, RentalPropulsionTypeSchema, RentalProviderGroupSchema, RentalProviderSchema, RentalReturnConstraintSchema, RentalSchema, RentalStationSchema, RentalVehicleSchema, RentalVehicleTypeSchema, RentalZoneRestrictionsSchema, RentalZoneSchema, RiderCategorySchema, ServerConfigSchema, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema } from './schemas.gen.js';
2
- export { client, geocode, initial, levels, oneToAll, oneToMany, plan, rentals, reverseGeocode, stops, stoptimes, transfers, trip, trips } from './services.gen.js';
3
- export { Alert, AlertCause, AlertEffect, AlertSeverityLevel, Area, CyclingSpeed, Direction, Duration, ElevationCosts, EncodedPolyline, Error, FareMedia, FareMediaType, FareProduct, FareTransfer, FareTransferRule, GeocodeData, GeocodeError, GeocodeResponse, InitialError, InitialResponse, Itinerary, Leg, LevelsData, LevelsError, LevelsResponse, LocationType, Match, Mode, MultiPolygon, OneToAllData, OneToAllError, OneToAllResponse, OneToManyData, OneToManyError, OneToManyParams, OneToManyResponse, PedestrianProfile, PedestrianSpeed, PickupDropoffType, Place, PlanData, PlanError, PlanResponse, Reachable, ReachablePlace, Rental, RentalFormFactor, RentalPropulsionType, RentalProvider, RentalProviderGroup, RentalReturnConstraint, RentalStation, RentalVehicle, RentalVehicleType, RentalZone, RentalZoneRestrictions, RentalsData, RentalsError, RentalsResponse, ReverseGeocodeData, ReverseGeocodeError, ReverseGeocodeResponse, RiderCategory, ServerConfig, StepInstruction, StopTime, StopsData, StopsError, StopsResponse, StoptimesData, StoptimesError, StoptimesResponse, TimeRange, Token, Transfer, TransfersData, TransfersError, TransfersResponse, TripData, TripError, TripInfo, TripResponse, TripSegment, TripsData, TripsError, TripsResponse, VertexType } from './types.gen.js';
1
+ export { AlertCauseSchema, AlertEffectSchema, AlertSchema, AlertSeverityLevelSchema, AreaSchema, CategorySchema, CyclingSpeedSchema, DirectionSchema, DurationSchema, ElevationCostsSchema, EncodedPolylineSchema, ErrorSchema, FareMediaSchema, FareMediaTypeSchema, FareProductSchema, FareTransferRuleSchema, FareTransferSchema, ItinerarySchema, LegSchema, LocationTypeSchema, MatchSchema, ModeSchema, MultiPolygonSchema, OneToManyIntermodalParamsSchema, OneToManyIntermodalResponseSchema, OneToManyParamsSchema, ParetoSetEntrySchema, ParetoSetSchema, PedestrianProfileSchema, PedestrianSpeedSchema, PickupDropoffTypeSchema, PlaceSchema, ReachablePlaceSchema, ReachableSchema, RentalFormFactorSchema, RentalPropulsionTypeSchema, RentalProviderGroupSchema, RentalProviderSchema, RentalReturnConstraintSchema, RentalSchema, RentalStationSchema, RentalVehicleSchema, RentalVehicleTypeSchema, RentalZoneRestrictionsSchema, RentalZoneSchema, RiderCategorySchema, RouteColorSchema, RouteInfoSchema, RoutePathSourceSchema, RoutePolylineSchema, RouteSegmentSchema, ServerConfigSchema, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TransitRouteInfoSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema } from './schemas.gen.js';
2
+ export { client, geocode, initial, levels, oneToAll, oneToMany, oneToManyIntermodal, oneToManyIntermodalPost, oneToManyPost, plan, rentals, reverseGeocode, routes, stops, stoptimes, transfers, trip, trips } from './services.gen.js';
3
+ export { Alert, AlertCause, AlertEffect, AlertSeverityLevel, Area, Category, CyclingSpeed, Direction, Duration, ElevationCosts, EncodedPolyline, Error, FareMedia, FareMediaType, FareProduct, FareTransfer, FareTransferRule, GeocodeData, GeocodeError, GeocodeResponse, InitialError, InitialResponse, Itinerary, Leg, LevelsData, LevelsError, LevelsResponse, LocationType, Match, Mode, MultiPolygon, OneToAllData, OneToAllError, OneToAllResponse, OneToManyData, OneToManyError, OneToManyIntermodalData, OneToManyIntermodalError, OneToManyIntermodalParams, OneToManyIntermodalPostData, OneToManyIntermodalPostError, OneToManyIntermodalPostResponse, OneToManyIntermodalResponse, OneToManyIntermodalResponse2, OneToManyParams, OneToManyPostData, OneToManyPostError, OneToManyPostResponse, OneToManyResponse, ParetoSet, ParetoSetEntry, PedestrianProfile, PedestrianSpeed, PickupDropoffType, Place, PlanData, PlanError, PlanResponse, Reachable, ReachablePlace, Rental, RentalFormFactor, RentalPropulsionType, RentalProvider, RentalProviderGroup, RentalReturnConstraint, RentalStation, RentalVehicle, RentalVehicleType, RentalZone, RentalZoneRestrictions, RentalsData, RentalsError, RentalsResponse, ReverseGeocodeData, ReverseGeocodeError, ReverseGeocodeResponse, RiderCategory, RouteColor, RouteInfo, RoutePathSource, RoutePolyline, RouteSegment, RoutesData, RoutesError, RoutesResponse, ServerConfig, StepInstruction, StopTime, StopsData, StopsError, StopsResponse, StoptimesData, StoptimesError, StoptimesResponse, TimeRange, Token, Transfer, TransfersData, TransfersError, TransfersResponse, TransitRouteInfo, TripData, TripError, TripInfo, TripResponse, TripSegment, TripsData, TripsError, TripsResponse, VertexType } from './types.gen.js';
4
4
  import '@hey-api/client-fetch';
package/dist/index.js CHANGED
@@ -4,6 +4,7 @@ import {
4
4
  AlertSchema,
5
5
  AlertSeverityLevelSchema,
6
6
  AreaSchema,
7
+ CategorySchema,
7
8
  CyclingSpeedSchema,
8
9
  DirectionSchema,
9
10
  DurationSchema,
@@ -21,7 +22,11 @@ import {
21
22
  MatchSchema,
22
23
  ModeSchema,
23
24
  MultiPolygonSchema,
25
+ OneToManyIntermodalParamsSchema,
26
+ OneToManyIntermodalResponseSchema,
24
27
  OneToManyParamsSchema,
28
+ ParetoSetEntrySchema,
29
+ ParetoSetSchema,
25
30
  PedestrianProfileSchema,
26
31
  PedestrianSpeedSchema,
27
32
  PickupDropoffTypeSchema,
@@ -40,16 +45,22 @@ import {
40
45
  RentalZoneRestrictionsSchema,
41
46
  RentalZoneSchema,
42
47
  RiderCategorySchema,
48
+ RouteColorSchema,
49
+ RouteInfoSchema,
50
+ RoutePathSourceSchema,
51
+ RoutePolylineSchema,
52
+ RouteSegmentSchema,
43
53
  ServerConfigSchema,
44
54
  StepInstructionSchema,
45
55
  StopTimeSchema,
46
56
  TimeRangeSchema,
47
57
  TokenSchema,
48
58
  TransferSchema,
59
+ TransitRouteInfoSchema,
49
60
  TripInfoSchema,
50
61
  TripSegmentSchema,
51
62
  VertexTypeSchema
52
- } from "./chunk-3462JEGC.js";
63
+ } from "./chunk-4T7SSETL.js";
53
64
  import {
54
65
  client,
55
66
  geocode,
@@ -57,15 +68,19 @@ import {
57
68
  levels,
58
69
  oneToAll,
59
70
  oneToMany,
71
+ oneToManyIntermodal,
72
+ oneToManyIntermodalPost,
73
+ oneToManyPost,
60
74
  plan,
61
75
  rentals,
62
76
  reverseGeocode,
77
+ routes,
63
78
  stops,
64
79
  stoptimes,
65
80
  transfers,
66
81
  trip,
67
82
  trips
68
- } from "./chunk-FDF4H3WD.js";
83
+ } from "./chunk-5NZGXSLW.js";
69
84
  import "./chunk-6DML7NNP.js";
70
85
  export {
71
86
  AlertCauseSchema,
@@ -73,6 +88,7 @@ export {
73
88
  AlertSchema,
74
89
  AlertSeverityLevelSchema,
75
90
  AreaSchema,
91
+ CategorySchema,
76
92
  CyclingSpeedSchema,
77
93
  DirectionSchema,
78
94
  DurationSchema,
@@ -90,7 +106,11 @@ export {
90
106
  MatchSchema,
91
107
  ModeSchema,
92
108
  MultiPolygonSchema,
109
+ OneToManyIntermodalParamsSchema,
110
+ OneToManyIntermodalResponseSchema,
93
111
  OneToManyParamsSchema,
112
+ ParetoSetEntrySchema,
113
+ ParetoSetSchema,
94
114
  PedestrianProfileSchema,
95
115
  PedestrianSpeedSchema,
96
116
  PickupDropoffTypeSchema,
@@ -109,12 +129,18 @@ export {
109
129
  RentalZoneRestrictionsSchema,
110
130
  RentalZoneSchema,
111
131
  RiderCategorySchema,
132
+ RouteColorSchema,
133
+ RouteInfoSchema,
134
+ RoutePathSourceSchema,
135
+ RoutePolylineSchema,
136
+ RouteSegmentSchema,
112
137
  ServerConfigSchema,
113
138
  StepInstructionSchema,
114
139
  StopTimeSchema,
115
140
  TimeRangeSchema,
116
141
  TokenSchema,
117
142
  TransferSchema,
143
+ TransitRouteInfoSchema,
118
144
  TripInfoSchema,
119
145
  TripSegmentSchema,
120
146
  VertexTypeSchema,
@@ -124,9 +150,13 @@ export {
124
150
  levels,
125
151
  oneToAll,
126
152
  oneToMany,
153
+ oneToManyIntermodal,
154
+ oneToManyIntermodalPost,
155
+ oneToManyPost,
127
156
  plan,
128
157
  rentals,
129
158
  reverseGeocode,
159
+ routes,
130
160
  stops,
131
161
  stoptimes,
132
162
  transfers,
@@ -112,6 +112,56 @@ declare const DurationSchema: {
112
112
  readonly duration: {
113
113
  readonly type: "number";
114
114
  readonly description: "duration in seconds if a path was found, otherwise missing";
115
+ readonly minimum: 0;
116
+ };
117
+ readonly distance: {
118
+ readonly type: "number";
119
+ readonly description: "distance in meters if a path was found and distance computation was requested, otherwise missing";
120
+ readonly minimum: 0;
121
+ };
122
+ };
123
+ };
124
+ declare const ParetoSetEntrySchema: {
125
+ readonly description: "Object containing a single element of a ParetoSet";
126
+ readonly type: "object";
127
+ readonly required: readonly ["duration", "transfers"];
128
+ readonly properties: {
129
+ readonly duration: {
130
+ readonly type: "number";
131
+ readonly description: "duration in seconds for the the best solution using `transfer` transfers\n\nNotice that the resolution is currently in minutes, because of implementation details\n";
132
+ readonly minimum: 0;
133
+ };
134
+ readonly transfers: {
135
+ readonly description: "The minimal number of transfers required to arrive within `duration` seconds\n\ntransfers=0: Direct transit connecion without any transfers\ntransfers=1: Transit connection with 1 transfer\n";
136
+ readonly type: "integer";
137
+ readonly minimum: 0;
138
+ };
139
+ };
140
+ };
141
+ declare const ParetoSetSchema: {
142
+ readonly description: "Pareto set of optimal transit solutions";
143
+ readonly type: "array";
144
+ readonly items: {
145
+ readonly $ref: "#/components/schemas/ParetoSetEntry";
146
+ };
147
+ };
148
+ declare const OneToManyIntermodalResponseSchema: {
149
+ readonly description: "Object containing the optimal street and transit durations for One-to-Many routing";
150
+ readonly type: "object";
151
+ readonly properties: {
152
+ readonly street_durations: {
153
+ readonly description: "Fastest durations for street routing\nThe order of the items corresponds to the order of the `many` locations\nIf no street routed connection is found, the corresponding `Duration` will be empty\n";
154
+ readonly type: "array";
155
+ readonly items: {
156
+ readonly $ref: "#/components/schemas/Duration";
157
+ };
158
+ };
159
+ readonly transit_durations: {
160
+ readonly description: "Pareto optimal solutions\nThe order of the items corresponds to the order of the `many` locations\nIf no connection using transits is found, the corresponding `ParetoSet` will be empty\n";
161
+ readonly type: "array";
162
+ readonly items: {
163
+ readonly $ref: "#/components/schemas/ParetoSet";
164
+ };
115
165
  };
116
166
  };
117
167
  };
@@ -157,9 +207,9 @@ declare const LocationTypeSchema: {
157
207
  readonly enum: readonly ["ADDRESS", "PLACE", "STOP"];
158
208
  };
159
209
  declare const ModeSchema: {
160
- readonly description: "# Street modes\n\n - `WALK`\n - `BIKE`\n - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `CAR`\n - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `CAR_DROPOFF` Experimental. Expect unannounced breaking changes (without version bumps) for all perameters and returned structs.\n - `ODM` on-demand taxis from the Prima+ÖV Project\n - `RIDE_SHARING` ride sharing from the Prima+ÖV Project\n - `FLEX` flexible transports\n\n# Transit modes\n\n - `TRANSIT`: translates to `RAIL,TRAM,BUS,FERRY,AIRPLANE,COACH,CABLE_CAR,FUNICULAR,AREAL_LIFT,OTHER`\n - `TRAM`: trams\n - `SUBWAY`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)\n - `FERRY`: ferries\n - `AIRPLANE`: airline flights\n - `BUS`: short distance buses (does not include `COACH`)\n - `COACH`: long distance buses (does not include `BUS`)\n - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL,SUBURBAN,SUBWAY`\n - `SUBURBAN`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)\n - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)\n - `LONG_DISTANCE`: long distance inter city trains\n - `NIGHT_RAIL`: long distance night trains\n - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster\n - `REGIONAL_RAIL`: regional train\n - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.\n - `AERIAL_LIFT`: Aerial lift, suspended cable car (e.g., gondola lift, aerial tramway). Cable transport where cabins, cars, gondolas or open chairs are suspended by means of one or more cables.\n - `ODM`: demand responsive transport\n - `AREAL_LIFT`: deprecated\n - `METRO`: deprecated\n - `CABLE_CAR`: deprecated\n";
210
+ readonly description: "# Street modes\n\n - `WALK`\n - `BIKE`\n - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `CAR`\n - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `CAR_DROPOFF` Experimental. Expect unannounced breaking changes (without version bumps) for all perameters and returned structs.\n - `ODM` on-demand taxis from the Prima+ÖV Project\n - `RIDE_SHARING` ride sharing from the Prima+ÖV Project\n - `FLEX` flexible transports\n\n# Transit modes\n\n - `TRANSIT`: translates to `TRAM,FERRY,AIRPLANE,BUS,COACH,RAIL,ODM,FUNICULAR,AERIAL_LIFT,OTHER`\n - `TRAM`: trams\n - `SUBWAY`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)\n - `FERRY`: ferries\n - `AIRPLANE`: airline flights\n - `BUS`: short distance buses (does not include `COACH`)\n - `COACH`: long distance buses (does not include `BUS`)\n - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,SUBURBAN,SUBWAY`\n - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)\n - `LONG_DISTANCE`: long distance inter city trains\n - `NIGHT_RAIL`: long distance night trains\n - `REGIONAL_FAST_RAIL`: deprecated, `REGIONAL_RAIL` will be used\n - `REGIONAL_RAIL`: regional train\n - `SUBURBAN`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)\n - `ODM`: demand responsive transport\n - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.\n - `AERIAL_LIFT`: Aerial lift, suspended cable car (e.g., gondola lift, aerial tramway). Cable transport where cabins, cars, gondolas or open chairs are suspended by means of one or more cables.\n - `AREAL_LIFT`: deprecated\n - `METRO`: deprecated\n - `CABLE_CAR`: deprecated\n";
161
211
  readonly type: "string";
162
- readonly enum: readonly ["WALK", "BIKE", "RENTAL", "CAR", "CAR_PARKING", "CAR_DROPOFF", "ODM", "RIDE_SHARING", "FLEX", "TRANSIT", "TRAM", "SUBWAY", "FERRY", "AIRPLANE", "SUBURBAN", "BUS", "COACH", "RAIL", "HIGHSPEED_RAIL", "LONG_DISTANCE", "NIGHT_RAIL", "REGIONAL_FAST_RAIL", "REGIONAL_RAIL", "CABLE_CAR", "FUNICULAR", "AERIAL_LIFT", "OTHER", "AREAL_LIFT", "METRO"];
212
+ readonly enum: readonly ["WALK", "BIKE", "RENTAL", "CAR", "CAR_PARKING", "CAR_DROPOFF", "ODM", "RIDE_SHARING", "FLEX", "DEBUG_BUS_ROUTE", "DEBUG_RAILWAY_ROUTE", "DEBUG_FERRY_ROUTE", "TRANSIT", "TRAM", "SUBWAY", "FERRY", "AIRPLANE", "BUS", "COACH", "RAIL", "HIGHSPEED_RAIL", "LONG_DISTANCE", "NIGHT_RAIL", "REGIONAL_FAST_RAIL", "REGIONAL_RAIL", "SUBURBAN", "FUNICULAR", "AERIAL_LIFT", "OTHER", "AREAL_LIFT", "METRO", "CABLE_CAR"];
163
213
  };
164
214
  declare const MatchSchema: {
165
215
  readonly description: "GeoCoding match";
@@ -465,6 +515,9 @@ declare const StopTimeSchema: {
465
515
  readonly routeId: {
466
516
  readonly type: "string";
467
517
  };
518
+ readonly routeUrl: {
519
+ readonly type: "string";
520
+ };
468
521
  readonly directionId: {
469
522
  readonly type: "string";
470
523
  };
@@ -1125,6 +1178,22 @@ declare const RentalZoneSchema: {
1125
1178
  };
1126
1179
  };
1127
1180
  };
1181
+ declare const CategorySchema: {
1182
+ readonly type: "object";
1183
+ readonly required: readonly ["id", "name", "shortName"];
1184
+ readonly description: "not available for GTFS datasets by default\nFor NeTEx it contains information about the vehicle category, e.g. IC/InterCity\n";
1185
+ readonly properties: {
1186
+ readonly id: {
1187
+ readonly type: "string";
1188
+ };
1189
+ readonly name: {
1190
+ readonly type: "string";
1191
+ };
1192
+ readonly shortName: {
1193
+ readonly type: "string";
1194
+ };
1195
+ };
1196
+ };
1128
1197
  declare const LegSchema: {
1129
1198
  readonly type: "object";
1130
1199
  readonly required: readonly ["mode", "startTime", "endTime", "scheduledStartTime", "scheduledEndTime", "realTime", "scheduled", "duration", "from", "to", "legGeometry"];
@@ -1191,9 +1260,15 @@ declare const LegSchema: {
1191
1260
  readonly description: "final stop of this trip (can differ from headsign)";
1192
1261
  readonly $ref: "#/components/schemas/Place";
1193
1262
  };
1263
+ readonly category: {
1264
+ readonly $ref: "#/components/schemas/Category";
1265
+ };
1194
1266
  readonly routeId: {
1195
1267
  readonly type: "string";
1196
1268
  };
1269
+ readonly routeUrl: {
1270
+ readonly type: "string";
1271
+ };
1197
1272
  readonly directionId: {
1198
1273
  readonly type: "string";
1199
1274
  };
@@ -1246,10 +1321,11 @@ declare const LegSchema: {
1246
1321
  };
1247
1322
  };
1248
1323
  readonly legGeometry: {
1324
+ readonly description: "Encoded geometry of the leg.\nIf detailed leg output is disabled, this is returned as an empty\npolyline.\n";
1249
1325
  readonly $ref: "#/components/schemas/EncodedPolyline";
1250
1326
  };
1251
1327
  readonly steps: {
1252
- readonly description: "A series of turn by turn instructions\nused for walking, biking and driving.\n";
1328
+ readonly description: "A series of turn by turn instructions\nused for walking, biking and driving.\nThis field is omitted if the request disables detailed leg output.\n";
1253
1329
  readonly type: "array";
1254
1330
  readonly items: {
1255
1331
  readonly $ref: "#/components/schemas/StepInstruction";
@@ -1456,14 +1532,14 @@ declare const TransferSchema: {
1456
1532
  };
1457
1533
  declare const OneToManyParamsSchema: {
1458
1534
  readonly type: "object";
1459
- readonly required: readonly ["one", "many", "mode", "max", "maxMatchingDistance", "elevationCosts", "arriveBy"];
1535
+ readonly required: readonly ["one", "many", "mode", "max", "maxMatchingDistance", "arriveBy"];
1460
1536
  readonly properties: {
1461
1537
  readonly one: {
1462
1538
  readonly description: "geo location as latitude;longitude";
1463
1539
  readonly type: "string";
1464
1540
  };
1465
1541
  readonly many: {
1466
- readonly description: "geo locations as latitude;longitude,latitude;longitude,...";
1542
+ readonly description: "geo locations as latitude;longitude,latitude;longitude,...\n\nThe number of accepted locations is limited by server config variable `onetomany_max_many`.\n";
1467
1543
  readonly type: "array";
1468
1544
  readonly items: {
1469
1545
  readonly type: "string";
@@ -1475,7 +1551,7 @@ declare const OneToManyParamsSchema: {
1475
1551
  readonly $ref: "#/components/schemas/Mode";
1476
1552
  };
1477
1553
  readonly max: {
1478
- readonly description: "maximum travel time in seconds";
1554
+ readonly description: "maximum travel time in seconds. Is limited by server config variable `street_routing_max_direct_seconds`.";
1479
1555
  readonly type: "number";
1480
1556
  };
1481
1557
  readonly maxMatchingDistance: {
@@ -1491,12 +1567,161 @@ declare const OneToManyParamsSchema: {
1491
1567
  readonly description: "true = many to one\nfalse = one to many\n";
1492
1568
  readonly type: "boolean";
1493
1569
  };
1570
+ readonly withDistance: {
1571
+ readonly description: "If true, the response includes the distance in meters\nfor each path. This requires path reconstruction and\nmay be slower than duration-only queries.\n";
1572
+ readonly type: "boolean";
1573
+ readonly default: false;
1574
+ };
1575
+ };
1576
+ };
1577
+ declare const OneToManyIntermodalParamsSchema: {
1578
+ readonly type: "object";
1579
+ readonly required: readonly ["one", "many"];
1580
+ readonly properties: {
1581
+ readonly one: {
1582
+ readonly description: "`latitude,longitude[,level]` tuple with\n- latitude and longitude in degrees\n- (optional) level: the OSM level (default: 0)\n\nOR\n\nstop id\n";
1583
+ readonly type: "string";
1584
+ };
1585
+ readonly many: {
1586
+ readonly description: "array of:\n\n`latitude,longitude[,level]` tuple with\n- latitude and longitude in degrees\n- (optional) level: the OSM level (default: 0)\n\nOR\n\nstop id\n\nThe number of accepted locations is limited by server config variable `onetomany_max_many`.\n";
1587
+ readonly type: "array";
1588
+ readonly items: {
1589
+ readonly type: "string";
1590
+ };
1591
+ readonly explode: false;
1592
+ };
1593
+ readonly time: {
1594
+ readonly description: "Optional. Defaults to the current time.\n\nDeparture time ($arriveBy=false) / arrival date ($arriveBy=true),\n";
1595
+ readonly type: "string";
1596
+ readonly format: "date-time";
1597
+ };
1598
+ readonly maxTravelTime: {
1599
+ readonly description: "The maximum travel time in minutes.\nIf not provided, the routing uses the value\nhardcoded in the server which is usually quite high.\n\n*Warning*: Use with care. Setting this too low can lead to\noptimal (e.g. the least transfers) journeys not being found.\nIf this value is too low to reach the destination at all,\nit can lead to slow routing performance.\n";
1600
+ readonly type: "integer";
1601
+ };
1602
+ readonly maxMatchingDistance: {
1603
+ readonly description: "maximum matching distance in meters to match geo coordinates to the street network";
1604
+ readonly type: "number";
1605
+ readonly default: 25;
1606
+ };
1607
+ readonly arriveBy: {
1608
+ readonly description: "Optional. Defaults to false, i.e. one to many search\n\ntrue = many to one\nfalse = one to many\n";
1609
+ readonly type: "boolean";
1610
+ readonly default: false;
1611
+ };
1612
+ readonly maxTransfers: {
1613
+ readonly description: "The maximum number of allowed transfers (i.e. interchanges between transit legs,\npre- and postTransit do not count as transfers).\n`maxTransfers=0` searches for direct transit connections without any transfers.\nIf you want to search only for non-transit connections (`FOOT`, `CAR`, etc.),\nsend an empty `transitModes` parameter instead.\n\nIf not provided, the routing uses the server-side default value\nwhich is hardcoded and very high to cover all use cases.\n\n*Warning*: Use with care. Setting this too low can lead to\noptimal (e.g. the fastest) journeys not being found.\nIf this value is too low to reach the destination at all,\nit can lead to slow routing performance.\n";
1614
+ readonly type: "integer";
1615
+ };
1616
+ readonly minTransferTime: {
1617
+ readonly description: "Optional. Default is 0 minutes.\n\nMinimum transfer time for each transfer in minutes.\n";
1618
+ readonly type: "integer";
1619
+ readonly default: 0;
1620
+ };
1621
+ readonly additionalTransferTime: {
1622
+ readonly description: "Optional. Default is 0 minutes.\n\nAdditional transfer time reserved for each transfer in minutes.\n";
1623
+ readonly type: "integer";
1624
+ readonly default: 0;
1625
+ };
1626
+ readonly transferTimeFactor: {
1627
+ readonly description: "Optional. Default is 1.0\n\nFactor to multiply minimum required transfer times with.\nValues smaller than 1.0 are not supported.\n";
1628
+ readonly type: "number";
1629
+ readonly default: 1;
1630
+ };
1631
+ readonly useRoutedTransfers: {
1632
+ readonly description: "Optional. Default is `false`.\n\nWhether to use transfers routed on OpenStreetMap data.\n";
1633
+ readonly type: "boolean";
1634
+ readonly default: false;
1635
+ };
1636
+ readonly pedestrianProfile: {
1637
+ readonly description: "Optional. Default is `FOOT`.\n\nAccessibility profile to use for pedestrian routing in transfers\nbetween transit connections and the first and last mile respectively.\n";
1638
+ readonly $ref: "#/components/schemas/PedestrianProfile";
1639
+ readonly default: "FOOT";
1640
+ };
1641
+ readonly pedestrianSpeed: {
1642
+ readonly description: "Optional\n\nAverage speed for pedestrian routing.\n";
1643
+ readonly $ref: "#/components/schemas/PedestrianSpeed";
1644
+ };
1645
+ readonly cyclingSpeed: {
1646
+ readonly description: "Optional\n\nAverage speed for bike routing.\n";
1647
+ readonly $ref: "#/components/schemas/CyclingSpeed";
1648
+ };
1649
+ readonly elevationCosts: {
1650
+ readonly description: "Optional. Default is `NONE`.\n\nSet an elevation cost profile, to penalize routes with incline.\n- `NONE`: No additional costs for elevations. This is the default behavior\n- `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.\n- `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.\n\nAs using an elevation costs profile will increase the travel duration,\nrouting through steep terrain may exceed the maximal allowed duration,\ncausing a location to appear unreachable.\nIncreasing the maximum travel time for these segments may resolve this issue.\n\nThe profile is used for routing on both the first and last mile.\n\nElevation cost profiles are currently used by following street modes:\n- `BIKE`\n";
1651
+ readonly $ref: "#/components/schemas/ElevationCosts";
1652
+ readonly default: "NONE";
1653
+ };
1654
+ readonly transitModes: {
1655
+ readonly description: "Optional. Default is `TRANSIT` which allows all transit modes (no restriction).\nAllowed modes for the transit part. If empty, no transit connections will be computed.\nFor example, this can be used to allow only `SUBURBAN,SUBWAY,TRAM`.\n";
1656
+ readonly type: "array";
1657
+ readonly items: {
1658
+ readonly $ref: "#/components/schemas/Mode";
1659
+ };
1660
+ readonly default: readonly ["TRANSIT"];
1661
+ readonly explode: false;
1662
+ };
1663
+ readonly preTransitModes: {
1664
+ readonly description: "Optional. Default is `WALK`. Does not apply to direct connections (see `directMode`).\n\nA list of modes that are allowed to be used for the first mile, i.e. from the coordinates to the first transit stop. Example: `WALK,BIKE_SHARING`.\n";
1665
+ readonly type: "array";
1666
+ readonly items: {
1667
+ readonly $ref: "#/components/schemas/Mode";
1668
+ };
1669
+ readonly default: readonly ["WALK"];
1670
+ readonly explode: false;
1671
+ };
1672
+ readonly postTransitModes: {
1673
+ readonly description: "Optional. Default is `WALK`. Does not apply to direct connections (see `directMode`).\n\nA list of modes that are allowed to be used for the last mile, i.e. from the last transit stop to the target coordinates. Example: `WALK,BIKE_SHARING`.\n";
1674
+ readonly type: "array";
1675
+ readonly items: {
1676
+ readonly $ref: "#/components/schemas/Mode";
1677
+ };
1678
+ readonly default: readonly ["WALK"];
1679
+ readonly explode: false;
1680
+ };
1681
+ readonly directMode: {
1682
+ readonly description: "Default is `WALK` which will compute walking routes as direct connections.\n\nMode used for direction connections from start to destination without using transit.\n\nCurrently supported non-transit modes: `WALK`, `BIKE`, `CAR`\n";
1683
+ readonly $ref: "#/components/schemas/Mode";
1684
+ readonly default: "WALK";
1685
+ };
1686
+ readonly maxPreTransitTime: {
1687
+ readonly description: "Optional. Default is 15min which is `900`.\nMaximum time in seconds for the first street leg.\nIs limited by server config variable `street_routing_max_prepost_transit_seconds`.\n";
1688
+ readonly type: "integer";
1689
+ readonly default: 900;
1690
+ readonly minimum: 0;
1691
+ };
1692
+ readonly maxPostTransitTime: {
1693
+ readonly description: "Optional. Default is 15min which is `900`.\nMaximum time in seconds for the last street leg.\nIs limited by server config variable `street_routing_max_prepost_transit_seconds`.\n";
1694
+ readonly type: "integer";
1695
+ readonly default: 900;
1696
+ readonly minimum: 0;
1697
+ };
1698
+ readonly maxDirectTime: {
1699
+ readonly description: "Optional. Default is 30min which is `1800`.\nMaximum time in seconds for direct connections.\n\nIf a value smaller than either `maxPreTransitTime` or\n`maxPostTransitTime` is used, their maximum is set instead.\nIs limited by server config variable `street_routing_max_direct_seconds`.\n";
1700
+ readonly type: "integer";
1701
+ readonly default: 1800;
1702
+ readonly minimum: 0;
1703
+ };
1704
+ readonly withDistance: {
1705
+ readonly description: "If true, the response includes the distance in meters\nfor each path. This requires path reconstruction and\nmay be slower than duration-only queries.\n\n`withDistance` is currently limited to street routing.\n";
1706
+ readonly type: "boolean";
1707
+ readonly default: false;
1708
+ };
1709
+ readonly requireBikeTransport: {
1710
+ readonly description: "Optional. Default is `false`.\n\nIf set to `true`, all used transit trips are required to allow bike carriage.\n";
1711
+ readonly type: "boolean";
1712
+ readonly default: false;
1713
+ };
1714
+ readonly requireCarTransport: {
1715
+ readonly description: "Optional. Default is `false`.\n\nIf set to `true`, all used transit trips are required to allow car carriage.\n";
1716
+ readonly type: "boolean";
1717
+ readonly default: false;
1718
+ };
1494
1719
  };
1495
1720
  };
1496
1721
  declare const ServerConfigSchema: {
1497
1722
  readonly Description: "server configuration";
1498
1723
  readonly type: "object";
1499
- readonly required: readonly ["hasElevation", "hasRoutedTransfers", "hasStreetRouting", "maxTravelTimeLimit", "maxPrePostTransitTimeLimit", "maxDirectTimeLimit"];
1724
+ readonly required: readonly ["hasElevation", "hasRoutedTransfers", "hasStreetRouting", "maxOneToManySize", "maxOneToAllTravelTimeLimit", "maxPrePostTransitTimeLimit", "maxDirectTimeLimit", "shapesDebugEnabled"];
1500
1725
  readonly properties: {
1501
1726
  readonly hasElevation: {
1502
1727
  readonly description: "true if elevation is loaded";
@@ -1510,6 +1735,10 @@ declare const ServerConfigSchema: {
1510
1735
  readonly description: "true if street routing is available";
1511
1736
  readonly type: "boolean";
1512
1737
  };
1738
+ readonly maxOneToManySize: {
1739
+ readonly description: "limit for the number of `many` locations for one-to-many requests\n";
1740
+ readonly type: "number";
1741
+ };
1513
1742
  readonly maxOneToAllTravelTimeLimit: {
1514
1743
  readonly description: "limit for maxTravelTime API param in minutes";
1515
1744
  readonly type: "number";
@@ -1522,6 +1751,10 @@ declare const ServerConfigSchema: {
1522
1751
  readonly description: "limit for maxDirectTime API param in seconds";
1523
1752
  readonly type: "number";
1524
1753
  };
1754
+ readonly shapesDebugEnabled: {
1755
+ readonly description: "true if experimental route shapes debug download API is enabled";
1756
+ readonly type: "boolean";
1757
+ };
1525
1758
  };
1526
1759
  };
1527
1760
  declare const ErrorSchema: {
@@ -1534,5 +1767,118 @@ declare const ErrorSchema: {
1534
1767
  };
1535
1768
  };
1536
1769
  };
1770
+ declare const RouteSegmentSchema: {
1771
+ readonly description: "Route segment between two stops to show a route on a map";
1772
+ readonly type: "object";
1773
+ readonly required: readonly ["from", "to", "polyline"];
1774
+ readonly properties: {
1775
+ readonly from: {
1776
+ readonly type: "integer";
1777
+ readonly description: "Index into the top-level route stops array";
1778
+ };
1779
+ readonly to: {
1780
+ readonly type: "integer";
1781
+ readonly description: "Index into the top-level route stops array";
1782
+ };
1783
+ readonly polyline: {
1784
+ readonly type: "integer";
1785
+ readonly description: "Index into the top-level route polylines array";
1786
+ };
1787
+ };
1788
+ };
1789
+ declare const RoutePolylineSchema: {
1790
+ readonly description: "Shared polyline used by one or more route segments";
1791
+ readonly type: "object";
1792
+ readonly required: readonly ["polyline", "colors", "routeIndexes"];
1793
+ readonly properties: {
1794
+ readonly polyline: {
1795
+ readonly $ref: "#/components/schemas/EncodedPolyline";
1796
+ };
1797
+ readonly colors: {
1798
+ readonly type: "array";
1799
+ readonly description: "Unique route colors of routes containing this segment";
1800
+ readonly items: {
1801
+ readonly type: "string";
1802
+ };
1803
+ };
1804
+ readonly routeIndexes: {
1805
+ readonly type: "array";
1806
+ readonly description: "Indexes into the top-level routes array for routes containing this segment";
1807
+ readonly items: {
1808
+ readonly type: "integer";
1809
+ };
1810
+ };
1811
+ };
1812
+ };
1813
+ declare const RouteColorSchema: {
1814
+ readonly type: "object";
1815
+ readonly required: readonly ["color", "textColor"];
1816
+ readonly properties: {
1817
+ readonly color: {
1818
+ readonly type: "string";
1819
+ };
1820
+ readonly textColor: {
1821
+ readonly type: "string";
1822
+ };
1823
+ };
1824
+ };
1825
+ declare const RoutePathSourceSchema: {
1826
+ readonly type: "string";
1827
+ readonly enum: readonly ["NONE", "TIMETABLE", "ROUTED"];
1828
+ };
1829
+ declare const TransitRouteInfoSchema: {
1830
+ readonly type: "object";
1831
+ readonly required: readonly ["id", "shortName", "longName"];
1832
+ readonly properties: {
1833
+ readonly id: {
1834
+ readonly type: "string";
1835
+ };
1836
+ readonly shortName: {
1837
+ readonly type: "string";
1838
+ };
1839
+ readonly longName: {
1840
+ readonly type: "string";
1841
+ };
1842
+ readonly color: {
1843
+ readonly type: "string";
1844
+ };
1845
+ readonly textColor: {
1846
+ readonly type: "string";
1847
+ };
1848
+ };
1849
+ };
1850
+ declare const RouteInfoSchema: {
1851
+ readonly type: "object";
1852
+ readonly required: readonly ["mode", "transitRoutes", "numStops", "routeIdx", "pathSource", "segments"];
1853
+ readonly properties: {
1854
+ readonly mode: {
1855
+ readonly $ref: "#/components/schemas/Mode";
1856
+ readonly description: "Transport mode for this route";
1857
+ };
1858
+ readonly transitRoutes: {
1859
+ readonly type: "array";
1860
+ readonly items: {
1861
+ readonly $ref: "#/components/schemas/TransitRouteInfo";
1862
+ };
1863
+ };
1864
+ readonly numStops: {
1865
+ readonly type: "integer";
1866
+ readonly description: "Number of stops along this route";
1867
+ };
1868
+ readonly routeIdx: {
1869
+ readonly type: "integer";
1870
+ readonly description: "Internal route index for debugging purposes";
1871
+ };
1872
+ readonly pathSource: {
1873
+ readonly $ref: "#/components/schemas/RoutePathSource";
1874
+ };
1875
+ readonly segments: {
1876
+ readonly type: "array";
1877
+ readonly items: {
1878
+ readonly $ref: "#/components/schemas/RouteSegment";
1879
+ };
1880
+ };
1881
+ };
1882
+ };
1537
1883
 
1538
- export { AlertCauseSchema, AlertEffectSchema, AlertSchema, AlertSeverityLevelSchema, AreaSchema, CyclingSpeedSchema, DirectionSchema, DurationSchema, ElevationCostsSchema, EncodedPolylineSchema, ErrorSchema, FareMediaSchema, FareMediaTypeSchema, FareProductSchema, FareTransferRuleSchema, FareTransferSchema, ItinerarySchema, LegSchema, LocationTypeSchema, MatchSchema, ModeSchema, MultiPolygonSchema, OneToManyParamsSchema, PedestrianProfileSchema, PedestrianSpeedSchema, PickupDropoffTypeSchema, PlaceSchema, ReachablePlaceSchema, ReachableSchema, RentalFormFactorSchema, RentalPropulsionTypeSchema, RentalProviderGroupSchema, RentalProviderSchema, RentalReturnConstraintSchema, RentalSchema, RentalStationSchema, RentalVehicleSchema, RentalVehicleTypeSchema, RentalZoneRestrictionsSchema, RentalZoneSchema, RiderCategorySchema, ServerConfigSchema, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema };
1884
+ export { AlertCauseSchema, AlertEffectSchema, AlertSchema, AlertSeverityLevelSchema, AreaSchema, CategorySchema, CyclingSpeedSchema, DirectionSchema, DurationSchema, ElevationCostsSchema, EncodedPolylineSchema, ErrorSchema, FareMediaSchema, FareMediaTypeSchema, FareProductSchema, FareTransferRuleSchema, FareTransferSchema, ItinerarySchema, LegSchema, LocationTypeSchema, MatchSchema, ModeSchema, MultiPolygonSchema, OneToManyIntermodalParamsSchema, OneToManyIntermodalResponseSchema, OneToManyParamsSchema, ParetoSetEntrySchema, ParetoSetSchema, PedestrianProfileSchema, PedestrianSpeedSchema, PickupDropoffTypeSchema, PlaceSchema, ReachablePlaceSchema, ReachableSchema, RentalFormFactorSchema, RentalPropulsionTypeSchema, RentalProviderGroupSchema, RentalProviderSchema, RentalReturnConstraintSchema, RentalSchema, RentalStationSchema, RentalVehicleSchema, RentalVehicleTypeSchema, RentalZoneRestrictionsSchema, RentalZoneSchema, RiderCategorySchema, RouteColorSchema, RouteInfoSchema, RoutePathSourceSchema, RoutePolylineSchema, RouteSegmentSchema, ServerConfigSchema, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TransitRouteInfoSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema };