@motis-project/motis-client 2.5.0 → 2.7.3

package/dist/types.gen.d.ts

@@ -21,13 +21,13 @@ type TimeRange = {
      * If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
      *
      */
-    start?: string;
+    start: string;
     /**
      * If missing, the interval ends at plus infinity.
      * If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
      *
      */
-    end?: string;
+    end: string;
 };
 /**
  * An alert, indicating some sort of incident in the public transit network.
@@ -160,11 +160,56 @@ type Token = [
  * location type
  */
 type LocationType = 'ADDRESS' | 'PLACE' | 'STOP';
+/**
+ * # Street modes
+ *
+ * - `WALK`
+ * - `BIKE`
+ * - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
+ * - `CAR`
+ * - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
+ * - `CAR_DROPOFF` Experimental. Expect unannounced breaking changes (without version bumps) for all perameters and returned structs.
+ * - `ODM` on-demand taxis from the Prima+ÖV Project
+ * - `RIDE_SHARING` ride sharing from the Prima+ÖV Project
+ * - `FLEX` flexible transports
+ *
+ * # Transit modes
+ *
+ * - `TRANSIT`: translates to `RAIL,TRAM,BUS,FERRY,AIRPLANE,COACH,CABLE_CAR,FUNICULAR,AREAL_LIFT,OTHER`
+ * - `TRAM`: trams
+ * - `SUBWAY`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)
+ * - `FERRY`: ferries
+ * - `AIRPLANE`: airline flights
+ * - `BUS`: short distance buses (does not include `COACH`)
+ * - `COACH`: long distance buses (does not include `BUS`)
+ * - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL,SUBURBAN,SUBWAY`
+ * - `SUBURBAN`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)
+ * - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)
+ * - `LONG_DISTANCE`: long distance inter city trains
+ * - `NIGHT_RAIL`: long distance night trains
+ * - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster
+ * - `REGIONAL_RAIL`: regional train
+ * - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).
+ * - `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
+ * - `METRO`: deprecated
+ *
+ */
+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';
 /**
  * GeoCoding match
  */
 type Match = {
     type: LocationType;
+    /**
+     * Experimental. Type categories might be adjusted.
+     *
+     * For OSM stop locations: the amenity type based on
+     * https://wiki.openstreetmap.org/wiki/OpenStreetMap_Carto/Symbols
+     *
+     */
+    category?: string;
     /**
      * list of non-overlapping tokens that were matched
      */
@@ -219,6 +264,14 @@ type Match = {
      * score according to the internal scoring system (the scoring algorithm might change in the future)
      */
     score: number;
+    /**
+     * available transport modes for stops
+     */
+    modes?: Array<Mode>;
+    /**
+     * importance of a stop, normalized from [0, 1]
+     */
+    importance?: number;
 };
 /**
  * Different elevation cost profiles for street routing.
@@ -242,42 +295,6 @@ type PedestrianSpeed = number;
  * Average speed for bike routing in meters per second
  */
 type CyclingSpeed = number;
-/**
- * # Street modes
- *
- * - `WALK`
- * - `BIKE`
- * - `RENTAL` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
- * - `CAR`
- * - `CAR_PARKING` Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
- * - `CAR_DROPOFF` Experimental. Expect unannounced breaking changes (without version bumps) for all perameters and returned structs.
- * - `ODM` on-demand taxis from the Prima+ÖV Project
- * - `FLEX` flexible transports
- *
- * # Transit modes
- *
- * - `TRANSIT`: translates to `RAIL,TRAM,BUS,FERRY,AIRPLANE,COACH,CABLE_CAR,FUNICULAR,AREAL_LIFT,OTHER`
- * - `TRAM`: trams
- * - `SUBWAY`: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)
- * - `FERRY`: ferries
- * - `AIRPLANE`: airline flights
- * - `BUS`: short distance buses (does not include `COACH`)
- * - `COACH`: long distance buses (does not include `BUS`)
- * - `RAIL`: translates to `HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,REGIONAL_FAST_RAIL,SUBURBAN,SUBWAY`
- * - `SUBURBAN`: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)
- * - `HIGHSPEED_RAIL`: long distance high speed trains (e.g. TGV)
- * - `LONG_DISTANCE`: long distance inter city trains
- * - `NIGHT_RAIL`: long distance night trains
- * - `REGIONAL_FAST_RAIL`: regional express routes that skip low traffic stops to be faster
- * - `REGIONAL_RAIL`: regional train
- * - `CABLE_CAR`: Cable tram. Used for street-level rail cars where the cable runs beneath the vehicle (e.g., cable car in San Francisco).
- * - `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
- * - `METRO`: deprecated
- *
- */
-type Mode = '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';
 /**
  * - `NORMAL` - latitude / longitude coordinate or address
  * - `BIKESHARE` - bike sharing station
@@ -300,6 +317,14 @@ type Place = {
      * The ID of the stop. This is often something that users don't care about.
      */
     stopId?: string;
+    /**
+     * If it's not a root stop, this field contains the `stopId` of the parent stop.
+     */
+    parentId?: string;
+    /**
+     * The importance of the stop between 0-1.
+     */
+    importance?: number;
     /**
      * latitude
      */
@@ -447,6 +472,8 @@ type StopTime = {
     agencyId: string;
     agencyName: string;
     agencyUrl: string;
+    routeId: string;
+    directionId: string;
     routeColor?: string;
     routeTextColor?: string;
     tripId: string;
@@ -629,6 +656,14 @@ type RentalReturnConstraint = 'NONE' | 'ANY_STATION' | 'ROUNDTRIP_STATION';
  * Vehicle rental
  */
 type Rental = {
+    /**
+     * Rental provider ID
+     */
+    providerId: string;
+    /**
+     * Rental provider group ID
+     */
+    providerGroupId: string;
     /**
      * Vehicle share system ID
      */
@@ -641,6 +676,12 @@ type Rental = {
      * URL of the vehicle share system
      */
     url?: string;
+    /**
+     * Color associated with this provider, in hexadecimal RGB format
+     * (e.g. "#FF0000" for red). Can be empty.
+     *
+     */
+    color?: string;
     /**
      * Name of the station
      */
@@ -669,6 +710,305 @@ type Rental = {
     propulsionType?: RentalPropulsionType;
     returnConstraint?: RentalReturnConstraint;
 };
+/**
+ * A multi-polygon contains a number of polygons, each containing a number
+ * of rings, which are encoded as polylines (with precision 6).
+ *
+ * For each polygon, the first ring is the outer ring, all subsequent rings
+ * are inner rings (holes).
+ *
+ */
+type MultiPolygon = Array<Array<EncodedPolyline>>;
+type RentalZoneRestrictions = {
+    /**
+     * List of vehicle types (as indices into the provider's vehicle types
+     * array) to which these restrictions apply.
+     * If empty, the restrictions apply to all vehicle types of the provider.
+     *
+     */
+    vehicleTypeIdxs: Array<(number)>;
+    /**
+     * whether the ride is allowed to start in this zone
+     */
+    rideStartAllowed: boolean;
+    /**
+     * whether the ride is allowed to end in this zone
+     */
+    rideEndAllowed: boolean;
+    /**
+     * whether the ride is allowed to pass through this zone
+     */
+    rideThroughAllowed: boolean;
+    /**
+     * whether vehicles can only be parked at stations in this zone
+     */
+    stationParking?: boolean;
+};
+type RentalVehicleType = {
+    /**
+     * Unique identifier of the vehicle type (unique within the provider)
+     */
+    id: string;
+    /**
+     * Public name of the vehicle type (can be empty)
+     */
+    name?: string;
+    formFactor: RentalFormFactor;
+    propulsionType: RentalPropulsionType;
+    returnConstraint: RentalReturnConstraint;
+    /**
+     * Whether the return constraint was guessed instead of being specified by the rental provider
+     */
+    returnConstraintGuessed: boolean;
+};
+type RentalProvider = {
+    /**
+     * Unique identifier of the rental provider
+     */
+    id: string;
+    /**
+     * Name of the provider to be displayed to customers
+     */
+    name: string;
+    /**
+     * Id of the rental provider group this provider belongs to
+     */
+    groupId: string;
+    /**
+     * Name of the system operator
+     */
+    operator?: string;
+    /**
+     * URL of the vehicle share system
+     */
+    url?: string;
+    /**
+     * URL where a customer can purchase a membership
+     */
+    purchaseUrl?: string;
+    /**
+     * Color associated with this provider, in hexadecimal RGB format
+     * (e.g. "#FF0000" for red). Can be empty.
+     *
+     */
+    color?: string;
+    /**
+     * Bounding box of the area covered by this rental provider,
+     * [west, south, east, north] as [lon, lat, lon, lat]
+     *
+     */
+    bbox: [
+        number,
+        number,
+        number,
+        number
+    ];
+    vehicleTypes: Array<RentalVehicleType>;
+    /**
+     * List of form factors offered by this provider
+     */
+    formFactors: Array<RentalFormFactor>;
+    defaultRestrictions: RentalZoneRestrictions;
+    globalGeofencingRules: Array<RentalZoneRestrictions>;
+};
+type RentalProviderGroup = {
+    /**
+     * Unique identifier of the rental provider group
+     */
+    id: string;
+    /**
+     * Name of the provider group to be displayed to customers
+     */
+    name: string;
+    /**
+     * Color associated with this provider group, in hexadecimal RGB format
+     * (e.g. "#FF0000" for red). Can be empty.
+     *
+     */
+    color?: string;
+    /**
+     * List of rental provider IDs that belong to this group
+     */
+    providers: Array<(string)>;
+    /**
+     * List of form factors offered by this provider group
+     */
+    formFactors: Array<RentalFormFactor>;
+};
+type RentalStation = {
+    /**
+     * Unique identifier of the rental station
+     */
+    id: string;
+    /**
+     * Unique identifier of the rental provider
+     */
+    providerId: string;
+    /**
+     * Unique identifier of the rental provider group
+     */
+    providerGroupId: string;
+    /**
+     * Public name of the station
+     */
+    name: string;
+    /**
+     * latitude
+     */
+    lat: number;
+    /**
+     * longitude
+     */
+    lon: number;
+    /**
+     * Address where the station is located
+     */
+    address?: string;
+    /**
+     * Cross street or landmark where the station is located
+     */
+    crossStreet?: string;
+    /**
+     * Rental URI for Android (deep link to the specific station)
+     */
+    rentalUriAndroid?: string;
+    /**
+     * Rental URI for iOS (deep link to the specific station)
+     */
+    rentalUriIOS?: string;
+    /**
+     * Rental URI for web (deep link to the specific station)
+     */
+    rentalUriWeb?: string;
+    /**
+     * true if vehicles can be rented from this station, false if it is temporarily out of service
+     */
+    isRenting: boolean;
+    /**
+     * true if vehicles can be returned to this station, false if it is temporarily out of service
+     */
+    isReturning: boolean;
+    /**
+     * Number of vehicles available for rental at this station
+     */
+    numVehiclesAvailable: number;
+    /**
+     * List of form factors available for rental and/or return at this station
+     */
+    formFactors: Array<RentalFormFactor>;
+    /**
+     * List of vehicle types currently available at this station (vehicle type ID -> count)
+     */
+    vehicleTypesAvailable: {
+        [key: string]: (number);
+    };
+    /**
+     * List of vehicle docks currently available at this station (vehicle type ID -> count)
+     */
+    vehicleDocksAvailable: {
+        [key: string]: (number);
+    };
+    stationArea?: MultiPolygon;
+    /**
+     * Bounding box of the area covered by this station,
+     * [west, south, east, north] as [lon, lat, lon, lat]
+     *
+     */
+    bbox: [
+        number,
+        number,
+        number,
+        number
+    ];
+};
+type RentalVehicle = {
+    /**
+     * Unique identifier of the rental vehicle
+     */
+    id: string;
+    /**
+     * Unique identifier of the rental provider
+     */
+    providerId: string;
+    /**
+     * Unique identifier of the rental provider group
+     */
+    providerGroupId: string;
+    /**
+     * Vehicle type ID (unique within the provider)
+     */
+    typeId: string;
+    /**
+     * latitude
+     */
+    lat: number;
+    /**
+     * longitude
+     */
+    lon: number;
+    formFactor: RentalFormFactor;
+    propulsionType: RentalPropulsionType;
+    returnConstraint: RentalReturnConstraint;
+    /**
+     * Station ID if the vehicle is currently at a station
+     */
+    stationId?: string;
+    /**
+     * Station ID where the vehicle must be returned, if applicable
+     */
+    homeStationId?: string;
+    /**
+     * true if the vehicle is currently reserved by a customer, false otherwise
+     */
+    isReserved: boolean;
+    /**
+     * true if the vehicle is out of service, false otherwise
+     */
+    isDisabled: boolean;
+    /**
+     * Rental URI for Android (deep link to the specific vehicle)
+     */
+    rentalUriAndroid?: string;
+    /**
+     * Rental URI for iOS (deep link to the specific vehicle)
+     */
+    rentalUriIOS?: string;
+    /**
+     * Rental URI for web (deep link to the specific vehicle)
+     */
+    rentalUriWeb?: string;
+};
+type RentalZone = {
+    /**
+     * Unique identifier of the rental provider
+     */
+    providerId: string;
+    /**
+     * Unique identifier of the rental provider group
+     */
+    providerGroupId: string;
+    /**
+     * Public name of the geofencing zone
+     */
+    name?: string;
+    /**
+     * Zone precedence / z-index (higher number = higher precedence)
+     */
+    z: number;
+    /**
+     * Bounding box of the area covered by this zone,
+     * [west, south, east, north] as [lon, lat, lon, lat]
+     *
+     */
+    bbox: [
+        number,
+        number,
+        number,
+        number
+    ];
+    area: MultiPolygon;
+    rules: Array<RentalZoneRestrictions>;
+};
 type Leg = {
     /**
      * Transport mode for this leg
@@ -736,6 +1076,8 @@ type Leg = {
      * final stop of this trip (can differ from headsign)
      */
     tripTo?: Place;
+    routeId?: string;
+    directionId?: string;
     routeColor?: string;
     routeTextColor?: string;
     routeType?: number;
@@ -950,6 +1292,53 @@ type Transfer = {
      */
     car?: number;
 };
+type OneToManyParams = {
+    /**
+     * geo location as latitude;longitude
+     */
+    one: string;
+    /**
+     * geo locations as latitude;longitude,latitude;longitude,...
+     */
+    many: Array<(string)>;
+    /**
+     * routing profile to use (currently supported: \`WALK\`, \`BIKE\`, \`CAR\`)
+     *
+     */
+    mode: Mode;
+    /**
+     * maximum travel time in seconds
+     */
+    max: number;
+    /**
+     * maximum matching distance in meters to match geo coordinates to the street network
+     */
+    maxMatchingDistance: number;
+    /**
+     * Optional. Default is `NONE`.
+     *
+     * Set an elevation cost profile, to penalize routes with incline.
+     * - `NONE`: No additional costs for elevations. This is the default behavior
+     * - `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.
+     * - `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.
+     *
+     * As using an elevation costs profile will increase the travel duration,
+     * routing through steep terrain may exceed the maximal allowed duration,
+     * causing a location to appear unreachable.
+     * Increasing the maximum travel time for these segments may resolve this issue.
+     *
+     * Elevation cost profiles are currently used by following street modes:
+     * - `BIKE`
+     *
+     */
+    elevationCosts: ElevationCosts;
+    /**
+     * true = many to one
+     * false = one to many
+     *
+     */
+    arriveBy: boolean;
+};
 type Error = {
     error?: string;
 };
@@ -965,7 +1354,7 @@ type PlanData = {
         /**
          * algorithm to use
          */
-        algorithm?: 'RAPTOR' | 'TB';
+        algorithm?: 'RAPTOR' | 'PONG' | 'TB';
         /**
          * Optional. Default is `false`.
          *
@@ -1027,6 +1416,16 @@ type PlanData = {
          *
          */
         directRentalPropulsionTypes?: Array<RentalPropulsionType>;
+        /**
+         * Experimental. Expect unannounced breaking changes (without version bumps).
+         *
+         * Optional. Only applies to direct connections.
+         *
+         * A list of rental provider groups that are allowed to be used for direct connections.
+         * If empty (the default), all providers are allowed.
+         *
+         */
+        directRentalProviderGroups?: Array<(string)>;
         /**
          * Experimental. Expect unannounced breaking changes (without version bumps).
          *
@@ -1128,7 +1527,7 @@ type PlanData = {
          * (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
          *
          */
-        language?: string;
+        language?: Array<(string)>;
         /**
          * Optional. Experimental. Number of luggage pieces; base unit: airline cabin luggage (e.g. for ODM or price calculation)
          *
@@ -1141,6 +1540,23 @@ type PlanData = {
          *
          */
         maxDirectTime?: number;
+        /**
+         * Optional. By default all computed itineraries will be returned
+         *
+         * The maximum number of itineraries to compute.
+         * This is only relevant if `timetableView=true`.
+         *
+         * Note: With the current implementation, setting this to a lower
+         * number will not result in any speedup.
+         *
+         * Note: The number of returned itineraries might be slightly higher
+         * than `maxItineraries` as there might be several itineraries with
+         * the same departure time but different number of transfers. In order
+         * to not miss any itineraries for paging, either none or all
+         * itineraries with the same departure time have to be returned.
+         *
+         */
+        maxItineraries?: number;
         /**
          * Optional. Default is 25 meters.
          *
@@ -1263,6 +1679,16 @@ type PlanData = {
          *
          */
         postTransitRentalPropulsionTypes?: Array<RentalPropulsionType>;
+        /**
+         * Experimental. Expect unannounced breaking changes (without version bumps).
+         *
+         * Optional. Only applies if the `to` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviderGroups`).
+         *
+         * A list of rental provider groups that are allowed to be used from the last transit stop to the `to` coordinate.
+         * If empty (the default), all providers are allowed.
+         *
+         */
+        postTransitRentalProviderGroups?: Array<(string)>;
         /**
          * Experimental. Expect unannounced breaking changes (without version bumps).
          *
@@ -1302,6 +1728,16 @@ type PlanData = {
          *
          */
         preTransitRentalPropulsionTypes?: Array<RentalPropulsionType>;
+        /**
+         * Experimental. Expect unannounced breaking changes (without version bumps).
+         *
+         * Optional. Only applies if the `from` place is a coordinate (not a transit stop). Does not apply to direct connections (see `directRentalProviderGroups`).
+         *
+         * A list of rental provider groups that are allowed to be used from the `from` coordinate to the first transit stop.
+         * If empty (the default), all providers are allowed.
+         *
+         */
+        preTransitRentalProviderGroups?: Array<(string)>;
         /**
          * Experimental. Expect unannounced breaking changes (without version bumps).
          *
@@ -1327,9 +1763,9 @@ type PlanData = {
          */
         requireCarTransport?: boolean;
         /**
-         * Optional. Default is 2 hours which is `7200`.
+         * Optional. Default is 15 minutes which is `900`.
          *
-         * The length of the search-window in seconds. Default value two hours.
+         * The length of the search-window in seconds. Default value 15 minutes.
          *
          * - `arriveBy=true`: number of seconds between the earliest departure time and latest departure time
          * - `arriveBy=false`: number of seconds between the earliest arrival time and the latest arrival time
@@ -1736,7 +2172,13 @@ type GeocodeData = {
          * (usually ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
          *
          */
-        language?: string;
+        language?: Array<(string)>;
+        /**
+         * Optional. Filter stops by available transport modes.
+         * Defaults to applying no filter.
+         *
+         */
+        mode?: Array<Mode>;
         /**
          * Optional. Used for biasing results towards the coordinate.
          *
@@ -1782,7 +2224,7 @@ type TripData = {
          * (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
          *
          */
-        language?: string;
+        language?: Array<(string)>;
         /**
          * trip identifier (e.g. from an itinerary leg or stop event)
          */
@@ -1839,7 +2281,7 @@ type StoptimesData = {
          * (usually BCP-47 / ISO 639-1, or ISO 639-2 if there's no ISO 639-1)
          *
          */
-        language?: string;
+        language?: Array<(string)>;
         /**
          * Optional. Default is all transit modes.
          *
@@ -1976,6 +2418,60 @@ type LevelsData = {
 };
 type LevelsResponse = (Array<(number)>);
 type LevelsError = (Error);
+type RentalsData = {
+    query?: {
+        /**
+         * latitude,longitude pair of the upper left coordinate
+         */
+        max?: string;
+        /**
+         * latitude,longitude pair of the lower right coordinate
+         */
+        min?: string;
+        /**
+         * A list of rental provider groups to return.
+         * If both `providerGroups` and `providers` are empty/not specified,
+         * all providers in the map section are returned.
+         *
+         */
+        providerGroups?: Array<(string)>;
+        /**
+         * A list of rental providers to return.
+         * If both `providerGroups` and `providers` are empty/not specified,
+         * all providers in the map section are returned.
+         *
+         */
+        providers?: Array<(string)>;
+        /**
+         * Optional. Include providers in output. If false, only provider
+         * groups are returned.
+         *
+         * Also affects the providers list for each provider group.
+         *
+         */
+        withProviders?: boolean;
+        /**
+         * Optional. Include stations in output (requires at least min+max or providers filter).
+         */
+        withStations?: boolean;
+        /**
+         * Optional. Include free-floating vehicles in output (requires at least min+max or providers filter).
+         */
+        withVehicles?: boolean;
+        /**
+         * Optional. Include geofencing zones in output (requires at least min+max or providers filter).
+         */
+        withZones?: boolean;
+    };
+};
+type RentalsResponse = ({
+    providerGroups: Array<RentalProviderGroup>;
+    providers: Array<RentalProvider>;
+    stations: Array<RentalStation>;
+    vehicles: Array<RentalVehicle>;
+    zones: Array<RentalZone>;
+});
+type RentalsError = (Error);
 type TransfersData = {
     query: {
         /**
@@ -1986,6 +2482,8 @@ type TransfersData = {
 };
 type TransfersResponse = ({
     place: Place;
+    root: Place;
+    equivalences: Array<Place>;
     /**
      * true if the server has foot transfers computed
      */
@@ -2005,4 +2503,4 @@ type TransfersResponse = ({
 });
 type TransfersError = unknown;
 
-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, OneToAllData, OneToAllError, OneToAllResponse, OneToManyData, OneToManyError, OneToManyResponse, PedestrianProfile, PedestrianSpeed, PickupDropoffType, Place, PlanData, PlanError, PlanResponse, Reachable, ReachablePlace, Rental, RentalFormFactor, RentalPropulsionType, RentalReturnConstraint, 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 };
+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 };