@motis-project/motis-client 2.1.2 → 2.7.2

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.
@@ -16,6 +16,7 @@ declare const AlertSeverityLevelSchema: {
16
16
  declare const TimeRangeSchema: {
17
17
  readonly description: "A time interval.\nThe interval is considered active at time t if t is greater than or equal to the start time and less than the end time.\n";
18
18
  readonly type: "object";
19
+ readonly required: readonly ["start", "end"];
19
20
  readonly properties: {
20
21
  readonly start: {
21
22
  readonly description: "If missing, the interval starts at minus infinity.\nIf a TimeRange is provided, either start or end must be provided - both fields cannot be empty.\n";
@@ -151,6 +152,11 @@ declare const LocationTypeSchema: {
151
152
  readonly type: "string";
152
153
  readonly enum: readonly ["ADDRESS", "PLACE", "STOP"];
153
154
  };
155
+ declare const ModeSchema: {
156
+ 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 - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).\n - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.\n - `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";
157
+ readonly type: "string";
158
+ 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"];
159
+ };
154
160
  declare const MatchSchema: {
155
161
  readonly description: "GeoCoding match";
156
162
  readonly type: "object";
@@ -159,6 +165,10 @@ declare const MatchSchema: {
159
165
  readonly type: {
160
166
  readonly $ref: "#/components/schemas/LocationType";
161
167
  };
168
+ readonly category: {
169
+ readonly description: "Experimental. Type categories might be adjusted.\n\nFor OSM stop locations: the amenity type based on\nhttps://wiki.openstreetmap.org/wiki/OpenStreetMap_Carto/Symbols\n";
170
+ readonly type: "string";
171
+ };
162
172
  readonly tokens: {
163
173
  readonly description: "list of non-overlapping tokens that were matched";
164
174
  readonly type: "array";
@@ -194,10 +204,18 @@ declare const MatchSchema: {
194
204
  readonly description: "house number";
195
205
  readonly type: "string";
196
206
  };
207
+ readonly country: {
208
+ readonly description: "ISO3166-1 country code from OpenStreetMap";
209
+ readonly type: "string";
210
+ };
197
211
  readonly zip: {
198
212
  readonly description: "zip code";
199
213
  readonly type: "string";
200
214
  };
215
+ readonly tz: {
216
+ readonly description: "timezone name (e.g. \"Europe/Berlin\")";
217
+ readonly type: "string";
218
+ };
201
219
  readonly areas: {
202
220
  readonly description: "list of areas";
203
221
  readonly type: "array";
@@ -209,6 +227,17 @@ declare const MatchSchema: {
209
227
  readonly description: "score according to the internal scoring system (the scoring algorithm might change in the future)";
210
228
  readonly type: "number";
211
229
  };
230
+ readonly modes: {
231
+ readonly description: "available transport modes for stops";
232
+ readonly type: "array";
233
+ readonly items: {
234
+ readonly $ref: "#/components/schemas/Mode";
235
+ };
236
+ };
237
+ readonly importance: {
238
+ readonly description: "importance of a stop, normalized from [0, 1]";
239
+ readonly type: "number";
240
+ };
212
241
  };
213
242
  };
214
243
  declare const ElevationCostsSchema: {
@@ -221,10 +250,13 @@ declare const PedestrianProfileSchema: {
221
250
  readonly type: "string";
222
251
  readonly enum: readonly ["FOOT", "WHEELCHAIR"];
223
252
  };
224
- declare const ModeSchema: {
225
- readonly description: "# Street modes\n\n - `WALK`\n - `BIKE`\n - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `CAR`\n - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.\n - `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 - `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\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,METRO,SUBWAY`\n - `METRO`: metro trains \n - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)\n - `LONG_DISTANCE`: long distance inter city trains\n - `NIGHT_RAIL`: long distance night trains\n - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster\n - `REGIONAL_RAIL`: regional train\n - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).\n - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.\n - `AREAL_LIFT`: Aerial lift, suspended cable car (e.g., gondola lift, aerial tramway). Cable transport where cabins, cars, gondolas or open chairs are suspended by means of one or more cables.\n";
226
- readonly type: "string";
227
- readonly enum: readonly ["WALK", "BIKE", "RENTAL", "CAR", "CAR_PARKING", "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"];
253
+ declare const PedestrianSpeedSchema: {
254
+ readonly description: "Average speed for pedestrian routing in meters per second";
255
+ readonly type: "number";
256
+ };
257
+ declare const CyclingSpeedSchema: {
258
+ readonly description: "Average speed for bike routing in meters per second";
259
+ readonly type: "number";
228
260
  };
229
261
  declare const VertexTypeSchema: {
230
262
  readonly type: "string";
@@ -248,6 +280,10 @@ declare const PlaceSchema: {
248
280
  readonly description: "The ID of the stop. This is often something that users don't care about.";
249
281
  readonly type: "string";
250
282
  };
283
+ readonly importance: {
284
+ readonly description: "The importance of the stop between 0-1.";
285
+ readonly type: "number";
286
+ };
251
287
  readonly lat: {
252
288
  readonly description: "latitude";
253
289
  readonly type: "number";
@@ -260,6 +296,10 @@ declare const PlaceSchema: {
260
296
  readonly description: "level according to OpenStreetMap";
261
297
  readonly type: "number";
262
298
  };
299
+ readonly tz: {
300
+ readonly description: "timezone name (e.g. \"Europe/Berlin\")";
301
+ readonly type: "string";
302
+ };
263
303
  readonly arrival: {
264
304
  readonly description: "arrival time";
265
305
  readonly type: "string";
@@ -372,7 +412,7 @@ declare const ReachableSchema: {
372
412
  declare const StopTimeSchema: {
373
413
  readonly description: "departure or arrival event at a stop";
374
414
  readonly type: "object";
375
- readonly required: readonly ["place", "mode", "realTime", "headsign", "agencyId", "agencyName", "agencyUrl", "tripId", "routeShortName", "pickupDropoffType", "cancelled", "tripCancelled", "source"];
415
+ readonly required: readonly ["place", "mode", "realTime", "headsign", "tripTo", "agencyId", "agencyName", "agencyUrl", "tripId", "routeShortName", "routeLongName", "tripShortName", "displayName", "pickupDropoffType", "cancelled", "tripCancelled", "source"];
376
416
  readonly properties: {
377
417
  readonly place: {
378
418
  readonly $ref: "#/components/schemas/Place";
@@ -387,9 +427,13 @@ declare const StopTimeSchema: {
387
427
  readonly type: "boolean";
388
428
  };
389
429
  readonly headsign: {
390
- readonly description: "For transit legs, the headsign of the bus or train being used.\nFor non-transit legs, null\n";
430
+ readonly description: "The headsign of the bus or train being used.\nFor non-transit legs, null\n";
391
431
  readonly type: "string";
392
432
  };
433
+ readonly tripTo: {
434
+ readonly description: "final stop of this trip";
435
+ readonly $ref: "#/components/schemas/Place";
436
+ };
393
437
  readonly agencyId: {
394
438
  readonly type: "string";
395
439
  };
@@ -408,9 +452,35 @@ declare const StopTimeSchema: {
408
452
  readonly tripId: {
409
453
  readonly type: "string";
410
454
  };
455
+ readonly routeType: {
456
+ readonly type: "integer";
457
+ };
411
458
  readonly routeShortName: {
412
459
  readonly type: "string";
413
460
  };
461
+ readonly routeLongName: {
462
+ readonly type: "string";
463
+ };
464
+ readonly tripShortName: {
465
+ readonly type: "string";
466
+ };
467
+ readonly displayName: {
468
+ readonly type: "string";
469
+ };
470
+ readonly previousStops: {
471
+ readonly type: "array";
472
+ readonly description: "Experimental. Expect unannounced breaking changes (without version bumps).\n\nStops on the trips before this stop. Returned only if `fetchStop` and `arriveBy` are `true`.\n";
473
+ readonly items: {
474
+ readonly $ref: "#/components/schemas/Place";
475
+ };
476
+ };
477
+ readonly nextStops: {
478
+ readonly type: "array";
479
+ readonly description: "Experimental. Expect unannounced breaking changes (without version bumps).\n\nStops on the trips after this stop. Returned only if `fetchStop` is `true` and `arriveBy` is `false`.\n";
480
+ readonly items: {
481
+ readonly $ref: "#/components/schemas/Place";
482
+ };
483
+ };
414
484
  readonly pickupDropoffType: {
415
485
  readonly description: "Type of pickup (for departures) or dropoff (for arrivals), may be disallowed either due to schedule, skipped stops or cancellations";
416
486
  readonly $ref: "#/components/schemas/PickupDropoffType";
@@ -432,14 +502,18 @@ declare const StopTimeSchema: {
432
502
  declare const TripInfoSchema: {
433
503
  readonly description: "trip id and name";
434
504
  readonly type: "object";
435
- readonly required: readonly ["tripId", "routeShortName"];
505
+ readonly required: readonly ["tripId"];
436
506
  readonly properties: {
437
507
  readonly tripId: {
438
508
  readonly description: "trip ID (dataset trip id prefixed with the dataset tag)";
439
509
  readonly type: "string";
440
510
  };
441
511
  readonly routeShortName: {
442
- readonly description: "trip display name";
512
+ readonly description: "trip display name (api version < 4)";
513
+ readonly type: "string";
514
+ };
515
+ readonly displayName: {
516
+ readonly description: "trip display name (api version >= 4)";
443
517
  readonly type: "string";
444
518
  };
445
519
  };
@@ -600,8 +674,16 @@ declare const RentalReturnConstraintSchema: {
600
674
  declare const RentalSchema: {
601
675
  readonly description: "Vehicle rental";
602
676
  readonly type: "object";
603
- readonly required: readonly ["systemId"];
677
+ readonly required: readonly ["providerId", "providerGroupId", "systemId"];
604
678
  readonly properties: {
679
+ readonly providerId: {
680
+ readonly type: "string";
681
+ readonly description: "Rental provider ID";
682
+ };
683
+ readonly providerGroupId: {
684
+ readonly type: "string";
685
+ readonly description: "Rental provider group ID";
686
+ };
605
687
  readonly systemId: {
606
688
  readonly type: "string";
607
689
  readonly description: "Vehicle share system ID";
@@ -614,6 +696,10 @@ declare const RentalSchema: {
614
696
  readonly type: "string";
615
697
  readonly description: "URL of the vehicle share system";
616
698
  };
699
+ readonly color: {
700
+ readonly type: "string";
701
+ readonly description: "Color associated with this provider, in hexadecimal RGB format\n(e.g. \"#FF0000\" for red). Can be empty.\n";
702
+ };
617
703
  readonly stationName: {
618
704
  readonly type: "string";
619
705
  readonly description: "Name of the station";
@@ -649,6 +735,371 @@ declare const RentalSchema: {
649
735
  };
650
736
  };
651
737
  };
738
+ declare const MultiPolygonSchema: {
739
+ readonly type: "array";
740
+ readonly description: "A multi-polygon contains a number of polygons, each containing a number\nof rings, which are encoded as polylines (with precision 6).\n\nFor each polygon, the first ring is the outer ring, all subsequent rings\nare inner rings (holes).\n";
741
+ readonly items: {
742
+ readonly type: "array";
743
+ readonly items: {
744
+ readonly $ref: "#/components/schemas/EncodedPolyline";
745
+ };
746
+ };
747
+ };
748
+ declare const RentalZoneRestrictionsSchema: {
749
+ readonly type: "object";
750
+ readonly required: readonly ["vehicleTypeIdxs", "rideStartAllowed", "rideEndAllowed", "rideThroughAllowed"];
751
+ readonly properties: {
752
+ readonly vehicleTypeIdxs: {
753
+ readonly type: "array";
754
+ readonly description: "List of vehicle types (as indices into the provider's vehicle types\narray) to which these restrictions apply.\nIf empty, the restrictions apply to all vehicle types of the provider.\n";
755
+ readonly items: {
756
+ readonly type: "integer";
757
+ };
758
+ };
759
+ readonly rideStartAllowed: {
760
+ readonly type: "boolean";
761
+ readonly description: "whether the ride is allowed to start in this zone";
762
+ };
763
+ readonly rideEndAllowed: {
764
+ readonly type: "boolean";
765
+ readonly description: "whether the ride is allowed to end in this zone";
766
+ };
767
+ readonly rideThroughAllowed: {
768
+ readonly type: "boolean";
769
+ readonly description: "whether the ride is allowed to pass through this zone";
770
+ };
771
+ readonly stationParking: {
772
+ readonly type: "boolean";
773
+ readonly description: "whether vehicles can only be parked at stations in this zone";
774
+ };
775
+ };
776
+ };
777
+ declare const RentalVehicleTypeSchema: {
778
+ readonly type: "object";
779
+ readonly required: readonly ["id", "formFactor", "propulsionType", "returnConstraint", "returnConstraintGuessed"];
780
+ readonly properties: {
781
+ readonly id: {
782
+ readonly type: "string";
783
+ readonly description: "Unique identifier of the vehicle type (unique within the provider)";
784
+ };
785
+ readonly name: {
786
+ readonly type: "string";
787
+ readonly description: "Public name of the vehicle type (can be empty)";
788
+ };
789
+ readonly formFactor: {
790
+ readonly $ref: "#/components/schemas/RentalFormFactor";
791
+ };
792
+ readonly propulsionType: {
793
+ readonly $ref: "#/components/schemas/RentalPropulsionType";
794
+ };
795
+ readonly returnConstraint: {
796
+ readonly $ref: "#/components/schemas/RentalReturnConstraint";
797
+ };
798
+ readonly returnConstraintGuessed: {
799
+ readonly type: "boolean";
800
+ readonly description: "Whether the return constraint was guessed instead of being specified by the rental provider";
801
+ };
802
+ };
803
+ };
804
+ declare const RentalProviderSchema: {
805
+ readonly type: "object";
806
+ readonly required: readonly ["id", "name", "groupId", "bbox", "vehicleTypes", "formFactors", "defaultRestrictions", "globalGeofencingRules"];
807
+ readonly properties: {
808
+ readonly id: {
809
+ readonly type: "string";
810
+ readonly description: "Unique identifier of the rental provider";
811
+ };
812
+ readonly name: {
813
+ readonly type: "string";
814
+ readonly description: "Name of the provider to be displayed to customers";
815
+ };
816
+ readonly groupId: {
817
+ readonly type: "string";
818
+ readonly description: "Id of the rental provider group this provider belongs to";
819
+ };
820
+ readonly operator: {
821
+ readonly type: "string";
822
+ readonly description: "Name of the system operator";
823
+ };
824
+ readonly url: {
825
+ readonly type: "string";
826
+ readonly description: "URL of the vehicle share system";
827
+ };
828
+ readonly purchaseUrl: {
829
+ readonly type: "string";
830
+ readonly description: "URL where a customer can purchase a membership";
831
+ };
832
+ readonly color: {
833
+ readonly type: "string";
834
+ readonly description: "Color associated with this provider, in hexadecimal RGB format\n(e.g. \"#FF0000\" for red). Can be empty.\n";
835
+ };
836
+ readonly bbox: {
837
+ readonly type: "array";
838
+ readonly description: "Bounding box of the area covered by this rental provider,\n[west, south, east, north] as [lon, lat, lon, lat]\n";
839
+ readonly minItems: 4;
840
+ readonly maxItems: 4;
841
+ readonly items: {
842
+ readonly type: "number";
843
+ };
844
+ };
845
+ readonly vehicleTypes: {
846
+ readonly type: "array";
847
+ readonly items: {
848
+ readonly $ref: "#/components/schemas/RentalVehicleType";
849
+ };
850
+ };
851
+ readonly formFactors: {
852
+ readonly type: "array";
853
+ readonly description: "List of form factors offered by this provider";
854
+ readonly items: {
855
+ readonly $ref: "#/components/schemas/RentalFormFactor";
856
+ };
857
+ };
858
+ readonly defaultRestrictions: {
859
+ readonly $ref: "#/components/schemas/RentalZoneRestrictions";
860
+ };
861
+ readonly globalGeofencingRules: {
862
+ readonly type: "array";
863
+ readonly items: {
864
+ readonly $ref: "#/components/schemas/RentalZoneRestrictions";
865
+ };
866
+ };
867
+ };
868
+ };
869
+ declare const RentalProviderGroupSchema: {
870
+ readonly type: "object";
871
+ readonly required: readonly ["id", "name", "providers", "formFactors"];
872
+ readonly properties: {
873
+ readonly id: {
874
+ readonly type: "string";
875
+ readonly description: "Unique identifier of the rental provider group";
876
+ };
877
+ readonly name: {
878
+ readonly type: "string";
879
+ readonly description: "Name of the provider group to be displayed to customers";
880
+ };
881
+ readonly color: {
882
+ readonly type: "string";
883
+ readonly description: "Color associated with this provider group, in hexadecimal RGB format\n(e.g. \"#FF0000\" for red). Can be empty.\n";
884
+ };
885
+ readonly providers: {
886
+ readonly type: "array";
887
+ readonly description: "List of rental provider IDs that belong to this group";
888
+ readonly items: {
889
+ readonly type: "string";
890
+ };
891
+ };
892
+ readonly formFactors: {
893
+ readonly type: "array";
894
+ readonly description: "List of form factors offered by this provider group";
895
+ readonly items: {
896
+ readonly $ref: "#/components/schemas/RentalFormFactor";
897
+ };
898
+ };
899
+ };
900
+ };
901
+ declare const RentalStationSchema: {
902
+ readonly type: "object";
903
+ readonly required: readonly ["id", "providerId", "providerGroupId", "name", "lat", "lon", "isRenting", "isReturning", "numVehiclesAvailable", "formFactors", "vehicleTypesAvailable", "vehicleDocksAvailable", "bbox"];
904
+ readonly properties: {
905
+ readonly id: {
906
+ readonly type: "string";
907
+ readonly description: "Unique identifier of the rental station";
908
+ };
909
+ readonly providerId: {
910
+ readonly type: "string";
911
+ readonly description: "Unique identifier of the rental provider";
912
+ };
913
+ readonly providerGroupId: {
914
+ readonly type: "string";
915
+ readonly description: "Unique identifier of the rental provider group";
916
+ };
917
+ readonly name: {
918
+ readonly type: "string";
919
+ readonly description: "Public name of the station";
920
+ };
921
+ readonly lat: {
922
+ readonly description: "latitude";
923
+ readonly type: "number";
924
+ };
925
+ readonly lon: {
926
+ readonly description: "longitude";
927
+ readonly type: "number";
928
+ };
929
+ readonly address: {
930
+ readonly type: "string";
931
+ readonly description: "Address where the station is located";
932
+ };
933
+ readonly crossStreet: {
934
+ readonly type: "string";
935
+ readonly description: "Cross street or landmark where the station is located";
936
+ };
937
+ readonly rentalUriAndroid: {
938
+ readonly type: "string";
939
+ readonly description: "Rental URI for Android (deep link to the specific station)";
940
+ };
941
+ readonly rentalUriIOS: {
942
+ readonly type: "string";
943
+ readonly description: "Rental URI for iOS (deep link to the specific station)";
944
+ };
945
+ readonly rentalUriWeb: {
946
+ readonly type: "string";
947
+ readonly description: "Rental URI for web (deep link to the specific station)";
948
+ };
949
+ readonly isRenting: {
950
+ readonly type: "boolean";
951
+ readonly description: "true if vehicles can be rented from this station, false if it is temporarily out of service";
952
+ };
953
+ readonly isReturning: {
954
+ readonly type: "boolean";
955
+ readonly description: "true if vehicles can be returned to this station, false if it is temporarily out of service";
956
+ };
957
+ readonly numVehiclesAvailable: {
958
+ readonly type: "integer";
959
+ readonly description: "Number of vehicles available for rental at this station";
960
+ };
961
+ readonly formFactors: {
962
+ readonly type: "array";
963
+ readonly description: "List of form factors available for rental and/or return at this station";
964
+ readonly items: {
965
+ readonly $ref: "#/components/schemas/RentalFormFactor";
966
+ };
967
+ };
968
+ readonly vehicleTypesAvailable: {
969
+ readonly type: "object";
970
+ readonly description: "List of vehicle types currently available at this station (vehicle type ID -> count)";
971
+ readonly additionalProperties: {
972
+ readonly type: "integer";
973
+ };
974
+ };
975
+ readonly vehicleDocksAvailable: {
976
+ readonly type: "object";
977
+ readonly description: "List of vehicle docks currently available at this station (vehicle type ID -> count)";
978
+ readonly additionalProperties: {
979
+ readonly type: "integer";
980
+ };
981
+ };
982
+ readonly stationArea: {
983
+ readonly $ref: "#/components/schemas/MultiPolygon";
984
+ };
985
+ readonly bbox: {
986
+ readonly type: "array";
987
+ readonly description: "Bounding box of the area covered by this station,\n[west, south, east, north] as [lon, lat, lon, lat]\n";
988
+ readonly minItems: 4;
989
+ readonly maxItems: 4;
990
+ readonly items: {
991
+ readonly type: "number";
992
+ };
993
+ };
994
+ };
995
+ };
996
+ declare const RentalVehicleSchema: {
997
+ readonly type: "object";
998
+ readonly required: readonly ["id", "providerId", "providerGroupId", "typeId", "lat", "lon", "formFactor", "propulsionType", "returnConstraint", "isReserved", "isDisabled"];
999
+ readonly properties: {
1000
+ readonly id: {
1001
+ readonly type: "string";
1002
+ readonly description: "Unique identifier of the rental vehicle";
1003
+ };
1004
+ readonly providerId: {
1005
+ readonly type: "string";
1006
+ readonly description: "Unique identifier of the rental provider";
1007
+ };
1008
+ readonly providerGroupId: {
1009
+ readonly type: "string";
1010
+ readonly description: "Unique identifier of the rental provider group";
1011
+ };
1012
+ readonly typeId: {
1013
+ readonly type: "string";
1014
+ readonly description: "Vehicle type ID (unique within the provider)";
1015
+ };
1016
+ readonly lat: {
1017
+ readonly description: "latitude";
1018
+ readonly type: "number";
1019
+ };
1020
+ readonly lon: {
1021
+ readonly description: "longitude";
1022
+ readonly type: "number";
1023
+ };
1024
+ readonly formFactor: {
1025
+ readonly $ref: "#/components/schemas/RentalFormFactor";
1026
+ };
1027
+ readonly propulsionType: {
1028
+ readonly $ref: "#/components/schemas/RentalPropulsionType";
1029
+ };
1030
+ readonly returnConstraint: {
1031
+ readonly $ref: "#/components/schemas/RentalReturnConstraint";
1032
+ };
1033
+ readonly stationId: {
1034
+ readonly type: "string";
1035
+ readonly description: "Station ID if the vehicle is currently at a station";
1036
+ };
1037
+ readonly homeStationId: {
1038
+ readonly type: "string";
1039
+ readonly description: "Station ID where the vehicle must be returned, if applicable";
1040
+ };
1041
+ readonly isReserved: {
1042
+ readonly type: "boolean";
1043
+ readonly description: "true if the vehicle is currently reserved by a customer, false otherwise";
1044
+ };
1045
+ readonly isDisabled: {
1046
+ readonly type: "boolean";
1047
+ readonly description: "true if the vehicle is out of service, false otherwise";
1048
+ };
1049
+ readonly rentalUriAndroid: {
1050
+ readonly type: "string";
1051
+ readonly description: "Rental URI for Android (deep link to the specific vehicle)";
1052
+ };
1053
+ readonly rentalUriIOS: {
1054
+ readonly type: "string";
1055
+ readonly description: "Rental URI for iOS (deep link to the specific vehicle)";
1056
+ };
1057
+ readonly rentalUriWeb: {
1058
+ readonly type: "string";
1059
+ readonly description: "Rental URI for web (deep link to the specific vehicle)";
1060
+ };
1061
+ };
1062
+ };
1063
+ declare const RentalZoneSchema: {
1064
+ readonly type: "object";
1065
+ readonly required: readonly ["providerId", "providerGroupId", "z", "bbox", "area", "rules"];
1066
+ readonly properties: {
1067
+ readonly providerId: {
1068
+ readonly type: "string";
1069
+ readonly description: "Unique identifier of the rental provider";
1070
+ };
1071
+ readonly providerGroupId: {
1072
+ readonly type: "string";
1073
+ readonly description: "Unique identifier of the rental provider group";
1074
+ };
1075
+ readonly name: {
1076
+ readonly type: "string";
1077
+ readonly description: "Public name of the geofencing zone";
1078
+ };
1079
+ readonly z: {
1080
+ readonly type: "integer";
1081
+ readonly description: "Zone precedence / z-index (higher number = higher precedence)";
1082
+ };
1083
+ readonly bbox: {
1084
+ readonly type: "array";
1085
+ readonly description: "Bounding box of the area covered by this zone,\n[west, south, east, north] as [lon, lat, lon, lat]\n";
1086
+ readonly minItems: 4;
1087
+ readonly maxItems: 4;
1088
+ readonly items: {
1089
+ readonly type: "number";
1090
+ };
1091
+ };
1092
+ readonly area: {
1093
+ readonly $ref: "#/components/schemas/MultiPolygon";
1094
+ };
1095
+ readonly rules: {
1096
+ readonly type: "array";
1097
+ readonly items: {
1098
+ readonly $ref: "#/components/schemas/RentalZoneRestrictions";
1099
+ };
1100
+ };
1101
+ };
1102
+ };
652
1103
  declare const LegSchema: {
653
1104
  readonly type: "object";
654
1105
  readonly required: readonly ["mode", "startTime", "endTime", "scheduledStartTime", "scheduledEndTime", "realTime", "scheduled", "duration", "from", "to", "legGeometry"];
@@ -707,6 +1158,10 @@ declare const LegSchema: {
707
1158
  readonly description: "For transit legs, the headsign of the bus or train being used.\nFor non-transit legs, null\n";
708
1159
  readonly type: "string";
709
1160
  };
1161
+ readonly tripTo: {
1162
+ readonly description: "final stop of this trip (can differ from headsign)";
1163
+ readonly $ref: "#/components/schemas/Place";
1164
+ };
710
1165
  readonly routeColor: {
711
1166
  readonly type: "string";
712
1167
  };
@@ -714,7 +1169,7 @@ declare const LegSchema: {
714
1169
  readonly type: "string";
715
1170
  };
716
1171
  readonly routeType: {
717
- readonly type: "string";
1172
+ readonly type: "integer";
718
1173
  };
719
1174
  readonly agencyName: {
720
1175
  readonly type: "string";
@@ -731,6 +1186,15 @@ declare const LegSchema: {
731
1186
  readonly routeShortName: {
732
1187
  readonly type: "string";
733
1188
  };
1189
+ readonly routeLongName: {
1190
+ readonly type: "string";
1191
+ };
1192
+ readonly tripShortName: {
1193
+ readonly type: "string";
1194
+ };
1195
+ readonly displayName: {
1196
+ readonly type: "string";
1197
+ };
734
1198
  readonly cancelled: {
735
1199
  readonly description: "Whether this trip is cancelled";
736
1200
  readonly type: "boolean";
@@ -951,5 +1415,13 @@ declare const TransferSchema: {
951
1415
  };
952
1416
  };
953
1417
  };
1418
+ declare const ErrorSchema: {
1419
+ readonly type: "object";
1420
+ readonly properties: {
1421
+ readonly error: {
1422
+ readonly type: "string";
1423
+ };
1424
+ };
1425
+ };
954
1426
 
955
- export { AlertCauseSchema, AlertEffectSchema, AlertSchema, AlertSeverityLevelSchema, AreaSchema, DirectionSchema, DurationSchema, ElevationCostsSchema, EncodedPolylineSchema, FareMediaSchema, FareMediaTypeSchema, FareProductSchema, FareTransferRuleSchema, FareTransferSchema, ItinerarySchema, LegSchema, LocationTypeSchema, MatchSchema, ModeSchema, PedestrianProfileSchema, PickupDropoffTypeSchema, PlaceSchema, ReachablePlaceSchema, ReachableSchema, RentalFormFactorSchema, RentalPropulsionTypeSchema, RentalReturnConstraintSchema, RentalSchema, RiderCategorySchema, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema };
1427
+ export { AlertCauseSchema, AlertEffectSchema, AlertSchema, AlertSeverityLevelSchema, AreaSchema, CyclingSpeedSchema, DirectionSchema, DurationSchema, ElevationCostsSchema, EncodedPolylineSchema, ErrorSchema, FareMediaSchema, FareMediaTypeSchema, FareProductSchema, FareTransferRuleSchema, FareTransferSchema, ItinerarySchema, LegSchema, LocationTypeSchema, MatchSchema, ModeSchema, MultiPolygonSchema, PedestrianProfileSchema, PedestrianSpeedSchema, PickupDropoffTypeSchema, PlaceSchema, ReachablePlaceSchema, ReachableSchema, RentalFormFactorSchema, RentalPropulsionTypeSchema, RentalProviderGroupSchema, RentalProviderSchema, RentalReturnConstraintSchema, RentalSchema, RentalStationSchema, RentalVehicleSchema, RentalVehicleTypeSchema, RentalZoneRestrictionsSchema, RentalZoneSchema, RiderCategorySchema, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema };