@motis-project/motis-client 2.9.2 → 2.10.2

package/dist/types.gen.d.ts

@@ -1,7 +1,7 @@
 /**
  * Cause of this alert.
  */
-type AlertCause = 'UNKNOWN_CAUSE' | 'OTHER_CAUSE' | 'TECHNICAL_PROBLEM' | 'STRIKE' | 'DEMONSTRATION' | 'ACCIDENT' | 'HOLIDAY' | 'WEATHER' | 'MAINTENANCE' | 'CONSTRUCTION' | 'POLICE_ACTIVITY' | 'MEDICAL_EMERGENCY';
+type AlertCause = 'UNKNOWN_CAUSE' | 'OTHER_CAUSE' | 'TECHNICAL_PROBLEM' | 'STRIKE' | 'DEMONSTRATION' | 'ACCIDENT' | 'HOLIDAY' | 'WEATHER' | 'MAINTENANCE' | 'CONSTRUCTION' | 'POLICE_ACTIVITY' | 'MEDICAL_EMERGENCY' | 'SPECIAL_EVENT';
 /**
  * The effect of this problem on the affected entity.
  */
@@ -226,7 +226,7 @@ type LocationType = 'ADDRESS' | 'PLACE' | 'STOP';
  *
  * # Transit modes
  *
- * - `TRANSIT`: translates to `TRAM,FERRY,AIRPLANE,BUS,COACH,RAIL,ODM,FUNICULAR,AERIAL_LIFT,OTHER`
+ * - `TRANSIT`: translates to `TRAM,FERRY,AIRPLANE,BUS,COACH,RAIL,ODM,RIDE_SHARING,FUNICULAR,AERIAL_LIFT,OTHER`
  * - `TRAM`: trams
  * - `SUBWAY`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)
  * - `FERRY`: ferries
@@ -241,6 +241,7 @@ type LocationType = 'ADDRESS' | 'PLACE' | 'STOP';
  * - `REGIONAL_RAIL`: regional train
  * - `SUBURBAN`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)
  * - `ODM`: demand responsive transport
+ * - `RIDE_SHARING`: ride sharing
  * - `FUNICULAR`: Funicular. Any rail system designed for steep inclines.
  * - `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.
  * - `AREAL_LIFT`: deprecated
@@ -387,8 +388,13 @@ type Place = {
     lon: number;
     /**
      * level according to OpenStreetMap
+     * If no level is given, the field will be unset.
+     *
+     * For older versions (v1-v5), this field is mandatory and therefore set to 0.
+     * Affected endpoints: plan, trip, stoptimes, one-to-all, map/stops, map/trips
+     *
      */
-    level: number;
+    level?: number;
     /**
      * timezone name (e.g. "Europe/Berlin")
      */
@@ -419,6 +425,13 @@ type Place = {
      *
      */
     track?: string;
+    /**
+     * Short, abbreviated identifier of the stop intended for users
+     * (e.g. printed on signage, used in SMS / passenger info systems).
+     * Comes from the GTFS `stop_code` field.
+     *
+     */
+    stopCode?: string;
     /**
      * description of the location that provides more detailed information
      */
@@ -710,6 +723,7 @@ type StepInstruction = {
      */
     elevationDown?: number;
 };
+type WheelchairAccessibility = 'ACCESSIBLE' | 'NOT_ACCESSIBLE';
 type RentalFormFactor = 'BICYCLE' | 'CARGO_BICYCLE' | 'CAR' | 'MOPED' | 'SCOOTER_STANDING' | 'SCOOTER_SEATED' | 'OTHER';
 type RentalPropulsionType = 'HUMAN' | 'ELECTRIC_ASSIST' | 'ELECTRIC' | 'COMBUSTION' | 'COMBUSTION_DIESEL' | 'HYBRID' | 'PLUG_IN_HYBRID' | 'HYDROGEN_FUEL_CELL';
 type RentalReturnConstraint = 'NONE' | 'ANY_STATION' | 'ROUNDTRIP_STATION';
@@ -1223,6 +1237,34 @@ type Leg = {
      *
      */
     bikesAllowed?: boolean;
+    /**
+     * Whether wheelchairs can be transported on this leg.
+     *
+     */
+    wheelchairAccessible?: WheelchairAccessibility;
+    /**
+     * Alternative connections that can replace this transit leg.
+     * Each alternative is normally a sequence of 3 legs:
+     * `[ingress footpath, transit, egress footpath]`.
+     * Only populated when the request sets `numLegAlternatives` > 0
+     * (capped to that value).
+     *
+     * Interlined legs:
+     * `alternatives` is populated only on the first (main) leg of
+     * an interlined chain. Subsequent interlined legs (carrying
+     * `interlineWithPreviousLeg=true`) leave `alternatives` unset.
+     * Alternatives are valid for the whole interlined segment.
+     *
+     * An alternative may itself cover an interlined segment:
+     * the alternative's middle transit then expands into multiple
+     * interlined legs when `joinInterlinedLegs=false`. In that
+     * case the alternative contains more than 3 legs: ingress
+     * footpath, followed by N interlined transit legs (the
+     * secondary ones carrying `interlineWithPreviousLeg=true`),
+     * followed by an egress footpath.
+     *
+     */
+    alternatives?: Array<Array<Leg>>;
 };
 type RiderCategory = {
     /**
@@ -1307,6 +1349,77 @@ type FareTransfer = {
      */
     effectiveFareLegProducts: Array<Array<Array<FareProduct>>>;
 };
+type LegId = {
+    displayName: string;
+    tripId: string;
+    /**
+     * from stop stopId
+     */
+    fromId: string;
+    /**
+     * latitude of the leg's from endpoint
+     */
+    fromLat: number;
+    /**
+     * longitude of the leg's from endpoint
+     */
+    fromLon: number;
+    /**
+     * Optional level (floor) of the leg's from endpoint for indoor routing.
+     */
+    fromLevel?: number;
+    /**
+     * to stop stopId
+     */
+    toId: string;
+    /**
+     * latitude of the leg's to endpoint
+     */
+    toLat: number;
+    /**
+     * longitude of the leg's to endpoint
+     */
+    toLon: number;
+    /**
+     * Optional level (floor) of the leg's to endpoint for indoor routing.
+     */
+    toLevel?: number;
+    /**
+     * Scheduled departure time as a Unix timestamp in seconds.
+     */
+    schedStart: number;
+    /**
+     * Scheduled arrival time as a Unix timestamp in seconds.
+     */
+    schedEnd: number;
+    mode: Mode;
+    scheduled: boolean;
+};
+type ItineraryId = {
+    legs: Array<LegId>;
+};
+/**
+ * Body for the `refreshItineraryPost` endpoint. All fields mirror the
+ * parameters of the `plan` endpoint - see the `plan` endpoint for their
+ * descriptions.
+ *
+ */
+type RefreshItineraryPostBody = {
+    id: ItineraryId;
+    requireDisplayNameMatch?: boolean;
+    joinInterlinedLegs?: boolean;
+    detailedTransfers?: boolean;
+    detailedLegs?: boolean;
+    withFares?: boolean;
+    withScheduledSkippedStops?: boolean;
+    numLegAlternatives?: number;
+    transitModes?: Array<Mode>;
+    pedestrianProfile?: PedestrianProfile;
+    useRoutedTransfers?: boolean;
+    requireBikeTransport?: boolean;
+    requireCarTransport?: boolean;
+    language?: Array<(string)>;
+};
 type Itinerary = {
     /**
      * journey duration in seconds
@@ -1324,6 +1437,12 @@ type Itinerary = {
      * The number of transfers this trip has.
      */
     transfers: number;
+    /**
+     * Experimental (format might change). Opaque itinerary identifier.
+     * Pass it as `itineraryId` to `refresh-itinerary` endpoint for reconstruction using the new schedule/realtime data.
+     *
+     */
+    id: string;
     /**
      * Journey legs
      */
@@ -1767,6 +1886,16 @@ type RouteInfo = {
     pathSource: RoutePathSource;
     segments: Array<RouteSegment>;
 };
+type HealthResponse = {
+    /**
+     * GTFSRT, SIRI Lite, VDV AUS, VDV454 feeds.
+     */
+    rt?: boolean;
+    /**
+     * GBFS feeds.
+     */
+    gbfs?: boolean;
+};
 type PlanData = {
     query: {
         /**
@@ -2059,6 +2188,18 @@ type PlanData = {
          *
          */
         numItineraries?: number;
+        /**
+         * Optional. Maximum number of alternatives to return per transit
+         * leg. `0` disables alternatives. When greater than zero, each
+         * transit leg in the response is annotated with up to N
+         * `alternatives`: connections that can replace the leg while still
+         * matching the surrounding journey context (i.e. arriving in time
+         * for the next transit leg / departing after the previous transit
+         * leg's arrival). Each alternative is a 3-leg sequence
+         * `[ingress footpath, transit, egress footpath]`.
+         *
+         */
+        numLegAlternatives?: number;
         /**
          * Use the cursor to go to the next "page" of itineraries.
          * Copy the cursor from the last response and keep the original request as is.
@@ -2183,6 +2324,14 @@ type PlanData = {
          *
          */
         preTransitRentalProviders?: Array<(string)>;
+        /**
+         * Experimental. Search radius in meters around the `fromPlace` / `toPlace` coordinates.
+         * When set and the place is given as coordinates, all transit stops within
+         * this radius are used as start/end points with zero pre-transit/post-transit time.
+         * Works without OSM/street routing data loaded.
+         *
+         */
+        radius?: number;
         /**
          * Optional. Default is `false`.
          *
@@ -2819,6 +2968,14 @@ type OneToAllResponse = (Reachable);
 type OneToAllError = (Error);
 type ReverseGeocodeData = {
     query: {
+        /**
+         * Optional. Number of results to return.
+         *
+         * If omitted, 5 results are returned by default.
+         * Must be <= server config variable `reverse_geocode_max_results`.
+         *
+         */
+        numResults?: number;
         /**
          * latitude, longitude in degrees
          */
@@ -2826,11 +2983,11 @@ type ReverseGeocodeData = {
         /**
          * Optional. Default is all types.
          *
-         * Only return results of the given type.
+         * Only return results matching one of the given types.
          * For example, this can be used to allow only `ADDRESS` and `STOP` results.
          *
          */
-        type?: LocationType;
+        type?: Array<LocationType>;
     };
 };
 type ReverseGeocodeResponse = (Array<Match>);
@@ -2849,6 +3006,14 @@ type GeocodeData = {
          *
          */
         mode?: Array<Mode>;
+        /**
+         * Optional. Number of suggestions to return.
+         *
+         * If omitted, 10 suggestions are returned by default.
+         * Must be <= server config variable `geocode_max_suggestions`.
+         *
+         */
+        numResults?: number;
         /**
          * Optional. Used for biasing results towards the coordinate.
          *
@@ -2868,11 +3033,11 @@ type GeocodeData = {
         /**
          * Optional. Default is all types.
          *
-         * Only return results of the given types.
+         * Only return results matching one of the given types.
          * For example, this can be used to allow only `ADDRESS` and `STOP` results.
          *
          */
-        type?: LocationType;
+        type?: Array<LocationType>;
     };
 };
 type GeocodeResponse = (Array<Match>);
@@ -2914,6 +3079,31 @@ type TripData = {
 };
 type TripResponse = (Itinerary);
 type TripError = (Error);
+type RefreshItineraryData = {
+    query: {
+        detailedLegs?: boolean;
+        detailedTransfers?: boolean;
+        itineraryId: string;
+        joinInterlinedLegs?: boolean;
+        language?: Array<(string)>;
+        numLegAlternatives?: number;
+        pedestrianProfile?: PedestrianProfile;
+        requireBikeTransport?: boolean;
+        requireCarTransport?: boolean;
+        requireDisplayNameMatch?: boolean;
+        transitModes?: Array<Mode>;
+        useRoutedTransfers?: boolean;
+        withFares?: boolean;
+        withScheduledSkippedStops?: boolean;
+    };
+};
+type RefreshItineraryResponse = (Itinerary);
+type RefreshItineraryError = (Error);
+type RefreshItineraryPostData = {
+    body: RefreshItineraryPostBody;
+};
+type RefreshItineraryPostResponse = (Itinerary);
+type RefreshItineraryPostError = (Error);
 type StoptimesData = {
     query?: {
         /**
@@ -3102,6 +3292,10 @@ type InitialResponse = ({
 type InitialError = (Error);
 type StopsData = {
     query: {
+        /**
+         * Optional. Return grouped stops
+         */
+        grouped?: boolean;
         /**
          * language tags as used in OpenStreetMap / GTFS
          * (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
@@ -3116,6 +3310,10 @@ type StopsData = {
          * latitude,longitude pair of the lower right coordinate
          */
         min: string;
+        /**
+         * Optional. Stop modes
+         */
+        modes?: Array<Mode>;
     };
 };
 type StopsResponse = (Array<Place>);
@@ -3168,6 +3366,30 @@ type RoutesResponse = ({
     zoomFiltered: boolean;
 });
 type RoutesError = (Error);
+type RouteDetailsData = {
+    query: {
+        /**
+         * language tags as used in OpenStreetMap / GTFS
+         * (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
+         *
+         */
+        language?: Array<(string)>;
+        /**
+         * Internal route index
+         */
+        routeIdx: number;
+    };
+};
+type RouteDetailsResponse = ({
+    routes: Array<RouteInfo>;
+    polylines: Array<RoutePolyline>;
+    stops: Array<Place>;
+    /**
+     * Always false for this endpoint.
+     */
+    zoomFiltered: boolean;
+});
+type RouteDetailsError = (Error);
 type RentalsData = {
     query?: {
         /**
@@ -3238,6 +3460,8 @@ type RentalsResponse = ({
     zones: Array<RentalZone>;
 });
 type RentalsError = (Error);
+type HealthResponse2 = (HealthResponse);
+type HealthError = (HealthResponse);
 type TransfersData = {
     query: {
         /**
@@ -3269,4 +3493,4 @@ type TransfersResponse = ({
 });
 type TransfersError = unknown;
 
-export type { 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 };
+export type { Alert, AlertCause, AlertEffect, AlertSeverityLevel, Area, Category, CyclingSpeed, Direction, Duration, ElevationCosts, EncodedPolyline, Error, FareMedia, FareMediaType, FareProduct, FareTransfer, FareTransferRule, GeocodeData, GeocodeError, GeocodeResponse, HealthError, HealthResponse, HealthResponse2, InitialError, InitialResponse, Itinerary, ItineraryId, Leg, LegId, 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, RefreshItineraryData, RefreshItineraryError, RefreshItineraryPostBody, RefreshItineraryPostData, RefreshItineraryPostError, RefreshItineraryPostResponse, RefreshItineraryResponse, Rental, RentalFormFactor, RentalPropulsionType, RentalProvider, RentalProviderGroup, RentalReturnConstraint, RentalStation, RentalVehicle, RentalVehicleType, RentalZone, RentalZoneRestrictions, RentalsData, RentalsError, RentalsResponse, ReverseGeocodeData, ReverseGeocodeError, ReverseGeocodeResponse, RiderCategory, RouteColor, RouteDetailsData, RouteDetailsError, RouteDetailsResponse, 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, WheelchairAccessibility };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@motis-project/motis-client",
-	"version": "2.9.2",
+	"version": "2.10.2",
 	"description": "A JS client for the MOTIS API.",
 	"public": true,
 	"main": "dist/index.js",