@motis-project/motis-client 2.5.0 → 2.7.3
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.
- package/README.md +4 -2
- package/dist/{chunk-5QEG6DOF.js → chunk-47ZS6OWZ.js} +543 -40
- package/dist/{chunk-ZSHHWD3H.js → chunk-FDF4H3WD.js} +7 -0
- package/dist/index.d.ts +3 -3
- package/dist/index.js +22 -2
- package/dist/schemas.gen.d.ts +460 -8
- package/dist/schemas.gen.js +19 -1
- package/dist/services.gen.d.ts +22 -2
- package/dist/services.gen.js +3 -1
- package/dist/types.gen.d.ts +544 -46
- package/package.json +3 -3
- package/dist/chunk-35GMB6DP.js +0 -1232
- package/dist/chunk-7PIP6KRC.js +0 -1300
- package/dist/chunk-7UKCGCXT.js +0 -1247
- package/dist/chunk-CAW6R2LI.js +0 -1285
- package/dist/chunk-EM7IAOVY.js +0 -91
- package/dist/chunk-IHFNO6R3.js +0 -91
- package/dist/chunk-IYBFZNEH.js +0 -1224
- package/dist/chunk-QM2K42W7.js +0 -91
- package/dist/chunk-RM52T2X5.js +0 -1293
- package/dist/chunk-VOTN5CAZ.js +0 -91
- package/dist/chunk-ZBHU6VX2.js +0 -1291
|
@@ -19,6 +19,7 @@ var TimeRangeSchema = {
|
|
|
19
19
|
The interval is considered active at time t if t is greater than or equal to the start time and less than the end time.
|
|
20
20
|
`,
|
|
21
21
|
type: "object",
|
|
22
|
+
required: ["start", "end"],
|
|
22
23
|
properties: {
|
|
23
24
|
start: {
|
|
24
25
|
description: `If missing, the interval starts at minus infinity.
|
|
@@ -185,6 +186,44 @@ var LocationTypeSchema = {
|
|
|
185
186
|
type: "string",
|
|
186
187
|
enum: ["ADDRESS", "PLACE", "STOP"]
|
|
187
188
|
};
|
|
189
|
+
var ModeSchema = {
|
|
190
|
+
description: `# Street modes
|
|
191
|
+
|
|
192
|
+
- \`WALK\`
|
|
193
|
+
- \`BIKE\`
|
|
194
|
+
- \`RENTAL\` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
|
|
195
|
+
- \`CAR\`
|
|
196
|
+
- \`CAR_PARKING\` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
|
|
197
|
+
- \`CAR_DROPOFF\` Experimental. Expect unannounced breaking changes (without version bumps) for all perameters and returned structs.
|
|
198
|
+
- \`ODM\` on-demand taxis from the Prima+\xD6V Project
|
|
199
|
+
- \`RIDE_SHARING\` ride sharing from the Prima+\xD6V Project
|
|
200
|
+
- \`FLEX\` flexible transports
|
|
201
|
+
|
|
202
|
+
# Transit modes
|
|
203
|
+
|
|
204
|
+
- \`TRANSIT\`: translates to \`RAIL,TRAM,BUS,FERRY,AIRPLANE,COACH,CABLE_CAR,FUNICULAR,AREAL_LIFT,OTHER\`
|
|
205
|
+
- \`TRAM\`: trams
|
|
206
|
+
- \`SUBWAY\`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)
|
|
207
|
+
- \`FERRY\`: ferries
|
|
208
|
+
- \`AIRPLANE\`: airline flights
|
|
209
|
+
- \`BUS\`: short distance buses (does not include \`COACH\`)
|
|
210
|
+
- \`COACH\`: long distance buses (does not include \`BUS\`)
|
|
211
|
+
- \`RAIL\`: translates to \`HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL,SUBURBAN,SUBWAY\`
|
|
212
|
+
- \`SUBURBAN\`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)
|
|
213
|
+
- \`HIGHSPEED_RAIL\`: long distance high speed trains (e.g. TGV)
|
|
214
|
+
- \`LONG_DISTANCE\`: long distance inter city trains
|
|
215
|
+
- \`NIGHT_RAIL\`: long distance night trains
|
|
216
|
+
- \`REGIONAL_FAST_RAIL\`: regional express routes that skip low traffic stops to be faster
|
|
217
|
+
- \`REGIONAL_RAIL\`: regional train
|
|
218
|
+
- \`CABLE_CAR\`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).
|
|
219
|
+
- \`FUNICULAR\`: Funicular. Any rail system designed for steep inclines.
|
|
220
|
+
- \`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.
|
|
221
|
+
- \`AREAL_LIFT\`: deprecated
|
|
222
|
+
- \`METRO\`: deprecated
|
|
223
|
+
`,
|
|
224
|
+
type: "string",
|
|
225
|
+
enum: ["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"]
|
|
226
|
+
};
|
|
188
227
|
var MatchSchema = {
|
|
189
228
|
description: "GeoCoding match",
|
|
190
229
|
type: "object",
|
|
@@ -193,6 +232,14 @@ var MatchSchema = {
|
|
|
193
232
|
type: {
|
|
194
233
|
"$ref": "#/components/schemas/LocationType"
|
|
195
234
|
},
|
|
235
|
+
category: {
|
|
236
|
+
description: `Experimental. Type categories might be adjusted.
|
|
237
|
+
|
|
238
|
+
For OSM stop locations: the amenity type based on
|
|
239
|
+
https://wiki.openstreetmap.org/wiki/OpenStreetMap_Carto/Symbols
|
|
240
|
+
`,
|
|
241
|
+
type: "string"
|
|
242
|
+
},
|
|
196
243
|
tokens: {
|
|
197
244
|
description: "list of non-overlapping tokens that were matched",
|
|
198
245
|
type: "array",
|
|
@@ -252,6 +299,17 @@ var MatchSchema = {
|
|
|
252
299
|
score: {
|
|
253
300
|
description: "score according to the internal scoring system (the scoring algorithm might change in the future)",
|
|
254
301
|
type: "number"
|
|
302
|
+
},
|
|
303
|
+
modes: {
|
|
304
|
+
description: "available transport modes for stops",
|
|
305
|
+
type: "array",
|
|
306
|
+
items: {
|
|
307
|
+
"$ref": "#/components/schemas/Mode"
|
|
308
|
+
}
|
|
309
|
+
},
|
|
310
|
+
importance: {
|
|
311
|
+
description: "importance of a stop, normalized from [0, 1]",
|
|
312
|
+
type: "number"
|
|
255
313
|
}
|
|
256
314
|
}
|
|
257
315
|
};
|
|
@@ -279,43 +337,6 @@ var CyclingSpeedSchema = {
|
|
|
279
337
|
description: "Average speed for bike routing in meters per second",
|
|
280
338
|
type: "number"
|
|
281
339
|
};
|
|
282
|
-
var ModeSchema = {
|
|
283
|
-
description: `# Street modes
|
|
284
|
-
|
|
285
|
-
- \`WALK\`
|
|
286
|
-
- \`BIKE\`
|
|
287
|
-
- \`RENTAL\` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
|
|
288
|
-
- \`CAR\`
|
|
289
|
-
- \`CAR_PARKING\` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
|
|
290
|
-
- \`CAR_DROPOFF\` Experimental. Expect unannounced breaking changes (without version bumps) for all perameters and returned structs.
|
|
291
|
-
- \`ODM\` on-demand taxis from the Prima+\xD6V Project
|
|
292
|
-
- \`FLEX\` flexible transports
|
|
293
|
-
|
|
294
|
-
# Transit modes
|
|
295
|
-
|
|
296
|
-
- \`TRANSIT\`: translates to \`RAIL,TRAM,BUS,FERRY,AIRPLANE,COACH,CABLE_CAR,FUNICULAR,AREAL_LIFT,OTHER\`
|
|
297
|
-
- \`TRAM\`: trams
|
|
298
|
-
- \`SUBWAY\`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)
|
|
299
|
-
- \`FERRY\`: ferries
|
|
300
|
-
- \`AIRPLANE\`: airline flights
|
|
301
|
-
- \`BUS\`: short distance buses (does not include \`COACH\`)
|
|
302
|
-
- \`COACH\`: long distance buses (does not include \`BUS\`)
|
|
303
|
-
- \`RAIL\`: translates to \`HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL,SUBURBAN,SUBWAY\`
|
|
304
|
-
- \`SUBURBAN\`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)
|
|
305
|
-
- \`HIGHSPEED_RAIL\`: long distance high speed trains (e.g. TGV)
|
|
306
|
-
- \`LONG_DISTANCE\`: long distance inter city trains
|
|
307
|
-
- \`NIGHT_RAIL\`: long distance night trains
|
|
308
|
-
- \`REGIONAL_FAST_RAIL\`: regional express routes that skip low traffic stops to be faster
|
|
309
|
-
- \`REGIONAL_RAIL\`: regional train
|
|
310
|
-
- \`CABLE_CAR\`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).
|
|
311
|
-
- \`FUNICULAR\`: Funicular. Any rail system designed for steep inclines.
|
|
312
|
-
- \`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.
|
|
313
|
-
- \`AREAL_LIFT\`: deprecated
|
|
314
|
-
- \`METRO\`: deprecated
|
|
315
|
-
`,
|
|
316
|
-
type: "string",
|
|
317
|
-
enum: ["WALK", "BIKE", "RENTAL", "CAR", "CAR_PARKING", "CAR_DROPOFF", "ODM", "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"]
|
|
318
|
-
};
|
|
319
340
|
var VertexTypeSchema = {
|
|
320
341
|
type: "string",
|
|
321
342
|
description: `- \`NORMAL\` - latitude / longitude coordinate or address
|
|
@@ -343,6 +364,14 @@ var PlaceSchema = {
|
|
|
343
364
|
description: "The ID of the stop. This is often something that users don't care about.",
|
|
344
365
|
type: "string"
|
|
345
366
|
},
|
|
367
|
+
parentId: {
|
|
368
|
+
description: "If it's not a root stop, this field contains the `stopId` of the parent stop.",
|
|
369
|
+
type: "string"
|
|
370
|
+
},
|
|
371
|
+
importance: {
|
|
372
|
+
description: "The importance of the stop between 0-1.",
|
|
373
|
+
type: "number"
|
|
374
|
+
},
|
|
346
375
|
lat: {
|
|
347
376
|
description: "latitude",
|
|
348
377
|
type: "number"
|
|
@@ -481,7 +510,7 @@ var ReachableSchema = {
|
|
|
481
510
|
var StopTimeSchema = {
|
|
482
511
|
description: "departure or arrival event at a stop",
|
|
483
512
|
type: "object",
|
|
484
|
-
required: ["place", "mode", "realTime", "headsign", "tripTo", "agencyId", "agencyName", "agencyUrl", "tripId", "routeShortName", "routeLongName", "tripShortName", "displayName", "pickupDropoffType", "cancelled", "tripCancelled", "source"],
|
|
513
|
+
required: ["place", "mode", "realTime", "headsign", "tripTo", "agencyId", "agencyName", "agencyUrl", "tripId", "routeId", "directionId", "routeShortName", "routeLongName", "tripShortName", "displayName", "pickupDropoffType", "cancelled", "tripCancelled", "source"],
|
|
485
514
|
properties: {
|
|
486
515
|
place: {
|
|
487
516
|
"$ref": "#/components/schemas/Place",
|
|
@@ -514,6 +543,12 @@ For non-transit legs, null
|
|
|
514
543
|
agencyUrl: {
|
|
515
544
|
type: "string"
|
|
516
545
|
},
|
|
546
|
+
routeId: {
|
|
547
|
+
type: "string"
|
|
548
|
+
},
|
|
549
|
+
directionId: {
|
|
550
|
+
type: "string"
|
|
551
|
+
},
|
|
517
552
|
routeColor: {
|
|
518
553
|
type: "string"
|
|
519
554
|
},
|
|
@@ -762,8 +797,16 @@ var RentalReturnConstraintSchema = {
|
|
|
762
797
|
var RentalSchema = {
|
|
763
798
|
description: "Vehicle rental",
|
|
764
799
|
type: "object",
|
|
765
|
-
required: ["systemId"],
|
|
800
|
+
required: ["providerId", "providerGroupId", "systemId"],
|
|
766
801
|
properties: {
|
|
802
|
+
providerId: {
|
|
803
|
+
type: "string",
|
|
804
|
+
description: "Rental provider ID"
|
|
805
|
+
},
|
|
806
|
+
providerGroupId: {
|
|
807
|
+
type: "string",
|
|
808
|
+
description: "Rental provider group ID"
|
|
809
|
+
},
|
|
767
810
|
systemId: {
|
|
768
811
|
type: "string",
|
|
769
812
|
description: "Vehicle share system ID"
|
|
@@ -776,6 +819,12 @@ var RentalSchema = {
|
|
|
776
819
|
type: "string",
|
|
777
820
|
description: "URL of the vehicle share system"
|
|
778
821
|
},
|
|
822
|
+
color: {
|
|
823
|
+
type: "string",
|
|
824
|
+
description: `Color associated with this provider, in hexadecimal RGB format
|
|
825
|
+
(e.g. "#FF0000" for red). Can be empty.
|
|
826
|
+
`
|
|
827
|
+
},
|
|
779
828
|
stationName: {
|
|
780
829
|
type: "string",
|
|
781
830
|
description: "Name of the station"
|
|
@@ -811,6 +860,389 @@ var RentalSchema = {
|
|
|
811
860
|
}
|
|
812
861
|
}
|
|
813
862
|
};
|
|
863
|
+
var MultiPolygonSchema = {
|
|
864
|
+
type: "array",
|
|
865
|
+
description: `A multi-polygon contains a number of polygons, each containing a number
|
|
866
|
+
of rings, which are encoded as polylines (with precision 6).
|
|
867
|
+
|
|
868
|
+
For each polygon, the first ring is the outer ring, all subsequent rings
|
|
869
|
+
are inner rings (holes).
|
|
870
|
+
`,
|
|
871
|
+
items: {
|
|
872
|
+
type: "array",
|
|
873
|
+
items: {
|
|
874
|
+
"$ref": "#/components/schemas/EncodedPolyline"
|
|
875
|
+
}
|
|
876
|
+
}
|
|
877
|
+
};
|
|
878
|
+
var RentalZoneRestrictionsSchema = {
|
|
879
|
+
type: "object",
|
|
880
|
+
required: ["vehicleTypeIdxs", "rideStartAllowed", "rideEndAllowed", "rideThroughAllowed"],
|
|
881
|
+
properties: {
|
|
882
|
+
vehicleTypeIdxs: {
|
|
883
|
+
type: "array",
|
|
884
|
+
description: `List of vehicle types (as indices into the provider's vehicle types
|
|
885
|
+
array) to which these restrictions apply.
|
|
886
|
+
If empty, the restrictions apply to all vehicle types of the provider.
|
|
887
|
+
`,
|
|
888
|
+
items: {
|
|
889
|
+
type: "integer"
|
|
890
|
+
}
|
|
891
|
+
},
|
|
892
|
+
rideStartAllowed: {
|
|
893
|
+
type: "boolean",
|
|
894
|
+
description: "whether the ride is allowed to start in this zone"
|
|
895
|
+
},
|
|
896
|
+
rideEndAllowed: {
|
|
897
|
+
type: "boolean",
|
|
898
|
+
description: "whether the ride is allowed to end in this zone"
|
|
899
|
+
},
|
|
900
|
+
rideThroughAllowed: {
|
|
901
|
+
type: "boolean",
|
|
902
|
+
description: "whether the ride is allowed to pass through this zone"
|
|
903
|
+
},
|
|
904
|
+
stationParking: {
|
|
905
|
+
type: "boolean",
|
|
906
|
+
description: "whether vehicles can only be parked at stations in this zone"
|
|
907
|
+
}
|
|
908
|
+
}
|
|
909
|
+
};
|
|
910
|
+
var RentalVehicleTypeSchema = {
|
|
911
|
+
type: "object",
|
|
912
|
+
required: ["id", "formFactor", "propulsionType", "returnConstraint", "returnConstraintGuessed"],
|
|
913
|
+
properties: {
|
|
914
|
+
id: {
|
|
915
|
+
type: "string",
|
|
916
|
+
description: "Unique identifier of the vehicle type (unique within the provider)"
|
|
917
|
+
},
|
|
918
|
+
name: {
|
|
919
|
+
type: "string",
|
|
920
|
+
description: "Public name of the vehicle type (can be empty)"
|
|
921
|
+
},
|
|
922
|
+
formFactor: {
|
|
923
|
+
"$ref": "#/components/schemas/RentalFormFactor"
|
|
924
|
+
},
|
|
925
|
+
propulsionType: {
|
|
926
|
+
"$ref": "#/components/schemas/RentalPropulsionType"
|
|
927
|
+
},
|
|
928
|
+
returnConstraint: {
|
|
929
|
+
"$ref": "#/components/schemas/RentalReturnConstraint"
|
|
930
|
+
},
|
|
931
|
+
returnConstraintGuessed: {
|
|
932
|
+
type: "boolean",
|
|
933
|
+
description: "Whether the return constraint was guessed instead of being specified by the rental provider"
|
|
934
|
+
}
|
|
935
|
+
}
|
|
936
|
+
};
|
|
937
|
+
var RentalProviderSchema = {
|
|
938
|
+
type: "object",
|
|
939
|
+
required: ["id", "name", "groupId", "bbox", "vehicleTypes", "formFactors", "defaultRestrictions", "globalGeofencingRules"],
|
|
940
|
+
properties: {
|
|
941
|
+
id: {
|
|
942
|
+
type: "string",
|
|
943
|
+
description: "Unique identifier of the rental provider"
|
|
944
|
+
},
|
|
945
|
+
name: {
|
|
946
|
+
type: "string",
|
|
947
|
+
description: "Name of the provider to be displayed to customers"
|
|
948
|
+
},
|
|
949
|
+
groupId: {
|
|
950
|
+
type: "string",
|
|
951
|
+
description: "Id of the rental provider group this provider belongs to"
|
|
952
|
+
},
|
|
953
|
+
operator: {
|
|
954
|
+
type: "string",
|
|
955
|
+
description: "Name of the system operator"
|
|
956
|
+
},
|
|
957
|
+
url: {
|
|
958
|
+
type: "string",
|
|
959
|
+
description: "URL of the vehicle share system"
|
|
960
|
+
},
|
|
961
|
+
purchaseUrl: {
|
|
962
|
+
type: "string",
|
|
963
|
+
description: "URL where a customer can purchase a membership"
|
|
964
|
+
},
|
|
965
|
+
color: {
|
|
966
|
+
type: "string",
|
|
967
|
+
description: `Color associated with this provider, in hexadecimal RGB format
|
|
968
|
+
(e.g. "#FF0000" for red). Can be empty.
|
|
969
|
+
`
|
|
970
|
+
},
|
|
971
|
+
bbox: {
|
|
972
|
+
type: "array",
|
|
973
|
+
description: `Bounding box of the area covered by this rental provider,
|
|
974
|
+
[west, south, east, north] as [lon, lat, lon, lat]
|
|
975
|
+
`,
|
|
976
|
+
minItems: 4,
|
|
977
|
+
maxItems: 4,
|
|
978
|
+
items: {
|
|
979
|
+
type: "number"
|
|
980
|
+
}
|
|
981
|
+
},
|
|
982
|
+
vehicleTypes: {
|
|
983
|
+
type: "array",
|
|
984
|
+
items: {
|
|
985
|
+
"$ref": "#/components/schemas/RentalVehicleType"
|
|
986
|
+
}
|
|
987
|
+
},
|
|
988
|
+
formFactors: {
|
|
989
|
+
type: "array",
|
|
990
|
+
description: "List of form factors offered by this provider",
|
|
991
|
+
items: {
|
|
992
|
+
"$ref": "#/components/schemas/RentalFormFactor"
|
|
993
|
+
}
|
|
994
|
+
},
|
|
995
|
+
defaultRestrictions: {
|
|
996
|
+
"$ref": "#/components/schemas/RentalZoneRestrictions"
|
|
997
|
+
},
|
|
998
|
+
globalGeofencingRules: {
|
|
999
|
+
type: "array",
|
|
1000
|
+
items: {
|
|
1001
|
+
"$ref": "#/components/schemas/RentalZoneRestrictions"
|
|
1002
|
+
}
|
|
1003
|
+
}
|
|
1004
|
+
}
|
|
1005
|
+
};
|
|
1006
|
+
var RentalProviderGroupSchema = {
|
|
1007
|
+
type: "object",
|
|
1008
|
+
required: ["id", "name", "providers", "formFactors"],
|
|
1009
|
+
properties: {
|
|
1010
|
+
id: {
|
|
1011
|
+
type: "string",
|
|
1012
|
+
description: "Unique identifier of the rental provider group"
|
|
1013
|
+
},
|
|
1014
|
+
name: {
|
|
1015
|
+
type: "string",
|
|
1016
|
+
description: "Name of the provider group to be displayed to customers"
|
|
1017
|
+
},
|
|
1018
|
+
color: {
|
|
1019
|
+
type: "string",
|
|
1020
|
+
description: `Color associated with this provider group, in hexadecimal RGB format
|
|
1021
|
+
(e.g. "#FF0000" for red). Can be empty.
|
|
1022
|
+
`
|
|
1023
|
+
},
|
|
1024
|
+
providers: {
|
|
1025
|
+
type: "array",
|
|
1026
|
+
description: "List of rental provider IDs that belong to this group",
|
|
1027
|
+
items: {
|
|
1028
|
+
type: "string"
|
|
1029
|
+
}
|
|
1030
|
+
},
|
|
1031
|
+
formFactors: {
|
|
1032
|
+
type: "array",
|
|
1033
|
+
description: "List of form factors offered by this provider group",
|
|
1034
|
+
items: {
|
|
1035
|
+
"$ref": "#/components/schemas/RentalFormFactor"
|
|
1036
|
+
}
|
|
1037
|
+
}
|
|
1038
|
+
}
|
|
1039
|
+
};
|
|
1040
|
+
var RentalStationSchema = {
|
|
1041
|
+
type: "object",
|
|
1042
|
+
required: ["id", "providerId", "providerGroupId", "name", "lat", "lon", "isRenting", "isReturning", "numVehiclesAvailable", "formFactors", "vehicleTypesAvailable", "vehicleDocksAvailable", "bbox"],
|
|
1043
|
+
properties: {
|
|
1044
|
+
id: {
|
|
1045
|
+
type: "string",
|
|
1046
|
+
description: "Unique identifier of the rental station"
|
|
1047
|
+
},
|
|
1048
|
+
providerId: {
|
|
1049
|
+
type: "string",
|
|
1050
|
+
description: "Unique identifier of the rental provider"
|
|
1051
|
+
},
|
|
1052
|
+
providerGroupId: {
|
|
1053
|
+
type: "string",
|
|
1054
|
+
description: "Unique identifier of the rental provider group"
|
|
1055
|
+
},
|
|
1056
|
+
name: {
|
|
1057
|
+
type: "string",
|
|
1058
|
+
description: "Public name of the station"
|
|
1059
|
+
},
|
|
1060
|
+
lat: {
|
|
1061
|
+
description: "latitude",
|
|
1062
|
+
type: "number"
|
|
1063
|
+
},
|
|
1064
|
+
lon: {
|
|
1065
|
+
description: "longitude",
|
|
1066
|
+
type: "number"
|
|
1067
|
+
},
|
|
1068
|
+
address: {
|
|
1069
|
+
type: "string",
|
|
1070
|
+
description: "Address where the station is located"
|
|
1071
|
+
},
|
|
1072
|
+
crossStreet: {
|
|
1073
|
+
type: "string",
|
|
1074
|
+
description: "Cross street or landmark where the station is located"
|
|
1075
|
+
},
|
|
1076
|
+
rentalUriAndroid: {
|
|
1077
|
+
type: "string",
|
|
1078
|
+
description: "Rental URI for Android (deep link to the specific station)"
|
|
1079
|
+
},
|
|
1080
|
+
rentalUriIOS: {
|
|
1081
|
+
type: "string",
|
|
1082
|
+
description: "Rental URI for iOS (deep link to the specific station)"
|
|
1083
|
+
},
|
|
1084
|
+
rentalUriWeb: {
|
|
1085
|
+
type: "string",
|
|
1086
|
+
description: "Rental URI for web (deep link to the specific station)"
|
|
1087
|
+
},
|
|
1088
|
+
isRenting: {
|
|
1089
|
+
type: "boolean",
|
|
1090
|
+
description: "true if vehicles can be rented from this station, false if it is temporarily out of service"
|
|
1091
|
+
},
|
|
1092
|
+
isReturning: {
|
|
1093
|
+
type: "boolean",
|
|
1094
|
+
description: "true if vehicles can be returned to this station, false if it is temporarily out of service"
|
|
1095
|
+
},
|
|
1096
|
+
numVehiclesAvailable: {
|
|
1097
|
+
type: "integer",
|
|
1098
|
+
description: "Number of vehicles available for rental at this station"
|
|
1099
|
+
},
|
|
1100
|
+
formFactors: {
|
|
1101
|
+
type: "array",
|
|
1102
|
+
description: "List of form factors available for rental and/or return at this station",
|
|
1103
|
+
items: {
|
|
1104
|
+
"$ref": "#/components/schemas/RentalFormFactor"
|
|
1105
|
+
}
|
|
1106
|
+
},
|
|
1107
|
+
vehicleTypesAvailable: {
|
|
1108
|
+
type: "object",
|
|
1109
|
+
description: "List of vehicle types currently available at this station (vehicle type ID -> count)",
|
|
1110
|
+
additionalProperties: {
|
|
1111
|
+
type: "integer"
|
|
1112
|
+
}
|
|
1113
|
+
},
|
|
1114
|
+
vehicleDocksAvailable: {
|
|
1115
|
+
type: "object",
|
|
1116
|
+
description: "List of vehicle docks currently available at this station (vehicle type ID -> count)",
|
|
1117
|
+
additionalProperties: {
|
|
1118
|
+
type: "integer"
|
|
1119
|
+
}
|
|
1120
|
+
},
|
|
1121
|
+
stationArea: {
|
|
1122
|
+
"$ref": "#/components/schemas/MultiPolygon"
|
|
1123
|
+
},
|
|
1124
|
+
bbox: {
|
|
1125
|
+
type: "array",
|
|
1126
|
+
description: `Bounding box of the area covered by this station,
|
|
1127
|
+
[west, south, east, north] as [lon, lat, lon, lat]
|
|
1128
|
+
`,
|
|
1129
|
+
minItems: 4,
|
|
1130
|
+
maxItems: 4,
|
|
1131
|
+
items: {
|
|
1132
|
+
type: "number"
|
|
1133
|
+
}
|
|
1134
|
+
}
|
|
1135
|
+
}
|
|
1136
|
+
};
|
|
1137
|
+
var RentalVehicleSchema = {
|
|
1138
|
+
type: "object",
|
|
1139
|
+
required: ["id", "providerId", "providerGroupId", "typeId", "lat", "lon", "formFactor", "propulsionType", "returnConstraint", "isReserved", "isDisabled"],
|
|
1140
|
+
properties: {
|
|
1141
|
+
id: {
|
|
1142
|
+
type: "string",
|
|
1143
|
+
description: "Unique identifier of the rental vehicle"
|
|
1144
|
+
},
|
|
1145
|
+
providerId: {
|
|
1146
|
+
type: "string",
|
|
1147
|
+
description: "Unique identifier of the rental provider"
|
|
1148
|
+
},
|
|
1149
|
+
providerGroupId: {
|
|
1150
|
+
type: "string",
|
|
1151
|
+
description: "Unique identifier of the rental provider group"
|
|
1152
|
+
},
|
|
1153
|
+
typeId: {
|
|
1154
|
+
type: "string",
|
|
1155
|
+
description: "Vehicle type ID (unique within the provider)"
|
|
1156
|
+
},
|
|
1157
|
+
lat: {
|
|
1158
|
+
description: "latitude",
|
|
1159
|
+
type: "number"
|
|
1160
|
+
},
|
|
1161
|
+
lon: {
|
|
1162
|
+
description: "longitude",
|
|
1163
|
+
type: "number"
|
|
1164
|
+
},
|
|
1165
|
+
formFactor: {
|
|
1166
|
+
"$ref": "#/components/schemas/RentalFormFactor"
|
|
1167
|
+
},
|
|
1168
|
+
propulsionType: {
|
|
1169
|
+
"$ref": "#/components/schemas/RentalPropulsionType"
|
|
1170
|
+
},
|
|
1171
|
+
returnConstraint: {
|
|
1172
|
+
"$ref": "#/components/schemas/RentalReturnConstraint"
|
|
1173
|
+
},
|
|
1174
|
+
stationId: {
|
|
1175
|
+
type: "string",
|
|
1176
|
+
description: "Station ID if the vehicle is currently at a station"
|
|
1177
|
+
},
|
|
1178
|
+
homeStationId: {
|
|
1179
|
+
type: "string",
|
|
1180
|
+
description: "Station ID where the vehicle must be returned, if applicable"
|
|
1181
|
+
},
|
|
1182
|
+
isReserved: {
|
|
1183
|
+
type: "boolean",
|
|
1184
|
+
description: "true if the vehicle is currently reserved by a customer, false otherwise"
|
|
1185
|
+
},
|
|
1186
|
+
isDisabled: {
|
|
1187
|
+
type: "boolean",
|
|
1188
|
+
description: "true if the vehicle is out of service, false otherwise"
|
|
1189
|
+
},
|
|
1190
|
+
rentalUriAndroid: {
|
|
1191
|
+
type: "string",
|
|
1192
|
+
description: "Rental URI for Android (deep link to the specific vehicle)"
|
|
1193
|
+
},
|
|
1194
|
+
rentalUriIOS: {
|
|
1195
|
+
type: "string",
|
|
1196
|
+
description: "Rental URI for iOS (deep link to the specific vehicle)"
|
|
1197
|
+
},
|
|
1198
|
+
rentalUriWeb: {
|
|
1199
|
+
type: "string",
|
|
1200
|
+
description: "Rental URI for web (deep link to the specific vehicle)"
|
|
1201
|
+
}
|
|
1202
|
+
}
|
|
1203
|
+
};
|
|
1204
|
+
var RentalZoneSchema = {
|
|
1205
|
+
type: "object",
|
|
1206
|
+
required: ["providerId", "providerGroupId", "z", "bbox", "area", "rules"],
|
|
1207
|
+
properties: {
|
|
1208
|
+
providerId: {
|
|
1209
|
+
type: "string",
|
|
1210
|
+
description: "Unique identifier of the rental provider"
|
|
1211
|
+
},
|
|
1212
|
+
providerGroupId: {
|
|
1213
|
+
type: "string",
|
|
1214
|
+
description: "Unique identifier of the rental provider group"
|
|
1215
|
+
},
|
|
1216
|
+
name: {
|
|
1217
|
+
type: "string",
|
|
1218
|
+
description: "Public name of the geofencing zone"
|
|
1219
|
+
},
|
|
1220
|
+
z: {
|
|
1221
|
+
type: "integer",
|
|
1222
|
+
description: "Zone precedence / z-index (higher number = higher precedence)"
|
|
1223
|
+
},
|
|
1224
|
+
bbox: {
|
|
1225
|
+
type: "array",
|
|
1226
|
+
description: `Bounding box of the area covered by this zone,
|
|
1227
|
+
[west, south, east, north] as [lon, lat, lon, lat]
|
|
1228
|
+
`,
|
|
1229
|
+
minItems: 4,
|
|
1230
|
+
maxItems: 4,
|
|
1231
|
+
items: {
|
|
1232
|
+
type: "number"
|
|
1233
|
+
}
|
|
1234
|
+
},
|
|
1235
|
+
area: {
|
|
1236
|
+
"$ref": "#/components/schemas/MultiPolygon"
|
|
1237
|
+
},
|
|
1238
|
+
rules: {
|
|
1239
|
+
type: "array",
|
|
1240
|
+
items: {
|
|
1241
|
+
"$ref": "#/components/schemas/RentalZoneRestrictions"
|
|
1242
|
+
}
|
|
1243
|
+
}
|
|
1244
|
+
}
|
|
1245
|
+
};
|
|
814
1246
|
var LegSchema = {
|
|
815
1247
|
type: "object",
|
|
816
1248
|
required: ["mode", "startTime", "endTime", "scheduledStartTime", "scheduledEndTime", "realTime", "scheduled", "duration", "from", "to", "legGeometry"],
|
|
@@ -889,6 +1321,12 @@ For non-transit legs, null
|
|
|
889
1321
|
description: "final stop of this trip (can differ from headsign)",
|
|
890
1322
|
"$ref": "#/components/schemas/Place"
|
|
891
1323
|
},
|
|
1324
|
+
routeId: {
|
|
1325
|
+
type: "string"
|
|
1326
|
+
},
|
|
1327
|
+
directionId: {
|
|
1328
|
+
type: "string"
|
|
1329
|
+
},
|
|
892
1330
|
routeColor: {
|
|
893
1331
|
type: "string"
|
|
894
1332
|
},
|
|
@@ -1194,6 +1632,62 @@ transfer duration in minutes for the car profile
|
|
|
1194
1632
|
}
|
|
1195
1633
|
}
|
|
1196
1634
|
};
|
|
1635
|
+
var OneToManyParamsSchema = {
|
|
1636
|
+
type: "object",
|
|
1637
|
+
required: ["one", "many", "mode", "max", "maxMatchingDistance", "elevationCosts", "arriveBy"],
|
|
1638
|
+
properties: {
|
|
1639
|
+
one: {
|
|
1640
|
+
description: "geo location as latitude;longitude",
|
|
1641
|
+
type: "string"
|
|
1642
|
+
},
|
|
1643
|
+
many: {
|
|
1644
|
+
description: "geo locations as latitude;longitude,latitude;longitude,...",
|
|
1645
|
+
type: "array",
|
|
1646
|
+
items: {
|
|
1647
|
+
type: "string"
|
|
1648
|
+
},
|
|
1649
|
+
explode: false
|
|
1650
|
+
},
|
|
1651
|
+
mode: {
|
|
1652
|
+
description: `routing profile to use (currently supported: \`WALK\`, \`BIKE\`, \`CAR\`)
|
|
1653
|
+
`,
|
|
1654
|
+
"$ref": "#/components/schemas/Mode"
|
|
1655
|
+
},
|
|
1656
|
+
max: {
|
|
1657
|
+
description: "maximum travel time in seconds",
|
|
1658
|
+
type: "number"
|
|
1659
|
+
},
|
|
1660
|
+
maxMatchingDistance: {
|
|
1661
|
+
description: "maximum matching distance in meters to match geo coordinates to the street network",
|
|
1662
|
+
type: "number"
|
|
1663
|
+
},
|
|
1664
|
+
elevationCosts: {
|
|
1665
|
+
description: `Optional. Default is \`NONE\`.
|
|
1666
|
+
|
|
1667
|
+
Set an elevation cost profile, to penalize routes with incline.
|
|
1668
|
+
- \`NONE\`: No additional costs for elevations. This is the default behavior
|
|
1669
|
+
- \`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.
|
|
1670
|
+
- \`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.
|
|
1671
|
+
|
|
1672
|
+
As using an elevation costs profile will increase the travel duration,
|
|
1673
|
+
routing through steep terrain may exceed the maximal allowed duration,
|
|
1674
|
+
causing a location to appear unreachable.
|
|
1675
|
+
Increasing the maximum travel time for these segments may resolve this issue.
|
|
1676
|
+
|
|
1677
|
+
Elevation cost profiles are currently used by following street modes:
|
|
1678
|
+
- \`BIKE\`
|
|
1679
|
+
`,
|
|
1680
|
+
"$ref": "#/components/schemas/ElevationCosts",
|
|
1681
|
+
default: "NONE"
|
|
1682
|
+
},
|
|
1683
|
+
arriveBy: {
|
|
1684
|
+
description: `true = many to one
|
|
1685
|
+
false = one to many
|
|
1686
|
+
`,
|
|
1687
|
+
type: "boolean"
|
|
1688
|
+
}
|
|
1689
|
+
}
|
|
1690
|
+
};
|
|
1197
1691
|
var ErrorSchema = {
|
|
1198
1692
|
type: "object",
|
|
1199
1693
|
properties: {
|
|
@@ -1213,12 +1707,12 @@ export {
|
|
|
1213
1707
|
AreaSchema,
|
|
1214
1708
|
TokenSchema,
|
|
1215
1709
|
LocationTypeSchema,
|
|
1710
|
+
ModeSchema,
|
|
1216
1711
|
MatchSchema,
|
|
1217
1712
|
ElevationCostsSchema,
|
|
1218
1713
|
PedestrianProfileSchema,
|
|
1219
1714
|
PedestrianSpeedSchema,
|
|
1220
1715
|
CyclingSpeedSchema,
|
|
1221
|
-
ModeSchema,
|
|
1222
1716
|
VertexTypeSchema,
|
|
1223
1717
|
PickupDropoffTypeSchema,
|
|
1224
1718
|
PlaceSchema,
|
|
@@ -1234,6 +1728,14 @@ export {
|
|
|
1234
1728
|
RentalPropulsionTypeSchema,
|
|
1235
1729
|
RentalReturnConstraintSchema,
|
|
1236
1730
|
RentalSchema,
|
|
1731
|
+
MultiPolygonSchema,
|
|
1732
|
+
RentalZoneRestrictionsSchema,
|
|
1733
|
+
RentalVehicleTypeSchema,
|
|
1734
|
+
RentalProviderSchema,
|
|
1735
|
+
RentalProviderGroupSchema,
|
|
1736
|
+
RentalStationSchema,
|
|
1737
|
+
RentalVehicleSchema,
|
|
1738
|
+
RentalZoneSchema,
|
|
1237
1739
|
LegSchema,
|
|
1238
1740
|
RiderCategorySchema,
|
|
1239
1741
|
FareMediaTypeSchema,
|
|
@@ -1243,5 +1745,6 @@ export {
|
|
|
1243
1745
|
FareTransferSchema,
|
|
1244
1746
|
ItinerarySchema,
|
|
1245
1747
|
TransferSchema,
|
|
1748
|
+
OneToManyParamsSchema,
|
|
1246
1749
|
ErrorSchema
|
|
1247
1750
|
};
|