@motis-project/motis-client 2.7.5 → 2.8.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.
- package/dist/{chunk-47ZS6OWZ.js → chunk-2KJNFZVR.js} +38 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -1
- package/dist/schemas.gen.d.ts +37 -2
- package/dist/schemas.gen.js +3 -1
- package/dist/services.gen.d.ts +15 -11
- package/dist/types.gen.d.ts +62 -2
- package/package.json +1 -1
|
@@ -42,6 +42,10 @@ var AlertSchema = {
|
|
|
42
42
|
type: "object",
|
|
43
43
|
required: ["headerText", "descriptionText"],
|
|
44
44
|
properties: {
|
|
45
|
+
code: {
|
|
46
|
+
type: "string",
|
|
47
|
+
description: "Attribute or notice code (e.g. for HRDF or NeTEx)"
|
|
48
|
+
},
|
|
45
49
|
communicationPeriod: {
|
|
46
50
|
description: `Time when the alert should be shown to the user.
|
|
47
51
|
If missing, the alert will be shown as long as it appears in the feed.
|
|
@@ -215,11 +219,12 @@ var ModeSchema = {
|
|
|
215
219
|
- \`NIGHT_RAIL\`: long distance night trains
|
|
216
220
|
- \`REGIONAL_FAST_RAIL\`: regional express routes that skip low traffic stops to be faster
|
|
217
221
|
- \`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
222
|
- \`FUNICULAR\`: Funicular. Any rail system designed for steep inclines.
|
|
220
223
|
- \`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.
|
|
224
|
+
- \`ODM\`: demand responsive transport
|
|
221
225
|
- \`AREAL_LIFT\`: deprecated
|
|
222
226
|
- \`METRO\`: deprecated
|
|
227
|
+
- \`CABLE_CAR\`: deprecated
|
|
223
228
|
`,
|
|
224
229
|
type: "string",
|
|
225
230
|
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"]
|
|
@@ -1688,6 +1693,37 @@ false = one to many
|
|
|
1688
1693
|
}
|
|
1689
1694
|
}
|
|
1690
1695
|
};
|
|
1696
|
+
var ServerConfigSchema = {
|
|
1697
|
+
Description: "server configuration",
|
|
1698
|
+
type: "object",
|
|
1699
|
+
required: ["hasElevation", "hasRoutedTransfers", "hasStreetRouting", "maxTravelTimeLimit", "maxPrePostTransitTimeLimit", "maxDirectTimeLimit"],
|
|
1700
|
+
properties: {
|
|
1701
|
+
hasElevation: {
|
|
1702
|
+
description: "true if elevation is loaded",
|
|
1703
|
+
type: "boolean"
|
|
1704
|
+
},
|
|
1705
|
+
hasRoutedTransfers: {
|
|
1706
|
+
description: "true if routed transfers available",
|
|
1707
|
+
type: "boolean"
|
|
1708
|
+
},
|
|
1709
|
+
hasStreetRouting: {
|
|
1710
|
+
description: "true if street routing is available",
|
|
1711
|
+
type: "boolean"
|
|
1712
|
+
},
|
|
1713
|
+
maxOneToAllTravelTimeLimit: {
|
|
1714
|
+
description: "limit for maxTravelTime API param in minutes",
|
|
1715
|
+
type: "number"
|
|
1716
|
+
},
|
|
1717
|
+
maxPrePostTransitTimeLimit: {
|
|
1718
|
+
description: "limit for maxPrePostTransitTime API param in seconds",
|
|
1719
|
+
type: "number"
|
|
1720
|
+
},
|
|
1721
|
+
maxDirectTimeLimit: {
|
|
1722
|
+
description: "limit for maxDirectTime API param in seconds",
|
|
1723
|
+
type: "number"
|
|
1724
|
+
}
|
|
1725
|
+
}
|
|
1726
|
+
};
|
|
1691
1727
|
var ErrorSchema = {
|
|
1692
1728
|
type: "object",
|
|
1693
1729
|
properties: {
|
|
@@ -1746,5 +1782,6 @@ export {
|
|
|
1746
1782
|
ItinerarySchema,
|
|
1747
1783
|
TransferSchema,
|
|
1748
1784
|
OneToManyParamsSchema,
|
|
1785
|
+
ServerConfigSchema,
|
|
1749
1786
|
ErrorSchema
|
|
1750
1787
|
};
|
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, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema } from './schemas.gen.js';
|
|
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
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, 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';
|
|
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';
|
|
4
4
|
import '@hey-api/client-fetch';
|
package/dist/index.js
CHANGED
|
@@ -40,6 +40,7 @@ import {
|
|
|
40
40
|
RentalZoneRestrictionsSchema,
|
|
41
41
|
RentalZoneSchema,
|
|
42
42
|
RiderCategorySchema,
|
|
43
|
+
ServerConfigSchema,
|
|
43
44
|
StepInstructionSchema,
|
|
44
45
|
StopTimeSchema,
|
|
45
46
|
TimeRangeSchema,
|
|
@@ -48,7 +49,7 @@ import {
|
|
|
48
49
|
TripInfoSchema,
|
|
49
50
|
TripSegmentSchema,
|
|
50
51
|
VertexTypeSchema
|
|
51
|
-
} from "./chunk-
|
|
52
|
+
} from "./chunk-2KJNFZVR.js";
|
|
52
53
|
import {
|
|
53
54
|
client,
|
|
54
55
|
geocode,
|
|
@@ -108,6 +109,7 @@ export {
|
|
|
108
109
|
RentalZoneRestrictionsSchema,
|
|
109
110
|
RentalZoneSchema,
|
|
110
111
|
RiderCategorySchema,
|
|
112
|
+
ServerConfigSchema,
|
|
111
113
|
StepInstructionSchema,
|
|
112
114
|
StopTimeSchema,
|
|
113
115
|
TimeRangeSchema,
|
package/dist/schemas.gen.d.ts
CHANGED
|
@@ -35,6 +35,10 @@ declare const AlertSchema: {
|
|
|
35
35
|
readonly type: "object";
|
|
36
36
|
readonly required: readonly ["headerText", "descriptionText"];
|
|
37
37
|
readonly properties: {
|
|
38
|
+
readonly code: {
|
|
39
|
+
readonly type: "string";
|
|
40
|
+
readonly description: "Attribute or notice code (e.g. for HRDF or NeTEx)";
|
|
41
|
+
};
|
|
38
42
|
readonly communicationPeriod: {
|
|
39
43
|
readonly description: "Time when the alert should be shown to the user.\nIf missing, the alert will be shown as long as it appears in the feed.\nIf multiple ranges are given, the alert will be shown during all of them.\n";
|
|
40
44
|
readonly type: "array";
|
|
@@ -153,7 +157,7 @@ declare const LocationTypeSchema: {
|
|
|
153
157
|
readonly enum: readonly ["ADDRESS", "PLACE", "STOP"];
|
|
154
158
|
};
|
|
155
159
|
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 - `
|
|
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";
|
|
157
161
|
readonly type: "string";
|
|
158
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"];
|
|
159
163
|
};
|
|
@@ -1470,6 +1474,37 @@ declare const OneToManyParamsSchema: {
|
|
|
1470
1474
|
};
|
|
1471
1475
|
};
|
|
1472
1476
|
};
|
|
1477
|
+
declare const ServerConfigSchema: {
|
|
1478
|
+
readonly Description: "server configuration";
|
|
1479
|
+
readonly type: "object";
|
|
1480
|
+
readonly required: readonly ["hasElevation", "hasRoutedTransfers", "hasStreetRouting", "maxTravelTimeLimit", "maxPrePostTransitTimeLimit", "maxDirectTimeLimit"];
|
|
1481
|
+
readonly properties: {
|
|
1482
|
+
readonly hasElevation: {
|
|
1483
|
+
readonly description: "true if elevation is loaded";
|
|
1484
|
+
readonly type: "boolean";
|
|
1485
|
+
};
|
|
1486
|
+
readonly hasRoutedTransfers: {
|
|
1487
|
+
readonly description: "true if routed transfers available";
|
|
1488
|
+
readonly type: "boolean";
|
|
1489
|
+
};
|
|
1490
|
+
readonly hasStreetRouting: {
|
|
1491
|
+
readonly description: "true if street routing is available";
|
|
1492
|
+
readonly type: "boolean";
|
|
1493
|
+
};
|
|
1494
|
+
readonly maxOneToAllTravelTimeLimit: {
|
|
1495
|
+
readonly description: "limit for maxTravelTime API param in minutes";
|
|
1496
|
+
readonly type: "number";
|
|
1497
|
+
};
|
|
1498
|
+
readonly maxPrePostTransitTimeLimit: {
|
|
1499
|
+
readonly description: "limit for maxPrePostTransitTime API param in seconds";
|
|
1500
|
+
readonly type: "number";
|
|
1501
|
+
};
|
|
1502
|
+
readonly maxDirectTimeLimit: {
|
|
1503
|
+
readonly description: "limit for maxDirectTime API param in seconds";
|
|
1504
|
+
readonly type: "number";
|
|
1505
|
+
};
|
|
1506
|
+
};
|
|
1507
|
+
};
|
|
1473
1508
|
declare const ErrorSchema: {
|
|
1474
1509
|
readonly type: "object";
|
|
1475
1510
|
readonly properties: {
|
|
@@ -1479,4 +1514,4 @@ declare const ErrorSchema: {
|
|
|
1479
1514
|
};
|
|
1480
1515
|
};
|
|
1481
1516
|
|
|
1482
|
-
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, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema };
|
|
1517
|
+
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 };
|
package/dist/schemas.gen.js
CHANGED
|
@@ -40,6 +40,7 @@ import {
|
|
|
40
40
|
RentalZoneRestrictionsSchema,
|
|
41
41
|
RentalZoneSchema,
|
|
42
42
|
RiderCategorySchema,
|
|
43
|
+
ServerConfigSchema,
|
|
43
44
|
StepInstructionSchema,
|
|
44
45
|
StopTimeSchema,
|
|
45
46
|
TimeRangeSchema,
|
|
@@ -48,7 +49,7 @@ import {
|
|
|
48
49
|
TripInfoSchema,
|
|
49
50
|
TripSegmentSchema,
|
|
50
51
|
VertexTypeSchema
|
|
51
|
-
} from "./chunk-
|
|
52
|
+
} from "./chunk-2KJNFZVR.js";
|
|
52
53
|
export {
|
|
53
54
|
AlertCauseSchema,
|
|
54
55
|
AlertEffectSchema,
|
|
@@ -91,6 +92,7 @@ export {
|
|
|
91
92
|
RentalZoneRestrictionsSchema,
|
|
92
93
|
RentalZoneSchema,
|
|
93
94
|
RiderCategorySchema,
|
|
95
|
+
ServerConfigSchema,
|
|
94
96
|
StepInstructionSchema,
|
|
95
97
|
StopTimeSchema,
|
|
96
98
|
TimeRangeSchema,
|
package/dist/services.gen.d.ts
CHANGED
|
@@ -61,19 +61,23 @@ declare const levels: <ThrowOnError extends boolean = false>(options: Options<Le
|
|
|
61
61
|
* Get a list of rental providers or all rental stations and vehicles for
|
|
62
62
|
* a map section or provider
|
|
63
63
|
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
64
|
+
* Various options to filter the providers, stations and vehicles are
|
|
65
|
+
* available. If none of these filters are provided, a list of all
|
|
66
|
+
* available rental providers is returned without any station, vehicle or
|
|
67
|
+
* zone data.
|
|
68
|
+
*
|
|
69
|
+
* At least one of the following filters must be provided to retrieve
|
|
70
|
+
* station, vehicle and zone data:
|
|
69
71
|
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
72
|
+
* - A bounding box defined by the `min` and `max` parameters
|
|
73
|
+
* - A circle defined by the `point` and `radius` parameters
|
|
74
|
+
* - A list of provider groups via the `providerGroups` parameter
|
|
75
|
+
* - A list of providers via the `providers` parameter
|
|
73
76
|
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
+
* Only data that matches all the provided filters is returned.
|
|
78
|
+
*
|
|
79
|
+
* Provide the `withProviders=false` parameter to retrieve only provider
|
|
80
|
+
* groups if detailed feed information is not required.
|
|
77
81
|
*
|
|
78
82
|
*/
|
|
79
83
|
declare const rentals: <ThrowOnError extends boolean = false>(options?: Options<RentalsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RentalsResponse, Error, ThrowOnError>;
|
package/dist/types.gen.d.ts
CHANGED
|
@@ -33,6 +33,10 @@ type TimeRange = {
|
|
|
33
33
|
* An alert, indicating some sort of incident in the public transit network.
|
|
34
34
|
*/
|
|
35
35
|
type Alert = {
|
|
36
|
+
/**
|
|
37
|
+
* Attribute or notice code (e.g. for HRDF or NeTEx)
|
|
38
|
+
*/
|
|
39
|
+
code?: string;
|
|
36
40
|
/**
|
|
37
41
|
* Time when the alert should be shown to the user.
|
|
38
42
|
* If missing, the alert will be shown as long as it appears in the feed.
|
|
@@ -189,11 +193,12 @@ type LocationType = 'ADDRESS' | 'PLACE' | 'STOP';
|
|
|
189
193
|
* - `NIGHT_RAIL`: long distance night trains
|
|
190
194
|
* - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster
|
|
191
195
|
* - `REGIONAL_RAIL`: regional train
|
|
192
|
-
* - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).
|
|
193
196
|
* - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.
|
|
194
197
|
* - `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.
|
|
198
|
+
* - `ODM`: demand responsive transport
|
|
195
199
|
* - `AREAL_LIFT`: deprecated
|
|
196
200
|
* - `METRO`: deprecated
|
|
201
|
+
* - `CABLE_CAR`: deprecated
|
|
197
202
|
*
|
|
198
203
|
*/
|
|
199
204
|
type Mode = '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';
|
|
@@ -1339,6 +1344,32 @@ type OneToManyParams = {
|
|
|
1339
1344
|
*/
|
|
1340
1345
|
arriveBy: boolean;
|
|
1341
1346
|
};
|
|
1347
|
+
type ServerConfig = {
|
|
1348
|
+
/**
|
|
1349
|
+
* true if elevation is loaded
|
|
1350
|
+
*/
|
|
1351
|
+
hasElevation: boolean;
|
|
1352
|
+
/**
|
|
1353
|
+
* true if routed transfers available
|
|
1354
|
+
*/
|
|
1355
|
+
hasRoutedTransfers: boolean;
|
|
1356
|
+
/**
|
|
1357
|
+
* true if street routing is available
|
|
1358
|
+
*/
|
|
1359
|
+
hasStreetRouting: boolean;
|
|
1360
|
+
/**
|
|
1361
|
+
* limit for maxTravelTime API param in minutes
|
|
1362
|
+
*/
|
|
1363
|
+
maxOneToAllTravelTimeLimit?: number;
|
|
1364
|
+
/**
|
|
1365
|
+
* limit for maxPrePostTransitTime API param in seconds
|
|
1366
|
+
*/
|
|
1367
|
+
maxPrePostTransitTimeLimit: number;
|
|
1368
|
+
/**
|
|
1369
|
+
* limit for maxDirectTime API param in seconds
|
|
1370
|
+
*/
|
|
1371
|
+
maxDirectTimeLimit: number;
|
|
1372
|
+
};
|
|
1342
1373
|
type Error = {
|
|
1343
1374
|
error?: string;
|
|
1344
1375
|
};
|
|
@@ -2355,6 +2386,12 @@ type TripsData = {
|
|
|
2355
2386
|
* end if the time window
|
|
2356
2387
|
*/
|
|
2357
2388
|
endTime: string;
|
|
2389
|
+
/**
|
|
2390
|
+
* language tags as used in OpenStreetMap / GTFS
|
|
2391
|
+
* (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
|
|
2392
|
+
*
|
|
2393
|
+
*/
|
|
2394
|
+
language?: Array<(string)>;
|
|
2358
2395
|
/**
|
|
2359
2396
|
* latitude,longitude pair of the upper left coordinate
|
|
2360
2397
|
*/
|
|
@@ -2388,10 +2425,17 @@ type InitialResponse = ({
|
|
|
2388
2425
|
* zoom level
|
|
2389
2426
|
*/
|
|
2390
2427
|
zoom: number;
|
|
2428
|
+
serverConfig?: ServerConfig;
|
|
2391
2429
|
});
|
|
2392
2430
|
type InitialError = (Error);
|
|
2393
2431
|
type StopsData = {
|
|
2394
2432
|
query: {
|
|
2433
|
+
/**
|
|
2434
|
+
* language tags as used in OpenStreetMap / GTFS
|
|
2435
|
+
* (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
|
|
2436
|
+
*
|
|
2437
|
+
*/
|
|
2438
|
+
language?: Array<(string)>;
|
|
2395
2439
|
/**
|
|
2396
2440
|
* latitude,longitude pair of the upper left coordinate
|
|
2397
2441
|
*/
|
|
@@ -2428,6 +2472,17 @@ type RentalsData = {
|
|
|
2428
2472
|
* latitude,longitude pair of the lower right coordinate
|
|
2429
2473
|
*/
|
|
2430
2474
|
min?: string;
|
|
2475
|
+
/**
|
|
2476
|
+
* \`latitude,longitude[,level]\` tuple with
|
|
2477
|
+
* - latitude and longitude in degrees
|
|
2478
|
+
* - (optional) level: the OSM level (ignored, for compatibility reasons)
|
|
2479
|
+
*
|
|
2480
|
+
* OR
|
|
2481
|
+
*
|
|
2482
|
+
* stop id
|
|
2483
|
+
*
|
|
2484
|
+
*/
|
|
2485
|
+
point?: string;
|
|
2431
2486
|
/**
|
|
2432
2487
|
* A list of rental provider groups to return.
|
|
2433
2488
|
* If both `providerGroups` and `providers` are empty/not specified,
|
|
@@ -2442,6 +2497,11 @@ type RentalsData = {
|
|
|
2442
2497
|
*
|
|
2443
2498
|
*/
|
|
2444
2499
|
providers?: Array<(string)>;
|
|
2500
|
+
/**
|
|
2501
|
+
* Radius around `point` in meters.
|
|
2502
|
+
*
|
|
2503
|
+
*/
|
|
2504
|
+
radius?: number;
|
|
2445
2505
|
/**
|
|
2446
2506
|
* Optional. Include providers in output. If false, only provider
|
|
2447
2507
|
* groups are returned.
|
|
@@ -2503,4 +2563,4 @@ type TransfersResponse = ({
|
|
|
2503
2563
|
});
|
|
2504
2564
|
type TransfersError = unknown;
|
|
2505
2565
|
|
|
2506
|
-
export type { 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, StepInstruction, StopTime, StopsData, StopsError, StopsResponse, StoptimesData, StoptimesError, StoptimesResponse, TimeRange, Token, Transfer, TransfersData, TransfersError, TransfersResponse, TripData, TripError, TripInfo, TripResponse, TripSegment, TripsData, TripsError, TripsResponse, VertexType };
|
|
2566
|
+
export type { 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 };
|