@motis-project/motis-client 2.7.6 → 2.8.0

package/dist/{chunk-CIMYPNMP.js → chunk-2KJNFZVR.js}

@@ -42,6 +42,10 @@ var AlertSchema = {
   type: "object",
   required: ["headerText", "descriptionText"],
   properties: {
+    code: {
+      type: "string",
+      description: "Attribute or notice code (e.g. for HRDF or NeTEx)"
+    },
     communicationPeriod: {
       description: `Time when the alert should be shown to the user.
 If missing, the alert will be shown as long as it appears in the feed.
@@ -215,11 +219,12 @@ var ModeSchema = {
   - \`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.
+  - \`ODM\`: demand responsive transport
   - \`AREAL_LIFT\`: deprecated
   - \`METRO\`: deprecated
+  - \`CABLE_CAR\`: deprecated
 `,
   type: "string",
   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"]

package/dist/index.js

@@ -49,7 +49,7 @@ import {
   TripInfoSchema,
   TripSegmentSchema,
   VertexTypeSchema
-} from "./chunk-CIMYPNMP.js";
+} from "./chunk-2KJNFZVR.js";
 import {
   client,
   geocode,

package/dist/schemas.gen.d.ts

@@ -35,6 +35,10 @@ declare const AlertSchema: {
     readonly type: "object";
     readonly required: readonly ["headerText", "descriptionText"];
     readonly properties: {
+        readonly code: {
+            readonly type: "string";
+            readonly description: "Attribute or notice code (e.g. for HRDF or NeTEx)";
+        };
         readonly communicationPeriod: {
             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";
             readonly type: "array";
@@ -153,7 +157,7 @@ declare const LocationTypeSchema: {
     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 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";
     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"];
 };

package/dist/schemas.gen.js

@@ -49,7 +49,7 @@ import {
   TripInfoSchema,
   TripSegmentSchema,
   VertexTypeSchema
-} from "./chunk-CIMYPNMP.js";
+} from "./chunk-2KJNFZVR.js";
 export {
   AlertCauseSchema,
   AlertEffectSchema,

package/dist/services.gen.d.ts

@@ -61,19 +61,23 @@ declare const levels: <ThrowOnError extends boolean = false>(options: Options<Le
  * 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.
+ * Various options to filter the providers, stations and vehicles are
+ * available. If none of these filters are provided, a list of all
+ * available rental providers is returned without any station, vehicle or
+ * zone data.
+ *
+ * At least one of the following filters must be provided to retrieve
+ * station, vehicle and zone data:
  *
- * 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.
+ * - A bounding box defined by the `min` and `max` parameters
+ * - A circle defined by the `point` and `radius` parameters
+ * - A list of provider groups via the `providerGroups` parameter
+ * - A list of providers via the `providers` parameter
  *
- * 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.
+ * Only data that matches all the provided filters is returned.
+ *
+ * Provide the `withProviders=false` parameter to retrieve only provider
+ * groups if detailed feed information is not required.
  *
  */
 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

@@ -33,6 +33,10 @@ type TimeRange = {
  * An alert, indicating some sort of incident in the public transit network.
  */
 type Alert = {
+    /**
+     * Attribute or notice code (e.g. for HRDF or NeTEx)
+     */
+    code?: string;
     /**
      * Time when the alert should be shown to the user.
      * If missing, the alert will be shown as long as it appears in the feed.
@@ -189,11 +193,12 @@ type LocationType = 'ADDRESS' | 'PLACE' | 'STOP';
  * - `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.
+ * - `ODM`: demand responsive transport
  * - `AREAL_LIFT`: deprecated
  * - `METRO`: deprecated
+ * - `CABLE_CAR`: 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';
@@ -2381,6 +2386,12 @@ type TripsData = {
          * end if the time window
          */
         endTime: string;
+        /**
+         * 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)>;
         /**
          * latitude,longitude pair of the upper left coordinate
          */
@@ -2419,6 +2430,12 @@ type InitialResponse = ({
 type InitialError = (Error);
 type StopsData = {
     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)>;
         /**
          * latitude,longitude pair of the upper left coordinate
          */
@@ -2455,6 +2472,17 @@ type RentalsData = {
          * latitude,longitude pair of the lower right coordinate
          */
         min?: string;
+        /**
+         * \`latitude,longitude[,level]\` tuple with
+         * - latitude and longitude in degrees
+         * - (optional) level: the OSM level (ignored, for compatibility reasons)
+         *
+         * OR
+         *
+         * stop id
+         *
+         */
+        point?: string;
         /**
          * A list of rental provider groups to return.
          * If both `providerGroups` and `providers` are empty/not specified,
@@ -2469,6 +2497,11 @@ type RentalsData = {
          *
          */
         providers?: Array<(string)>;
+        /**
+         * Radius around `point` in meters.
+         *
+         */
+        radius?: number;
         /**
          * Optional. Include providers in output. If false, only provider
          * groups are returned.

package/package.json

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