mobility-toolbox-js 3.0.0-beta.19 → 3.0.0-beta.20

package/types/stops.d.ts

@@ -9,35 +9,35 @@ export interface Paths {
     get: {
       parameters: {
         query: {
-          /** Control how many matches will be returned */
-          limit?: number;
-          /** Anything you'd like to search for */
-          q: string;
           /**
-           * comma seperated list, order chooses which agency will be preferred
-           * as ident_source (for id and code fields)
+           * left,bottom,right,up coordinates in WGS84 wherein the
+           * station should lie
            */
-          prefagencies?: 'sbb' | 'db';
+          bbox?: string;
+          /** which field to look up, default: all of them */
+          field?: 'coords' | 'id' | 'name';
+          /** Control how many matches will be returned */
+          limit?: number;
           /**
            * comma seperated list of mot's which should be available
            * at the stop
            */
           mots?:
             | 'bus'
+            | 'cable_car'
             | 'ferry'
+            | 'funicular'
             | 'gondola'
-            | 'tram'
             | 'rail'
-            | 'funicular'
-            | 'cable_car'
-            | 'subway';
+            | 'subway'
+            | 'tram';
           /**
-           * left,bottom,right,up coordinates in WGS84 wherein the
-           * station should lie
+           * comma seperated list, order chooses which agency will be preferred
+           * as ident_source (for id and code fields)
            */
-          bbox?: string;
-          /** which field to look up, default: all of them */
-          field?: 'id' | 'name' | 'coords';
+          prefagencies?: 'db' | 'sbb';
+          /** Anything you'd like to search for */
+          q: string;
           /**
            * Coordinates in WGS84 (in lat,lon order) used to rank stops close to
            * this position higher
@@ -49,81 +49,81 @@ export interface Paths {
         /** stop(s) */
         200: {
           schema: {
-            /** @enum {string} */
-            type?: 'FeatureCollection';
             features?: {
-              /** @enum {string} */
-              type?: 'Feature';
+              /** @description the coordinates of the stop */
+              geometry?: {
+                /**
+                 * @example [
+                 *   7.439119,
+                 *   46.94882
+                 * ]
+                 */
+                coordinates?: number[];
+                /** @enum {string} */
+                type?: 'Point';
+              };
               properties?: {
-                /** @description internal ID */
-                uid?: string;
                 /**
-                 * @description name of the stop
-                 * @example Bern
+                 * @description Abbreviation code from the transport agency (e.g. DS100 for Deutsche Bahn)
+                 *
+                 * @example BN
                  */
-                name?: string;
+                code?: string;
                 /**
                  * @description 2 letter country code where the station is located
                  * @example CH
                  */
                 country_code?: string;
                 /**
-                 * @description how well the result matches your query, 0
-                 * means best
+                 * @description uic number
+                 * @example 8507000
                  */
-                rank?: number;
+                id?: string;
                 /**
-                 * @description array of translations of the stopname
-                 * @default []
+                 * @description source agency for id and code (see below)
+                 * @example sbb
                  */
-                translated_names?: {
-                  value?: string;
-                  /** @enum {string} */
-                  language?: 'de' | 'en' | 'fr' | 'it';
-                }[];
+                ident_source?: string;
+                /** @description ifopt identifier, if available */
+                ifopt?: string;
                 /** @description Means of transport that are available at this station */
                 mot?: {
                   bus?: boolean;
+                  cable_car?: boolean;
                   ferry?: boolean;
+                  funicular?: boolean;
                   gondola?: boolean;
-                  tram?: boolean;
                   rail?: boolean;
-                  funicular?: boolean;
-                  cable_car?: boolean;
                   subway?: boolean;
+                  tram?: boolean;
                 };
                 /**
-                 * @description source agency for id and code (see below)
-                 * @example sbb
-                 */
-                ident_source?: string;
-                /**
-                 * @description uic number
-                 * @example 8507000
+                 * @description name of the stop
+                 * @example Bern
                  */
-                id?: string;
+                name?: string;
                 /**
-                 * @description Abbreviation code from the transport agency (e.g. DS100 for Deutsche Bahn)
-                 *
-                 * @example BN
+                 * @description how well the result matches your query, 0
+                 * means best
                  */
-                code?: string;
-                /** @description ifopt identifier, if available */
-                ifopt?: string;
-              };
-              /** @description the coordinates of the stop */
-              geometry?: {
-                /** @enum {string} */
-                type?: 'Point';
+                rank?: number;
                 /**
-                 * @example [
-                 *   7.439119,
-                 *   46.94882
-                 * ]
+                 * @description array of translations of the stopname
+                 * @default []
                  */
-                coordinates?: number[];
+                translated_names?: {
+                  /** @enum {string} */
+                  language?: 'de' | 'en' | 'fr' | 'it';
+                  value?: string;
+                }[];
+                /** @description internal ID */
+                uid?: string;
               };
+              /** @enum {string} */
+              type?: 'Feature';
             }[];
+            /** @enum {string} */
+            type?: 'FeatureCollection';
           };
         };
         /** limit parameter too high */