@motis-project/motis-client 2.5.0 → 2.7.3

package/dist/schemas.gen.d.ts

@@ -16,6 +16,7 @@ declare const AlertSeverityLevelSchema: {
 declare const TimeRangeSchema: {
     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";
     readonly type: "object";
+    readonly required: readonly ["start", "end"];
     readonly properties: {
         readonly start: {
             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: {
     readonly type: "string";
     readonly enum: readonly ["ADDRESS", "PLACE", "STOP"];
 };
+declare const ModeSchema: {
+    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";
+    readonly type: "string";
+    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"];
+};
 declare const MatchSchema: {
     readonly description: "GeoCoding match";
     readonly type: "object";
@@ -159,6 +165,10 @@ declare const MatchSchema: {
         readonly type: {
             readonly $ref: "#/components/schemas/LocationType";
         };
+        readonly category: {
+            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";
+            readonly type: "string";
+        };
         readonly tokens: {
             readonly description: "list of non-overlapping tokens that were matched";
             readonly type: "array";
@@ -217,6 +227,17 @@ declare const MatchSchema: {
             readonly description: "score according to the internal scoring system (the scoring algorithm might change in the future)";
             readonly type: "number";
         };
+        readonly modes: {
+            readonly description: "available transport modes for stops";
+            readonly type: "array";
+            readonly items: {
+                readonly $ref: "#/components/schemas/Mode";
+            };
+        };
+        readonly importance: {
+            readonly description: "importance of a stop, normalized from [0, 1]";
+            readonly type: "number";
+        };
     };
 };
 declare const ElevationCostsSchema: {
@@ -237,11 +258,6 @@ declare const CyclingSpeedSchema: {
     readonly description: "Average speed for bike routing in meters per second";
     readonly type: "number";
 };
-declare const ModeSchema: {
-    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 (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";
-    readonly type: "string";
-    readonly enum: readonly ["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"];
-};
 declare const VertexTypeSchema: {
     readonly type: "string";
     readonly description: "- `NORMAL` - latitude / longitude coordinate or address\n- `BIKESHARE` - bike sharing station\n- `TRANSIT` - transit stop\n";
@@ -264,6 +280,14 @@ declare const PlaceSchema: {
             readonly description: "The ID of the stop. This is often something that users don't care about.";
             readonly type: "string";
         };
+        readonly parentId: {
+            readonly description: "If it's not a root stop, this field contains the `stopId` of the parent stop.";
+            readonly type: "string";
+        };
+        readonly importance: {
+            readonly description: "The importance of the stop between 0-1.";
+            readonly type: "number";
+        };
         readonly lat: {
             readonly description: "latitude";
             readonly type: "number";
@@ -392,7 +416,7 @@ declare const ReachableSchema: {
 declare const StopTimeSchema: {
     readonly description: "departure or arrival event at a stop";
     readonly type: "object";
-    readonly required: readonly ["place", "mode", "realTime", "headsign", "tripTo", "agencyId", "agencyName", "agencyUrl", "tripId", "routeShortName", "routeLongName", "tripShortName", "displayName", "pickupDropoffType", "cancelled", "tripCancelled", "source"];
+    readonly required: readonly ["place", "mode", "realTime", "headsign", "tripTo", "agencyId", "agencyName", "agencyUrl", "tripId", "routeId", "directionId", "routeShortName", "routeLongName", "tripShortName", "displayName", "pickupDropoffType", "cancelled", "tripCancelled", "source"];
     readonly properties: {
         readonly place: {
             readonly $ref: "#/components/schemas/Place";
@@ -423,6 +447,12 @@ declare const StopTimeSchema: {
         readonly agencyUrl: {
             readonly type: "string";
         };
+        readonly routeId: {
+            readonly type: "string";
+        };
+        readonly directionId: {
+            readonly type: "string";
+        };
         readonly routeColor: {
             readonly type: "string";
         };
@@ -654,8 +684,16 @@ declare const RentalReturnConstraintSchema: {
 declare const RentalSchema: {
     readonly description: "Vehicle rental";
     readonly type: "object";
-    readonly required: readonly ["systemId"];
+    readonly required: readonly ["providerId", "providerGroupId", "systemId"];
     readonly properties: {
+        readonly providerId: {
+            readonly type: "string";
+            readonly description: "Rental provider ID";
+        };
+        readonly providerGroupId: {
+            readonly type: "string";
+            readonly description: "Rental provider group ID";
+        };
         readonly systemId: {
             readonly type: "string";
             readonly description: "Vehicle share system ID";
@@ -668,6 +706,10 @@ declare const RentalSchema: {
             readonly type: "string";
             readonly description: "URL of the vehicle share system";
         };
+        readonly color: {
+            readonly type: "string";
+            readonly description: "Color associated with this provider, in hexadecimal RGB format\n(e.g. \"#FF0000\" for red). Can be empty.\n";
+        };
         readonly stationName: {
             readonly type: "string";
             readonly description: "Name of the station";
@@ -703,6 +745,371 @@ declare const RentalSchema: {
         };
     };
 };
+declare const MultiPolygonSchema: {
+    readonly type: "array";
+    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";
+    readonly items: {
+        readonly type: "array";
+        readonly items: {
+            readonly $ref: "#/components/schemas/EncodedPolyline";
+        };
+    };
+};
+declare const RentalZoneRestrictionsSchema: {
+    readonly type: "object";
+    readonly required: readonly ["vehicleTypeIdxs", "rideStartAllowed", "rideEndAllowed", "rideThroughAllowed"];
+    readonly properties: {
+        readonly vehicleTypeIdxs: {
+            readonly type: "array";
+            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";
+            readonly items: {
+                readonly type: "integer";
+            };
+        };
+        readonly rideStartAllowed: {
+            readonly type: "boolean";
+            readonly description: "whether the ride is allowed to start in this zone";
+        };
+        readonly rideEndAllowed: {
+            readonly type: "boolean";
+            readonly description: "whether the ride is allowed to end in this zone";
+        };
+        readonly rideThroughAllowed: {
+            readonly type: "boolean";
+            readonly description: "whether the ride is allowed to pass through this zone";
+        };
+        readonly stationParking: {
+            readonly type: "boolean";
+            readonly description: "whether vehicles can only be parked at stations in this zone";
+        };
+    };
+};
+declare const RentalVehicleTypeSchema: {
+    readonly type: "object";
+    readonly required: readonly ["id", "formFactor", "propulsionType", "returnConstraint", "returnConstraintGuessed"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the vehicle type (unique within the provider)";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "Public name of the vehicle type (can be empty)";
+        };
+        readonly formFactor: {
+            readonly $ref: "#/components/schemas/RentalFormFactor";
+        };
+        readonly propulsionType: {
+            readonly $ref: "#/components/schemas/RentalPropulsionType";
+        };
+        readonly returnConstraint: {
+            readonly $ref: "#/components/schemas/RentalReturnConstraint";
+        };
+        readonly returnConstraintGuessed: {
+            readonly type: "boolean";
+            readonly description: "Whether the return constraint was guessed instead of being specified by the rental provider";
+        };
+    };
+};
+declare const RentalProviderSchema: {
+    readonly type: "object";
+    readonly required: readonly ["id", "name", "groupId", "bbox", "vehicleTypes", "formFactors", "defaultRestrictions", "globalGeofencingRules"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental provider";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "Name of the provider to be displayed to customers";
+        };
+        readonly groupId: {
+            readonly type: "string";
+            readonly description: "Id of the rental provider group this provider belongs to";
+        };
+        readonly operator: {
+            readonly type: "string";
+            readonly description: "Name of the system operator";
+        };
+        readonly url: {
+            readonly type: "string";
+            readonly description: "URL of the vehicle share system";
+        };
+        readonly purchaseUrl: {
+            readonly type: "string";
+            readonly description: "URL where a customer can purchase a membership";
+        };
+        readonly color: {
+            readonly type: "string";
+            readonly description: "Color associated with this provider, in hexadecimal RGB format\n(e.g. \"#FF0000\" for red). Can be empty.\n";
+        };
+        readonly bbox: {
+            readonly type: "array";
+            readonly description: "Bounding box of the area covered by this rental provider,\n[west, south, east, north] as [lon, lat, lon, lat]\n";
+            readonly minItems: 4;
+            readonly maxItems: 4;
+            readonly items: {
+                readonly type: "number";
+            };
+        };
+        readonly vehicleTypes: {
+            readonly type: "array";
+            readonly items: {
+                readonly $ref: "#/components/schemas/RentalVehicleType";
+            };
+        };
+        readonly formFactors: {
+            readonly type: "array";
+            readonly description: "List of form factors offered by this provider";
+            readonly items: {
+                readonly $ref: "#/components/schemas/RentalFormFactor";
+            };
+        };
+        readonly defaultRestrictions: {
+            readonly $ref: "#/components/schemas/RentalZoneRestrictions";
+        };
+        readonly globalGeofencingRules: {
+            readonly type: "array";
+            readonly items: {
+                readonly $ref: "#/components/schemas/RentalZoneRestrictions";
+            };
+        };
+    };
+};
+declare const RentalProviderGroupSchema: {
+    readonly type: "object";
+    readonly required: readonly ["id", "name", "providers", "formFactors"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental provider group";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "Name of the provider group to be displayed to customers";
+        };
+        readonly color: {
+            readonly type: "string";
+            readonly description: "Color associated with this provider group, in hexadecimal RGB format\n(e.g. \"#FF0000\" for red). Can be empty.\n";
+        };
+        readonly providers: {
+            readonly type: "array";
+            readonly description: "List of rental provider IDs that belong to this group";
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+        readonly formFactors: {
+            readonly type: "array";
+            readonly description: "List of form factors offered by this provider group";
+            readonly items: {
+                readonly $ref: "#/components/schemas/RentalFormFactor";
+            };
+        };
+    };
+};
+declare const RentalStationSchema: {
+    readonly type: "object";
+    readonly required: readonly ["id", "providerId", "providerGroupId", "name", "lat", "lon", "isRenting", "isReturning", "numVehiclesAvailable", "formFactors", "vehicleTypesAvailable", "vehicleDocksAvailable", "bbox"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental station";
+        };
+        readonly providerId: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental provider";
+        };
+        readonly providerGroupId: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental provider group";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "Public name of the station";
+        };
+        readonly lat: {
+            readonly description: "latitude";
+            readonly type: "number";
+        };
+        readonly lon: {
+            readonly description: "longitude";
+            readonly type: "number";
+        };
+        readonly address: {
+            readonly type: "string";
+            readonly description: "Address where the station is located";
+        };
+        readonly crossStreet: {
+            readonly type: "string";
+            readonly description: "Cross street or landmark where the station is located";
+        };
+        readonly rentalUriAndroid: {
+            readonly type: "string";
+            readonly description: "Rental URI for Android (deep link to the specific station)";
+        };
+        readonly rentalUriIOS: {
+            readonly type: "string";
+            readonly description: "Rental URI for iOS (deep link to the specific station)";
+        };
+        readonly rentalUriWeb: {
+            readonly type: "string";
+            readonly description: "Rental URI for web (deep link to the specific station)";
+        };
+        readonly isRenting: {
+            readonly type: "boolean";
+            readonly description: "true if vehicles can be rented from this station, false if it is temporarily out of service";
+        };
+        readonly isReturning: {
+            readonly type: "boolean";
+            readonly description: "true if vehicles can be returned to this station, false if it is temporarily out of service";
+        };
+        readonly numVehiclesAvailable: {
+            readonly type: "integer";
+            readonly description: "Number of vehicles available for rental at this station";
+        };
+        readonly formFactors: {
+            readonly type: "array";
+            readonly description: "List of form factors available for rental and/or return at this station";
+            readonly items: {
+                readonly $ref: "#/components/schemas/RentalFormFactor";
+            };
+        };
+        readonly vehicleTypesAvailable: {
+            readonly type: "object";
+            readonly description: "List of vehicle types currently available at this station (vehicle type ID -> count)";
+            readonly additionalProperties: {
+                readonly type: "integer";
+            };
+        };
+        readonly vehicleDocksAvailable: {
+            readonly type: "object";
+            readonly description: "List of vehicle docks currently available at this station (vehicle type ID -> count)";
+            readonly additionalProperties: {
+                readonly type: "integer";
+            };
+        };
+        readonly stationArea: {
+            readonly $ref: "#/components/schemas/MultiPolygon";
+        };
+        readonly bbox: {
+            readonly type: "array";
+            readonly description: "Bounding box of the area covered by this station,\n[west, south, east, north] as [lon, lat, lon, lat]\n";
+            readonly minItems: 4;
+            readonly maxItems: 4;
+            readonly items: {
+                readonly type: "number";
+            };
+        };
+    };
+};
+declare const RentalVehicleSchema: {
+    readonly type: "object";
+    readonly required: readonly ["id", "providerId", "providerGroupId", "typeId", "lat", "lon", "formFactor", "propulsionType", "returnConstraint", "isReserved", "isDisabled"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental vehicle";
+        };
+        readonly providerId: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental provider";
+        };
+        readonly providerGroupId: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental provider group";
+        };
+        readonly typeId: {
+            readonly type: "string";
+            readonly description: "Vehicle type ID (unique within the provider)";
+        };
+        readonly lat: {
+            readonly description: "latitude";
+            readonly type: "number";
+        };
+        readonly lon: {
+            readonly description: "longitude";
+            readonly type: "number";
+        };
+        readonly formFactor: {
+            readonly $ref: "#/components/schemas/RentalFormFactor";
+        };
+        readonly propulsionType: {
+            readonly $ref: "#/components/schemas/RentalPropulsionType";
+        };
+        readonly returnConstraint: {
+            readonly $ref: "#/components/schemas/RentalReturnConstraint";
+        };
+        readonly stationId: {
+            readonly type: "string";
+            readonly description: "Station ID if the vehicle is currently at a station";
+        };
+        readonly homeStationId: {
+            readonly type: "string";
+            readonly description: "Station ID where the vehicle must be returned, if applicable";
+        };
+        readonly isReserved: {
+            readonly type: "boolean";
+            readonly description: "true if the vehicle is currently reserved by a customer, false otherwise";
+        };
+        readonly isDisabled: {
+            readonly type: "boolean";
+            readonly description: "true if the vehicle is out of service, false otherwise";
+        };
+        readonly rentalUriAndroid: {
+            readonly type: "string";
+            readonly description: "Rental URI for Android (deep link to the specific vehicle)";
+        };
+        readonly rentalUriIOS: {
+            readonly type: "string";
+            readonly description: "Rental URI for iOS (deep link to the specific vehicle)";
+        };
+        readonly rentalUriWeb: {
+            readonly type: "string";
+            readonly description: "Rental URI for web (deep link to the specific vehicle)";
+        };
+    };
+};
+declare const RentalZoneSchema: {
+    readonly type: "object";
+    readonly required: readonly ["providerId", "providerGroupId", "z", "bbox", "area", "rules"];
+    readonly properties: {
+        readonly providerId: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental provider";
+        };
+        readonly providerGroupId: {
+            readonly type: "string";
+            readonly description: "Unique identifier of the rental provider group";
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly description: "Public name of the geofencing zone";
+        };
+        readonly z: {
+            readonly type: "integer";
+            readonly description: "Zone precedence / z-index (higher number = higher precedence)";
+        };
+        readonly bbox: {
+            readonly type: "array";
+            readonly description: "Bounding box of the area covered by this zone,\n[west, south, east, north] as [lon, lat, lon, lat]\n";
+            readonly minItems: 4;
+            readonly maxItems: 4;
+            readonly items: {
+                readonly type: "number";
+            };
+        };
+        readonly area: {
+            readonly $ref: "#/components/schemas/MultiPolygon";
+        };
+        readonly rules: {
+            readonly type: "array";
+            readonly items: {
+                readonly $ref: "#/components/schemas/RentalZoneRestrictions";
+            };
+        };
+    };
+};
 declare const LegSchema: {
     readonly type: "object";
     readonly required: readonly ["mode", "startTime", "endTime", "scheduledStartTime", "scheduledEndTime", "realTime", "scheduled", "duration", "from", "to", "legGeometry"];
@@ -765,6 +1172,12 @@ declare const LegSchema: {
             readonly description: "final stop of this trip (can differ from headsign)";
             readonly $ref: "#/components/schemas/Place";
         };
+        readonly routeId: {
+            readonly type: "string";
+        };
+        readonly directionId: {
+            readonly type: "string";
+        };
         readonly routeColor: {
             readonly type: "string";
         };
@@ -1018,6 +1431,45 @@ declare const TransferSchema: {
         };
     };
 };
+declare const OneToManyParamsSchema: {
+    readonly type: "object";
+    readonly required: readonly ["one", "many", "mode", "max", "maxMatchingDistance", "elevationCosts", "arriveBy"];
+    readonly properties: {
+        readonly one: {
+            readonly description: "geo location as latitude;longitude";
+            readonly type: "string";
+        };
+        readonly many: {
+            readonly description: "geo locations as latitude;longitude,latitude;longitude,...";
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly explode: false;
+        };
+        readonly mode: {
+            readonly description: "routing profile to use (currently supported: `WALK`, `BIKE`, `CAR`)\n";
+            readonly $ref: "#/components/schemas/Mode";
+        };
+        readonly max: {
+            readonly description: "maximum travel time in seconds";
+            readonly type: "number";
+        };
+        readonly maxMatchingDistance: {
+            readonly description: "maximum matching distance in meters to match geo coordinates to the street network";
+            readonly type: "number";
+        };
+        readonly elevationCosts: {
+            readonly description: "Optional. Default is `NONE`.\n\nSet an elevation cost profile, to penalize routes with incline.\n- `NONE`: No additional costs for elevations. This is the default behavior\n- `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.\n- `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.\n\nAs using an elevation costs profile will increase the travel duration,\nrouting through steep terrain may exceed the maximal allowed duration,\ncausing a location to appear unreachable.\nIncreasing the maximum travel time for these segments may resolve this issue.\n\nElevation cost profiles are currently used by following street modes:\n- `BIKE`\n";
+            readonly $ref: "#/components/schemas/ElevationCosts";
+            readonly default: "NONE";
+        };
+        readonly arriveBy: {
+            readonly description: "true = many to one\nfalse = one to many\n";
+            readonly type: "boolean";
+        };
+    };
+};
 declare const ErrorSchema: {
     readonly type: "object";
     readonly properties: {
@@ -1027,4 +1479,4 @@ declare const ErrorSchema: {
     };
 };
 
-export { AlertCauseSchema, AlertEffectSchema, AlertSchema, AlertSeverityLevelSchema, AreaSchema, CyclingSpeedSchema, DirectionSchema, DurationSchema, ElevationCostsSchema, EncodedPolylineSchema, ErrorSchema, FareMediaSchema, FareMediaTypeSchema, FareProductSchema, FareTransferRuleSchema, FareTransferSchema, ItinerarySchema, LegSchema, LocationTypeSchema, MatchSchema, ModeSchema, PedestrianProfileSchema, PedestrianSpeedSchema, PickupDropoffTypeSchema, PlaceSchema, ReachablePlaceSchema, ReachableSchema, RentalFormFactorSchema, RentalPropulsionTypeSchema, RentalReturnConstraintSchema, RentalSchema, RiderCategorySchema, StepInstructionSchema, StopTimeSchema, TimeRangeSchema, TokenSchema, TransferSchema, TripInfoSchema, TripSegmentSchema, VertexTypeSchema };
+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 };

package/dist/schemas.gen.js

@@ -20,6 +20,8 @@ import {
   LocationTypeSchema,
   MatchSchema,
   ModeSchema,
+  MultiPolygonSchema,
+  OneToManyParamsSchema,
   PedestrianProfileSchema,
   PedestrianSpeedSchema,
   PickupDropoffTypeSchema,
@@ -28,8 +30,15 @@ import {
   ReachableSchema,
   RentalFormFactorSchema,
   RentalPropulsionTypeSchema,
+  RentalProviderGroupSchema,
+  RentalProviderSchema,
   RentalReturnConstraintSchema,
   RentalSchema,
+  RentalStationSchema,
+  RentalVehicleSchema,
+  RentalVehicleTypeSchema,
+  RentalZoneRestrictionsSchema,
+  RentalZoneSchema,
   RiderCategorySchema,
   StepInstructionSchema,
   StopTimeSchema,
@@ -39,7 +48,7 @@ import {
   TripInfoSchema,
   TripSegmentSchema,
   VertexTypeSchema
-} from "./chunk-5QEG6DOF.js";
+} from "./chunk-47ZS6OWZ.js";
 export {
   AlertCauseSchema,
   AlertEffectSchema,
@@ -62,6 +71,8 @@ export {
   LocationTypeSchema,
   MatchSchema,
   ModeSchema,
+  MultiPolygonSchema,
+  OneToManyParamsSchema,
   PedestrianProfileSchema,
   PedestrianSpeedSchema,
   PickupDropoffTypeSchema,
@@ -70,8 +81,15 @@ export {
   ReachableSchema,
   RentalFormFactorSchema,
   RentalPropulsionTypeSchema,
+  RentalProviderGroupSchema,
+  RentalProviderSchema,
   RentalReturnConstraintSchema,
   RentalSchema,
+  RentalStationSchema,
+  RentalVehicleSchema,
+  RentalVehicleTypeSchema,
+  RentalZoneRestrictionsSchema,
+  RentalZoneSchema,
   RiderCategorySchema,
   StepInstructionSchema,
   StopTimeSchema,

package/dist/services.gen.d.ts

@@ -1,4 +1,4 @@
-import { PlanData, PlanResponse, Error, OneToManyData, OneToManyResponse, OneToAllData, Reachable, ReverseGeocodeData, ReverseGeocodeResponse, GeocodeData, GeocodeResponse, TripData, Itinerary, StoptimesData, StoptimesResponse, TripsData, TripsResponse, InitialResponse, StopsData, StopsResponse, LevelsData, LevelsResponse, TransfersData, TransfersResponse } from './types.gen.js';
+import { PlanData, PlanResponse, Error, OneToManyData, OneToManyResponse, OneToAllData, Reachable, ReverseGeocodeData, ReverseGeocodeResponse, GeocodeData, GeocodeResponse, TripData, Itinerary, StoptimesData, StoptimesResponse, TripsData, TripsResponse, InitialResponse, StopsData, StopsResponse, LevelsData, LevelsResponse, RentalsData, RentalsResponse, TransfersData, TransfersResponse } from './types.gen.js';
 import * as _hey_api_client_fetch from '@hey-api/client-fetch';
 import { Options } from '@hey-api/client-fetch';
 
@@ -57,9 +57,29 @@ declare const stops: <ThrowOnError extends boolean = false>(options: Options<Sto
  * Get all available levels for a map section
  */
 declare const levels: <ThrowOnError extends boolean = false>(options: Options<LevelsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<LevelsResponse, Error, ThrowOnError>;
+/**
+ * Get a list of rental providers or all rental stations and vehicles for
+ * a map section or provider
+ *
+ * If neither the map section (`min` and `max`) nor a provider filter
+ * (either `providerGroups` or `providers`) is provided, returns a list of
+ * all available rental providers, but no station, vehicle or zone data.
+ * Provide the `withProviders=false` parameter to retrieve only provider
+ * groups if detailed feed information is not required.
+ *
+ * Either the map section (`min` and `max`) or the provider filter
+ * (either `providerGroups` or `providers`)
+ * must be provided to retrieve station, vehicle and zone data.
+ *
+ * If only the map section is provided, all data in the area is returned.
+ * If only the provider filter is provided, all data for the given providers is returned.
+ * If both parameters are provided, only data for the given providers in the map section is returned.
+ *
+ */
+declare const rentals: <ThrowOnError extends boolean = false>(options?: Options<RentalsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RentalsResponse, Error, ThrowOnError>;
 /**
  * Prints all transfers of a timetable location (track, bus stop, etc.)
  */
 declare const transfers: <ThrowOnError extends boolean = false>(options: Options<TransfersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TransfersResponse, unknown, ThrowOnError>;
 
-export { client, geocode, initial, levels, oneToAll, oneToMany, plan, reverseGeocode, stops, stoptimes, transfers, trip, trips };
+export { client, geocode, initial, levels, oneToAll, oneToMany, plan, rentals, reverseGeocode, stops, stoptimes, transfers, trip, trips };